HELPLIB.HLB  —  RTL Routines, LIB$  LIB$LOOKUP_KEY
    The Look Up Keyword in Table routine scans a table of keywords
    to find one that matches the keyword or keyword abbreviation
    specified by search-string.

    Format

      LIB$LOOKUP_KEY  search-string ,key-table-array [,key-value]

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

1  –  Returns

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

2  –  Arguments

 search-string

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

    String for which LIB$LOOKUP_KEY will search in the keyword
    table. The search-string argument is the address of a descriptor
    pointing to this string.

 key-table-array

    OpenVMS usage:unspecified
    type:         unspecified
    access:       read only
    mechanism:    by reference, array reference

    Keyword table. The key-table-array argument contains the address
    of an array that is this keyword table.

 key-value

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

    Associated value of the keyword found by LIB$LOOKUP_KEY. The key-
    value argument contains the address of an unsigned longword into
    which LIB$LOOKUP_KEY writes the associated value of the matched
    keyword.

 keyword-string

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

    Full keyword string matched. The keyword-string argument contains
    the address of a character-string descriptor. LIB$LOOKUP_
    KEY writes the complete text of the matched keyword into the
    character string.

 resultant-length

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

    Number of characters copied into the character-string pointed to
    by keyword-string, not counting padding in the case of a fixed-
    length string. The resultant-length argument is the address of an
    unsigned word integer that contains the number of characters in
    the matched keyword that were copied into the character-string.
Close Help