HELPLIB.HLB  —  System Services, $FORMAT ACL
    Formats the specified access control entry (ACE) into a text
    string.

    Format

      SYS$FORMAT_ACL  aclent ,[acllen] ,aclstr ,[width] ,[trmdsc]

                      ,[indent] ,[accnam] ,[nullarg]

    C Prototype

      int sys$format_acl  (void *aclent, unsigned short int

                          *acllen, void *aclstr, unsigned short

                          int *width, void *trmdsc, unsigned short

                          int *indent, unsigned int *accnam, int

                          (*routin)(__unknown_params));

1  –  Arguments

 aclent

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       read only
    mechanism:    by descriptor-fixed-length string descriptor
    Description of the ACE formatted when $FORMAT_ACL completes
    execution. The aclent argument is the address of a descriptor
    pointing to a buffer containing the description of the input ACE.
    The first byte of the buffer contains the length of the ACE; the
    second byte contains a value that identifies the type of ACE,
    which in turn determines the ACE format.

    See the $FORMAT_ACL Description section in the VSI OpenVMS System
    Services Reference Manual for more information about the ACE
    format.

 acllen

    OpenVMS usage:word_unsigned
    type:         word (unsigned)
    access:       write only
    mechanism:    by reference
    Length of the output string resulting when $FORMAT_ACL completes
    execution. The acllen argument is the address of a word
    containing the number of characters written to aclstr.

 aclstr

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       write only
    mechanism:    by descriptor-fixed-length string descriptor
    Formatted ACE resulting when $FORMAT_ACL completes its execution.
    The aclstr argument is the address of a string descriptor
    pointing to a buffer containing the output string.

 width

    OpenVMS usage:word_unsigned
    type:         word (unsigned)
    access:       read only
    mechanism:    by reference
    Maximum width of the formatted ACE resulting when $FORMAT_ACL
    completes its execution. The width argument is the address of
    a word containing the maximum width of the formatted ACE. If
    this argument is omitted or contains the value 0, an infinite
    length display line is assumed. When the width is exceeded, the
    character specified by trmdsc is inserted.

 trmdsc

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       read only
    mechanism:    by descriptor-fixed-length string descriptor
    Line termination characters used in the formatted ACE. The trmdsc
    argument is the address of a descriptor pointing to a character
    string containing the termination characters that are inserted
    for each formatted ACE when the width has been exceeded.

 indent

    OpenVMS usage:word_unsigned
    type:         word (unsigned)
    access:       read only
    mechanism:    by reference
    Number of blank characters beginning each line of the formatted
    ACE. The indent argument is the address of a word containing
    the number of blank characters that you want inserted at the
    beginning of each formatted ACE.

 accnam

    OpenVMS usage:access_bit_names
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference
    Names of the bits in the access mask when executing the $FORMAT_
    ACL. The accnam argument is the address of an array of 32
    quadword descriptors that define the names of the bits in the
    access mask. Each element points to the name of a bit. The first
    element names bit 0, the second element names bit 1, and so on.

    You can call LIB$GET_ACCNAM to retrieve the access name table for
    the class of object whose ACL is to be formatted.

    If you omit accnam, the following names are used:

    Bit    Name

    Bit 0  READ
    Bit 1  WRITE
    Bit 2  EXECUTE
    Bit 3  DELETE
    Bit 4  CONTROL
    Bit 5  BIT_5
    Bit 6  BIT_6
    .
    .
    .
    Bit    BIT_31
    31

 nullarg

    OpenVMS usage:null_arg
    type:         longword (unsigned)
    access:       read only
    mechanism:    by value
    Placeholding argument Reserved to VSI.
Close Help