6.26 LceGetFieldLabel
Retrieves the field's label from the LANSA Repository.
|
BOOL |
LceGetFieldLabel |
(int |
iSession, |
|
|
|
char far * |
strFieldName, |
|
|
|
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. |
|
strValue |
Pointer to the array to receive the returned value. The size should be at least FIELD_LABEL_LENGTH + 1 as defined in the LCOE.H header file. |
Return Values
TRUE is returned if the session has got the field label.
FALSE is returned if an error occurs.
Notes
- This function performs no communications to the host.
- This function can only be executed after the session is opened.
Tip
Using the Repository's label rather than coding it in your application will ensure that your PC and host applications are consistent and your maintenance is reduced.
If the partition is multilingual, the label will be based on the language defined when the session is open.
If your application needs a longer name, instead of using this function, use the LceGetFieldHeading function to get the field's 3 line Column headings from the Repository.
Related Functions