VMS Help  —  RTL Routines, LIB$  LIB$GETSYI
    The Get Systemwide Information routine provides a simplified
    interface to the $GETSYI system service. The $GETSYI system
    service obtains status and identification information about the
    system. LIB$GETSYI returns only one item of information in a
    single call.

    Format

      LIB$GETSYI  item-code [,resultant-value] [,resultant-string]

                  [,resultant-length] [,cluster-system-id]

                  [,node-name]

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 code specifying the desired item of information. The item-
    code argument is the address of a signed longword containing this
    item code. All valid $GETSYI item codes are accepted.

 resultant-value

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

    Numeric value returned by LIB$GETSYI. The resultant-value
    argument is the address of a longword or quadword containing this
    value. If an item is listed as returning only a string value,
    this argument is ignored.

 resultant-string

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

    Information returned by LIB$GETSYI. The resultant-string argument
    is the address of a descriptor pointing to the character string
    that will receive this information. If resultant-string is
    not specified and if the returned value 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, not
    including blank padding or truncated characters. The resultant-
    length argument is the address of an unsigned word into which
    LIB$GETSYI returns this number.

 cluster-system-id

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

    Cluster system identification (CSID) of the node for which
    information is to be returned. The cluster-system-id argument
    is the address of this CSID. If cluster-system-id is specified
    and is nonzero, node-name is not used. If cluster-system-id is
    specified as zero, LIB$GETSYI uses node-name and writes into the
    cluster-system-id argument the CSID corresponding to the node
    identified by node-name.

    The cluster-system-id of an OpenVMS node is assigned by the
    cluster-connection software and may be obtained by the DCL
    command SHOW CLUSTER. The value of the cluster-system-id for
    an OpenVMS node is not permanent; a new value is assigned to an
    OpenVMS node whenever it joins or rejoins the OpenVMS Cluster.

    If cluster-system-id is specified as -1, LIB$GETSYI assumes a
    wildcard operation and returns the requested information for each
    OpenVMS node in the cluster, one node per call.

    If cluster-system-id is not specified, node-name is used.

 node-name

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

    Name of the node for which information is to be returned. The
    node-name argument is the address of a descriptor pointing to
    the node name string. If cluster-system-id is not specified or
    is specified as zero, node-name is used. If neither node-name nor
    cluster-system-id is specified, the caller's node is used. See
    the cluster-system-id argument for more information.

    The node name string must contain from 1 to 15 characters and
    must correspond exactly to the OpenVMS node name; no trailing
    blanks nor abbreviations are permitted.
Close Help