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

    The LBR$DELETE_KEY routine deletes a key from a library index.

    Format

      LBR$DELETE_KEY  library_index ,key_name

1 - Returns

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

    Longword condition value. Most utility routines return a
    condition value in R0. Condition values that this routine can
    return are listed under Condition Values Returned.

2 - Arguments

 library_index

    OpenVMS usage:longword_unsigned
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference
    Library control index returned by the LBR$INI_CONTROL routine.
    The library_index argument is the address of a longword
    containing the index.

 key_name

    OpenVMS usage:longword_unsigned
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference
    Key to be deleted from the library index. For libraries with
    binary keys, the key_name argument is the address of an unsigned
    longword containing the key number.

    For libraries with ASCII keys, the key_name argument is the
    address of the string descriptor pointing to the key with the
    following argument characteristics:

    Argument
    Characteristics Entry

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

3 - Description

    If LBR$DELETE_KEY finds the key specified by key_name in the
    current index, it deletes the key. Note that, if you want to
    delete a library module, you should first use LBR$DELETE_KEY to
    delete any keys that point to it, then use LBR$DELETE_DATA to
    delete the module's header and associated data.

    You cannot call LBR$DELETE_KEY from within the user-supplied
    routine specified in LBR$SEARCH or LBR$GET_INDEX.

4 - Condition Values Returned

    LBR$_ILLCTL        Specified library control index not valid.
    LBR$_KEYNOTFND     Specified key not found.
    LBR$_LIBNOTOPN     Specified library not open.
    LBR$_UPDURTRAV     Specified index update not valid in a user-
                       supplied routine specified in LBR$SEARCH or
                       LBR$GET_INDEX.