The NCS$RESTORE_CS routine permits the calling program to restore the definition of a "saved" collating sequence from a database or a file. Format NCS$RESTORE_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: write 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: read only mechanism: by reference Longword that the calling program uses to indicate the length of the collating sequence 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 collating sequence being restored.
3 – Description
The NCS$RESTORE_CS routine, used in conjunction with the NCS$SAVE_CS routine, permits the application program to keep a local copy of the collating sequence. The NCS$SAVE_CS routine obtains the length and location of the collating sequence and returns it to the application program. The application program subsequently provides this information to the NCS$RESTORE_CS routine, which uses it to access the collating sequence. 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.