6.24 LceGetFieldHelpText
Retrieves the Help Text for a field from the LANSA Repository and either returns it in the specified buffer or displays it in a window.
|
BOOL |
LceGetFieldHelpText |
(int |
iSession, |
|
|
|
char far * |
strFieldName, |
|
|
|
char far * |
strType, |
|
|
|
char far * |
strEOL, |
|
|
|
char far * |
strHelpBuf, |
|
|
|
long |
lHelpBufLen ) |
Parameters
|
iSession |
The session identifier as returned by LceGetSessionId. |
|
strFieldName |
The field name. The field must have been declared using an LceUseField function. |
|
strType |
The type of help requested. U = Return User help text. D = Return Developer & User help text. |
|
strEOL |
The formatting characters to be added to the end of each help text line. You may use this parameter to specify how carriage returns and line feeds are to be inserted (e.g. "\n\r"). A zero length string indicates no characters are to be inserted. The size of strEOL should not exceed HELP_EOL_SIZE as defined in the LCOE.H header file. |
|
strHelpBuf |
The buffer to receive the returned text. |
|
lHelpBufLen |
The size of the buffer. Help Text is potentially very large. If you specify a buffer length of zero, LANSA Open will display a dialogue box containing the returned help text, up to the maximum size permitted by the operating system. If you specify a size, it will limit the amount of text returned. In this case, the additional text is truncated. |
Return Values
TRUE is returned if the session has got the help text.
FALSE is returned if an error occurs.
Notes
The text returned does not include any host display attributes. To maintain consistency with the text as displayed on a host terminal, these attributes are converted to spaces. This means that there will be 2 additional spaces at the beginning of each line. This is also the case when the help text is presented on a 5250 terminal.
The font and character size used to present the help text is specified in the Configuration File, described in Configuration File.
- This function may only be executed after the session is opened.
Tip
Use this function to retrieve the LANSA Repository's Help text, rather than record it in a PC file or hard code it in a program. This will ensure that your PC and host applications are consistent and will reduce your on-going application maintenance. If the partition is multilingual, the help text will be based on the language defined when the session is opened.
Related Functions