TrimToChar

Trim to Char

Minor Business Rule

Object Name: B0800002

Parent DLL: CFND

Location: Client/Server

Language: C

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

Data Structure

D0800002 - Trim to Char

Parameter NameData ItemData TypeReq/OptI/O/Both
szStringTXPPcharNONENONE

An all-purpose string that the system uses to temporarily display large amounts of text.

cCharEV01charNONENONE

An option that specifies the type of processing for an event.

cIncludeCharEV01charNONENONE

An option that specifies the type of processing for an event.

cDirectionEV01charNONENONE

An option that specifies the type of processing for an event.

Related Functions

None

Related Tables

None