Functional Description
The purpose of this function is to trim a designated string up to and optionally including the first instance of a character.
The variable cChar indicates the character to search for to perform the trim function. If the character is not found within the
string, the string is returned without modification. The variable cIncludeChar indicates whether or not to trim the character
located within the string. A value of 'Y' will cause the function to delete the search character, any other value will cause the
function to keep the search character. The variable cDirection indicates whether to trim the string from the beginning (left)
or from the end (right). A value of 'L' will cause the function to trim from the left. Any other value will cause the function to
trim from the right.
Technical Specification
Parameters
Data Item Data Structure Description I/ORequiredNotes
DL01szString I/OYInput String
EV01cChar I YCharacter to search for when trimming string
EV01cIncludeChar IYIndicate whether to include cChar in trim.
EV01cDirection IYIndicate trim from left 'L' or right 'R'
Related Tables
Table Table Description
Processing
The szString is trimmed per the character values and returned
D0800002 - Trim to Char
Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
---|---|---|---|---|
szString | TXPP | char | NONE | NONE |
An all-purpose string that the system uses to temporarily display large amounts of text. | ||||
cChar | EV01 | char | NONE | NONE |
An option that specifies the type of processing for an event. | ||||
cIncludeChar | EV01 | char | NONE | NONE |
An option that specifies the type of processing for an event. | ||||
cDirection | EV01 | char | NONE | NONE |
An option that specifies the type of processing for an event. |
None |
None |