Library /sys$common/syshlp/helplib.hlb  —  RTL Routines, LIB$  LIB$FORMAT_SOGW_PROT
    The Format Protection Mask routine translates a protection mask
    into a formatted string.

    Format

      LIB$FORMAT_SOGW_PROT  protection-mask, [access-names],

                            [ownership-names], [ownership-separator],

                            [list-separator], protection-string,

                            [protection-length]

1  –  Returns

    OpenVMS usage:cond_value
    type:         longword (unsigned)
    access:       write only
    mechanism:    by value

2  –  Arguments

 protection-mask

    OpenVMS usage:protection
    type:         word (unsigned)
    access:       read only
    mechanism:    by reference

    The address of a word that holds a 16-bit protection mask to be
    translated.

 access-names

    OpenVMS usage:access_names
    type:         array [0..31] of quadword string descriptor
    access:       read only
    mechanism:    by reference

    The address of the access name table for the associated object
    class. For example, it is the value returned in accnam by
    LIB$GET_ACCNAM. This parameter defaults to the access name table
    for the FILE object class.

 ownership-names

    OpenVMS usage:char_string
    type:         array [0..3] of quadword string descriptor
    access:       read only
    mechanism:    by reference

    The address of a vector of 4 quadword descriptors that points
    to the ownership name. The default value is the full ownership
    category names (System, Owner, Group, World).

 ownership-separator

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       read only
    mechanism:    by descriptor

    The address of a descriptor that points to the ownership
    separator string. The separator string is inserted after the
    ownership name to introduce a nonempty set of access names. By
    default, the value is ": " (the colon and space characters).

 list-separator

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       read only
    mechanism:    by descriptor

    The address of a descriptor that points to the list separator
    string. The list separator string is inserted between ownership-
    access type pairs. By default, the value is ", " (the comma and
    space characters).

 protection-string

    OpenVMS usage:char_string
    type:         character-coded text string
    access:        write only
    mechanism:    by descriptor

    The address of a character-string descriptor that receives the
    output of the routine call. The protection-string argument points
    to the formatted protection string at the end of a call. The
    protection string has the following components repeated for each
    of: System, Owner, Group, World:

    ownership-name[ownership-separator][access-types][list-separator]

    An example of a formatted protection string is

    System: RWED, Owner: RWED, Group: RW, World: R

 protection-length

    OpenVMS usage:word_signed
    type:         word (signed)
    access:       write only
    mechanism:    by reference

    The address of a word that receives the length of the string
    returned in the protection-string argument.
Close Help