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

    The Get Job/Process Information routine provides a simplified
    interface to the $GETJPI system service. It provides accounting,
    status, and identification information about a specified process.

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

    Format

      LIB$GETJPI  item-code [,process-id] [,process-name]

                  [,resultant-value] [,resultant-string]

                  [,resultant-length]

1 - Returns

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

2 - Arguments

 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$GETJPI.

    LIB$GETJPI accepts all $GETJPI item codes. These names begin
    with JPI$_ and are defined in symbol libraries in module $JPIDEF
    supplied by Compaq.

 process-id

    OpenVMS usage:process_id
    type:         longword (unsigned)
    access:       modify
    mechanism:    by reference

    Process identifier of the process for which you are requesting
    information. The process-id argument is the address of an
    unsigned longword containing the process identifier. If you do
    not specify process-id, process-name is used.

    The process-id is updated to contain the process identifier
    actually used, which may be different from what you originally
    requested if you specified process-name or used wildcard process
    searching.

 process-name

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

    A 1- to 15-character string specifying the name of the process
    for which you are requesting information. The process-name
    argument is the address of a descriptor pointing to the process
    name string. The name must correspond exactly to the name of the
    process for which you are requesting information; LIB$GETJPI does
    not allow trailing blanks or abbreviations.

    If you do not specify process-name, process-id is used. If you
    specify neither process-name nor process-id, the caller's process
    is used. Also, if you do not specify process-name and you specify
    zero for process-id, the caller's process is used. In this way,
    you can fetch the item you want and the caller's PID in a single
    call to LIB$GETJPI.

 resultant-value

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

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

 resultant-string

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

    String representation of the information you request. The
    resultant-string argument is the address of the descriptor
    for a character string into which LIB$GETJPI 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_unsigned
    type:         word (unsigned)
    access:       write only
    mechanism:    by reference

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