Retrieves the file description from the Repository.
BOOL | LceGetFileDesc | (int | iSession, |
char far * | strFileName, | ||
char far * | strValue ) |
Parameters
iSession | The session identifier returned by LceGetSessionId. |
strFileName | The file name. This file must have been declared using an LceUseFile function. |
strValue | The variable which will receive the returned value. The size should be at least FILE_DESC_LENGTH + 1 as defined in the LCOE.H header file. |
Return Values
TRUE is returned if the session has retrieved the file description.
FALSE is returned if an error occurs.
Notes
- This function performs no communications with the host.
- This function must be executed after the session is opened.
Tip: By retrieving the description from the LANSA Repository rather than including it in your PC application, your PC descriptions will be consistent with your host applications and your maintenance will be reduced. If the partition is multilingual, the description will be in the required language.