HELPLIB.HLB  —  LBR Routines, LBR$SET_LOCATE
    The LBR$SET_LOCATE routine sets the record access of LBR
    subroutines to locate mode.

    Format

      LBR$SET_LOCATE  library_index

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  –  Argument

 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 the longword that
    contains the index.

3  –  Description

    Librarian record access may be set to move mode (the default
    set by LBR$SET_MOVE) or locate mode. The setting affects the
    operation of the LBR$GET_RECORD routine.

    If move mode is set (the default), LBR$GET_RECORD copies the
    requested record to the specified user buffer. If locate mode is
    set, the record is not copied. Instead, the outbufdes descriptor
    is set to reference the internal LBR subroutine buffer that
    contains the record.

4  –  Condition Values Returned

    LBR$_ILLCTL        Specified library control index not valid.
    LBR$_LIBNOTOPN     Specified library not open.
Close Help