6.70 LceUseField

This function is used to declare which fields from the Repository (on the host) are to be used in the PC application. The LceUseField function indicates that the Repository field information will be required.

BOOL	LceUseField	(int	iSession,
		char far *	strFieldList )

  

Parameters

iSession	The session identifier as returned by LceGetSessionId.
strFieldList	The list of fields to be used. All fields in this list must be defined in the LANSA Repository. If the field is not defined, an error will result.  The length of each field should not exceed FIELD_LENGTH as defined in the LCOE.H header file.

  

Return Values

TRUE is returned if the session can accept the value.

FALSE is returned if an error occurs.

Notes

Any data dictionary field which is used in another function (e.g. LceFetch) must have been declared using this LceUseField function.

• This function must be executed before LceOpenSession function has been issued. If you need to execute this function after a session has been opened, you must end the session or open a new session.

• This function performs no communications to the host.

Related Functions

6.21 LceGetFieldDesc

6.23 LceGetFieldHeading

6.25 LceGetFieldIndicator

6.26 LceGetFieldLabel

6.27 LceGetFieldType

6.29 LceGetFieldValueX

6.30 LceGetFieldValueU

6.30 LceGetFieldValueU

6.58 LceSetFieldValue

6.59 LceSetFieldValueU

6.46 LceOpenSession

6.13 LceEndSession