VMS Help NCS Routines, NCS$GET_CS  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    The NCS$GET_CS routine retrieves the definition of the named
    collating sequence from the NCS library.

    Format

      NCS$GET_CS  cs_id [,csname] [,librar]

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 - Arguments

 cs_id

    OpenVMS usage:identifier
    type:         longword integer (unsigned)
    access:       modify
    mechanism:    by reference
    Address of a longword that NCS uses to store a nonzero value
    identifying a collating sequence. The calling program must ensure
    that the longword identifier contains 0 before invoking the
    NCS$GET_CS routine.

    All subsequent calls to the NCS$COMPARE routine and the call to
    the NCS$END_CS routine that terminates the use of the collating
    sequence must pass this longword identifier. Upon completion
    of the comparisons, the NCS$END_CS routine releases the memory
    used to store the collating sequence and sets the value of the
    longword identifier to 0.

    The collating sequence identifier enhances modular programming
    and permits concurrent use of multiple collating sequences within
    a program.

    The calling program should not attempt to interpret the contents
    of the longword identifier.

    The cs_id argument is required.

 csname

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by descriptor
    Name of the collating sequence being retrieved.

 librar

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by descriptor
    File specification of the library where the collating sequence is
    stored.

3 - Description

    The NCS$GET_CS routine extracts the named collating sequence
    from the specified NCS library. If the calling program omits the
    csname argument, NCS creates a collating sequence that uses the
    "native" collating sequence as a basis for the comparisons. This
    collating sequence is padded with NUL characters (hex 0).

    If the calling program omits the librar argument, NCS accesses
    the default NCS library.

4 - Condition Values Returned

    NCS$_DIAG          Operation completed with signaled diagnostics.
    NCS$_NOT_CS        Name of identifier does not refer to a
                       collating sequence.
    NCS$_NOT_FOUND     Name of identifier not found in the NCS
                       library.

5 - Condition Values Signaled

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