HELPLIB.HLB  —  RTL Routines, LIB$  LIB$SET_SYMBOL
    The Set Value of CLI Symbol routine requests the calling
    process's command language interpreter (CLI) to define or
    redefine a CLI symbol.

    Format

      LIB$SET_SYMBOL  symbol ,value-string [,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 to be defined or modified by LIB$SET_SYMBOL.
    The symbol argument is the address of a descriptor pointing to
    this symbol string. If you redefine a previously defined CLI
    symbol, the symbol value is modified to the new value that you
    provide.

    The symbol name is converted to uppercase and trailing blanks are
    removed before use. 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.

 value-string

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

    Value to be given to the symbol. The value-string argument is the
    address of a descriptor pointing to this value string.

    Trailing blanks are not removed from the value string before use.
    The maximum length of value-string is 1024 characters. Integer
    values are not allowed; LIB$SET_SYMBOL is intended to set string
    CLI symbols, not integer CLI symbols.

 table-type-indicator

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

    Indicator of the table that will contain the defined symbol. The
    table-type-indicator argument is the address of a signed longword
    integer that is this table indicator.

    If omitted, the local symbol table is used. The following are
    possible values for table-type-indicator:

    Symbolic Name        Value  Table Used

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