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

    The Compress a Node Name to Its Short Form Equivalence routine
    compresses a node name to an unambiguous short form usable within
    the naming environment where the compression is performed.

    Format

      LIB$COMPRESS_NODENAME  nodename ,compressed-nodename

                             [,resultant-length]

1 - Returns

    OpenVMS usage:cond_value
    type:         longword (unsigned)
    access:       write only
    mechanism:    by value

2 - Arguments

 nodename

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by descriptor

    Node name to be compressed. The nodename argument contains the
    address of a descriptor pointing to this node-name string.

    The error LIB$_INVARG is returned if nodename contains an invalid
    node name, points to a null string, or contains more than 1024
    characters. The error LIB$_INVSTRDES is returned if the nodename
    descriptor is invalid.

 compressed-nodename

    OpenVMS usage:char_string
    type:         character string
    access:       write only
    mechanism:    by descriptor

    Compressed node name. The compressed-nodename argument contains
    the address of a descriptor pointing to the compressed node-name
    string. LIB$COMPRESS_NODENAME writes the compressed node name
    into the buffer pointed to by compressed-nodename.

    The error LIB$_INVSTRDES is returned if compressed-nodename is an
    invalid descriptor.

    The length field of the compressed-nodename descriptor is not
    updated unless compressed-nodename is a dynamic descriptor with a
    length less than the resulting compressed node name. Refer to the
    OpenVMS RTL String Manipulation (STR$) Manual for dynamic string
    descriptor usage.

    The compressed-nodename argument contains an unusable result when
    LIB$COMPRESS_NODENAME returns in error.

 resultant-length

    OpenVMS usage:word_unsigned
    type:         word (unsigned)
    access:       write only
    mechanism:    by reference

    Length of the compressed node name. The resultant-length argument
    is the address of an unsigned word that contains this length in
    bytes.

    The resultant-length argument contains an unusable result when
    LIB$COMPRESS_NODENAME returns in error.