HELPLIB.HLB  —  NCS Routines, NCS$RESTORE_CF
    The NCS$RESTORE_CF routine permits the calling program to restore
    the definition of a saved conversion function from a database or
    a file.

    Format

      NCS$RESTORE_CF  cf_id [,length] [,address]

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. The condition value that this routine
    can return is listed under Condition Value Returned.

2  –  Arguments

 cf_id

    OpenVMS usage:identifier
    type:         longword integer (unsigned)
    access:       write only
    mechanism:    by reference
    Address of a longword that NCS uses to identify a conversion
    function.

    The cf_id argument is required.

 length

    OpenVMS usage:longword_unsigned
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference
    Longword that the calling program uses to indicate the length of
    the conversion function being restored.

 address

    OpenVMS usage:longword_unsigned
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference
    Longword that the calling program uses as a pointer to the
    conversion function being restored.

3  –  Description

    The NCS$RESTORE_CF routine, used in conjunction with the
    NCS$SAVE_CF routine, permits the application program to keep a
    local copy of the conversion function. The NCS$SAVE_CF routine
    obtains the length and location of the conversion function and
    returns it to the application program. The application program
    subsequently provides this information to the NCS$RESTORE_CF
    routine, which uses it to access the conversion function.

    This routine also does some integrity checking on the conversion
    function as it is being processed.

4  –  Condition Value Returned

    NCS$_NOT_CF        Name of identifier does not refer to a
                       conversion function.

5  –  Condition Values Signaled

    LBR messages (prefaced by an NCS message) might signal errors
    detected while the process is accessing the NCS library.
Close Help