6.23 LceGetFieldHeading
Retrieves a field's column headings from the Repository.
|
BOOL |
LceGetFieldHeading |
(int |
iSession, |
|
|
|
char far * |
strFieldName, |
|
|
|
int |
iHeading, |
|
|
|
char far * |
strValue ) |
Parameters
|
iSession |
The session identifier as returned by LceGetSessionId. |
|
strFieldName |
The field name. The field must have been declared using an LceUseField function. |
|
iHeading |
The heading level (1, 2 or 3). Heading levels are the equivalent of the Column Heading lines in the Repository. |
|
strValue |
The array to receive the returned value. The size should be at least FIELD_HEADING_LENGTH + 1 as defined in the LCOE.H header file. |
Return Values
TRUE is returned if the session has got the field heading.
FALSE is returned if an error occurs.
Notes
A field's column heading can be stored in the Repository in up to three separate lines. The three lines (or levels) make up the complete column heading. For example, the name for the Corporate Customer Number might be stored as:
|
Corporate |
|
Customer |
|
Number |
If you need a shorter field description, use either of these functions:
- LceGetFieldLabel to get the field's label
- LceGetFieldDesc to get the field's description.
To see how these lines are recorded, refer to Building the LANSA Repository - Fields in the Guide.
- This function performs no communications to the host.
- This function can only be executed after the session is opened.
Tip
Use this function to get the fields' column headings from the Repository rather than hard coding them in your applications. By retrieving the Repository information, all your PC applications will be consistent and your maintenance will be reduced.
If the partition is multilingual, the field's column headings will be based on the language defined when the session was opened.
Related Functions