The NCS$SAVE_CS routine provides the calling program with information that permits the application program to store the definition of a collating sequence in a database or a file rather than in the NCS library. Format NCS$SAVE_CS cs_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
cs_id OpenVMS usage:identifier type: longword integer (unsigned) access: read only mechanism: by reference Address of a longword that NCS uses to identify a collating sequence. The cs_id argument is required. length OpenVMS usage:longword_unsigned type: longword (unsigned) access: write only mechanism: by reference Longword that NCS uses to indicate the length of the specified collating sequence to the calling program. address OpenVMS usage:longword_unsigned type: longword (unsigned) access: write only mechanism: by reference Longword that NCS uses to indicate the address of the specified collating sequence to the calling program.
3 – Description
The NCS$SAVE_CS routine, used in conjunction with the NCS$RESTORE_CS routine, permits the application program to store a collating sequence definition in a local file or in a database. When the calling program specifies the collating sequence identifier, NCS returns the location of the definition sequence and its length in bytes, permitting the calling program to store the definition locally, rather than in a library. Subsequently, the application supplies this information to the NCS$RESTORE_CS routine, which restores the collating sequence to a form that can be used by the NCS$COMPARE routine. This routine also does some integrity checking on the collating sequence as it is being processed.
4 – Condition Value Returned
NCS$_NOT_CS Name of identifier does not refer to a collating sequence.
5 – Condition Values Signaled
LBR messages (prefaced by an NCS message) might signal errors detected while the process is accessing the NCS library.