HELPLIB.HLB  —  RTL Routines, LIB$  LIB$FIT_NODENAME
    The Fit a Node Name Into an Output Field routine fits a node name
    into an output field. It attempts to compress the node name to
    fit the output field. If this fails, it trims the node name.

    Format

      LIB$FIT_NODENAME  nodename, output-buffer

                        [,output-width][,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 fitted into the desired output field. 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 nodename is
    an invalid descriptor.

 output-buffer

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

    The output buffer. The output-buffer argument contains the
    address of a descriptor pointing to the output buffer. LIB$FIT_
    NODENAME writes the final output node name into the buffer
    pointed to by output-buffer.

    The error LIB$_INVSTRDES is returned if output-buffer is an
    invalid descriptor.

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

    The output-buffer argument contains an unusable result when
    LIB$FIT_NODENAME returns in error.

 output-width

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

    Field width desired for the fit operation. The output-width
    argument is the address of an unsigned word that contains this
    field width in bytes.

    If output-width is omitted, the current length of output-buffer
    is used. If output-buffer is not a fixed-length string, specify
    output-width to ensure that the desired width is used.

    If the lengths of both output-buffer and output-width are
    specified, the length in output-width is used. In this case,
    if the current length of output-buffer is smaller than the length
    of output-width, the output node name is truncated at the end,
    and the alternate successful status LIB$_STRTRU is returned.

 resultant-length

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

    Length of the output 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$FIT_NODENAME returns in error.
Close Help