The Trim a Full Name to Fit into a Desired Output Field routine trims a full name to fit into a desired output field. The trimming preserves the most significant part of the full name. Format LIB$TRIM_FULLNAME fullname, trimmed-nodename [,output-width] [,resultant-length]
1 – Returns
OpenVMS usage:cond_value type: longword (unsigned) access: write only mechanism: by value
2 – Arguments
fullname OpenVMS usage:char_string type: character string access: read only mechanism: by descriptor Full name to be trimmed. The fullname argument contains the address of a descriptor pointing to this full name string. The error LIB$_INVARG is returned if fullname contains an invalid full name, points to a null string, or contains more than 1024 characters. The error LIB$_INVSTRDES is returned if fullname is an invalid descriptor. trimmed-nodename OpenVMS usage:char_string type: character string access: write only mechanism: by descriptor Trimmed node name. The trimmed-nodename argument contains the address of a descriptor pointing to the trimmed node-name string. LIB$TRIM_FULLNAME writes the trimmed node name into the buffer pointed to by trimmed-nodename. The error LIB$_INVSTRDES is returned if trimmed-nodename is an invalid descriptor. The length field of the trimmed-nodename descriptor is not updated unless trimmed-nodename is a dynamic descriptor with a length less than the resultant trimmed node name. Refer to the OpenVMS RTL String Manipulation (STR$) Manual for dynamic string descriptor usage. The trimmed-nodename argument contains an unusable result when LIB$TRIM_FULLNAME returns in error. output-width OpenVMS usage:word_unsigned type: word (unsigned) access: read only mechanism: by reference Field width desired for the trimmed node name. 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 trimmed- nodename is used. If trimmed-nodename is not a fixed-length string, specify output-width to ensure that the desired width is used. If the lengths of both trimmed-nodename and output-width are specified, the length in output-width is used. In this case, if the current length of trimmed-nodename is smaller than the length of output-width, the output trimmed 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 trimmed 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$TRIM_FULLNAME returns in error.