6 22 LceGetFieldEdit

LANSA Open Guide

6.22 LceGetFieldEdit

Retrieves the field edit code or word specified for a field in the LANSA Repository.

BOOL

LceGetFieldEdit

(int 

iSession,

 

 

 char far * 

strFieldName,

 

 

 char far *

strEdit,

 

 

 char far *

strFlag )

  

Parameters

iSession

The session identifier as returned by LceGetSessionId.

strFieldName

The field name. This must have been declared using an LceUseField function.

strEdit

The array to receive the returned edit code or word. The size of strEdit should be at least FIELD_EDIT_LENGTH + 1 as defined in the  LCOE.H header file.

Returned strFlag

W = strEdit will contain an "Edit Word" within single quotes " ' ".

E  = strEdit will contain a single character which is the "Edit Code".

N = no edit code or word was defined and the contents of strEdit are undefined.

strFlag

The array to receive a flag indicating the edit type in strEdit. The size of strFlag should be at least FIELD_EDIT_FLAG_LENGTH + 1. 

E = the field uses an edit CODE.

W = the field uses an edit WORD.

N = the field has no edit specified.

  

Return Values

TRUE is returned if the session has got the field's edit code or word. FALSE is returned if an error occurs.

Notes

Detailed information regarding the use of edit codes and words may be found in the IBM i DDS Reference Manual.

  • This function performs no communications to the host.
  • This function can only be executed after the session is opened.

Related Functions

6.26 LceGetFieldLabel

6.23 LceGetFieldHeading

6.27 LceGetFieldType

6.65 LceSetSessionOption