HELPLIB.HLB  —  NCS Routines, NCS$SAVE_CF
    The NCS$SAVE_CF routine provides the calling program with
    information that permits the application to store the definition
    of a conversion function in a local database or a file rather
    than in the NCS library.

    Format

      NCS$SAVE_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:       read 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:       write only
    mechanism:    by reference
    Longword used to store the length of the specified conversion
    function.

 address

    OpenVMS usage:longword_unsigned
    type:         longword (unsigned)
    access:       write only
    mechanism:    by reference
    Longword used to store the address of the specified conversion
    function.

3  –  Description

    The NCS$SAVE_CF routine, used in conjunction with the
    NCS$RESTORE_CF routine, permits the application program to
    store a conversion function definition in a local file or in
    a database. When the calling program specifies the conversion
    function identifier, NCS returns the location of the definition
    and its length in bytes, permitting the calling program to
    store the definition locally, rather than in an NCS library.
    Subsequently, the application supplies this information to the
    NCS$RESTORE_CF routine, which restores the conversion function to
    a form that can be used by the NCS$CONVERT routine.

    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