6 71 LceUseFile

LANSA Open Guide

6.71 LceUseFile

This function is used to declare which files on the host are going to be used in the application.

BOOL

LceUseFile

(int

iSession,

 

 

 char far *

strFileList )

  

Parameters

iession

The session identifier as returned by LceGetSessionId.

strFileList

The list of files to be used. All files in this list must be defined in the LANSA Repository.

The length of each file should not exceed FILE_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

Portability Considerations

The references to LIBRARY and multi-member files in the following description are applicable only when your host is an IBM i.

  

The absolute specification for the file is LIBRARY/FILENAME.MEMBER.BASEMEMBER

The library name on the IBM i host and the member name within a physical file are optional. In general, you should not be constructing applications which require these parameters.

The default values for library and member are:

LIBRARY

*LIBL

MEMBER

*FIRST

BASEMEMBER

*FIRST

  

Any file which is used in another function (e.g. LceFetch) must have been declared in an LceUseFile function.

If the file has not been defined to the LANSA Repository, an error will result. If you are using host files which were not created by LANSA, they must be loaded into the LANSA Repository on the  host before you use this function. Building the LANSA Repository - Files in the  Introduction to LANSA for iSeries Guide explains how to load existing IBM i files to LANSA.

  • 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.32 LceGetFileDesc

6.33 LceGetFileType

6.46 LceOpenSession

6.13 LceEndSession