VMS Help
RTL Routines, LIB$, LIB$GET_SYMBOL

 *Conan The Librarian (sorry for the slow response - running on an old VAX)

    The Get Value of CLI Symbol routine requests the calling
    process's command language interpreter (CLI) to return the value
    of a CLI symbol as a string. LIB$GET_SYMBOL then returns the
    string to the caller. Optionally, LIB$GET_SYMBOL can return the
    length of the returned value and the table in which the symbol
    was found.

    Format

      LIB$GET_SYMBOL  symbol ,resultant-string [,resultant-length]

                      [,table-type-indicator]

  1 - Returns

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

  2 - Arguments

 symbol

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

    Name of the symbol for which LIB$GET_SYMBOL searches. The symbol
    argument is the address of a descriptor pointing to the name
    of the symbol. LIB$GET_SYMBOL converts the symbol name to
    uppercase and removes trailing blanks before the search. The
    symbol argument must begin with a letter, a digit, a dollar sign
    ($),  a hyphen (-), or an underscore (_).  The maximum length of
    symbol is 255 characters.

 resultant-string

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

    Value of the returned symbol. The resultant-string argument is
    the address of a descriptor pointing to a character string into
    which LIB$GET_SYMBOL writes the value of the symbol.

 resultant-length

    OpenVMS usage:word_unsigned
    type:         word (unsigned)
    access:       write only
    mechanism:    by reference

    Length of the symbol value returned by LIB$GET_SYMBOL. The
    resultant-length argument is the address of an unsigned word
    integer into which LIB$GET_SYMBOL writes the length.

 table-type-indicator

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

    Indicator of which table contained the symbol. The table-type-
    indicator argument is the address of a signed longword integer
    into which LIB$GET_SYMBOL writes the table indicator.

    Possible values of the table indicator are listed below.

    Symbolic Name       Value Table

    LIB$K_CLI_LOCAL_    1     Local symbol table
    SYM
    LIB$K_CLI_GLOBAL_   2     Global symbol table
    SYM

    LIB$K_CLI_LOCAL_SYM and LIB$K_CLI_GLOBAL_SYM are defined in
    symbol libraries supplied by Compaq (macro or module name
    $LIBCLIDEF) and as global symbols.
  Close     HLB-list     TLB-list     Help  

[legal] [privacy] [GNU] [policy] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.