VMS Help RTL Routines, LIB$, LIB$GETQUI  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    The Get Queue Information routine provides a simplified interface
    to the $GETQUI system service. It provides queue, job, file,
    characteristic, and form information about a specified process.

    LIB$GETQUI obtains only one item of information in a single call.

    Format

      LIB$GETQUI  function-code [,item-code] [,search-number]

                  [,search-name] [,search-flags] [,resultant-value]

                  [,resultant-string] [,resultant-length]

1 - Returns

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

2 - Arguments

 function-code

    OpenVMS usage:longword_signed
    type:         longword (signed)
    access:       read only
    mechanism:    by reference

    Function code specifying the function that LIB$GETQUI is to
    perform. The function-code argument is the address of a signed
    longword containing the function code.

    LIB$GETQUI accepts all $GETQUI function codes. These names begin
    with QUI$_ and are defined in symbol libraries in module $QUIDEF
    supplied by Compaq.

 item-code

    OpenVMS usage:longword_signed
    type:         longword (signed)
    access:       read only
    mechanism:    by reference

    Item identifier code specifying the item of information you are
    requesting. The item-code argument is the address of a signed
    longword containing the item code. You may request only one item
    in each call to LIB$GETQUI.

    LIB$GETQUI accepts all $GETQUI item codes. These names begin
    with QUI$_ and are defined in symbol libraries in module $QUIDEF
    supplied by Compaq.

 search-number

    OpenVMS usage:longword_signed
    type:         longword integer (signed)
    access:       read only
    mechanism:    by reference

    Numeric value used to process your request. The search-number
    argument is the address of a signed longword integer containing
    the number needed to process your request. The search-number
    argument corresponds directly to QUI$_SEARCH_NUMBER as described
    by the $GETQUI system service.

 search-name

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

    Character string used to process your request. The search-name
    argument is the address of a string descriptor that provides the
    name needed to process your request. The search-name argument
    corresponds directly to QUI$_SEARCH_NAME as described by the
    $GETQUI system service.

 search-flags

    OpenVMS usage:longword_unsigned
    type:         longword integer (unsigned)
    access:       read only
    mechanism:    by reference

    Optional bit mask indicating request to be performed. The search-
    flags argument is the address of an unsigned longword integer
    containing the bit mask. The search-flags argument directly
    corresponds to $QUI_SEARCH_FLAGS as described by the $GETQUI
    system service.

 resultant-value

    OpenVMS usage:varying_arg
    type:         unspecified
    access:       write only
    mechanism:    by reference

    Numeric value of the information you requested. The resultant-
    value argument is the address of a longword, quadword or
    octaword into which LIB$GETQUI writes the numeric value of this
    information.

    If the item you requested returns only a string value, this
    argument is ignored.

 resultant-string

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

    String representation of the information you requested. The
    resultant-string argument is the address of the descriptor
    for a character string into which LIB$GETQUI writes the string
    representation.

    If you do not include resultant-string, but the item you request
    has only a string representation, the error status LIB$_INVARG is
    returned.

 resultant-length

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

    Number of significant characters written to resultant-string by
    LIB$GETQUI. The resultant-length argument is the address of a
    signed word integer into which LIB$GETQUI writes the number of
    characters.