6.21 LceGetFieldDesc
Retrieves the field description from the Repository.
|
BOOL |
LceGetFieldDesc |
(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 |
The buffer location to receive the returned value. The size should be at least FIELD_DESC_LENGTH + 1 as defined in the LCOE.H header file. |
Return Values
TRUE is returned if the session has got the field description.
FALSE is returned if an error occurs.
Notes
If the partition is multilingual, the field description will be based on the language defined when the session is open.
- This function can only be executed after the session is opened.
- This function performs no communications to the host.
Tip
Always get your field descriptions from the Repository rather than hard code them in your PC application. By retrieving descriptions from the Repository, they will be consistent across both PC and host applications and, for multilingual applications, will be in the language required.
Related Functions