Information Catalog Manager Programming Guide and Reference

FLGOpen

Starts an external program from the Information Catalog Manager.

Authorization

Administrator or user

Syntax

APIRET APIENTRY FLGOpen( PSZ pszPgmFLGID, PSZ pszObjFLGID, PFLGEXTCODE pExtCode );

Parameters

pszPgmFLGID (PSZ) -- input

Points to the 16-character FLGID of the Programs object instance that contains execution information. This FLGID includes the 6-character object type ID followed by a 10-character instance ID of the Programs object.

pszObjFLGID (PSZ) -- input

Points to the 16-character FLGID of a non-Program category object instance that supplies values to the parameter list. This includes the 6-character object type ID followed by a 10-character instance ID.

pExtCode (PFLGEXTCODE) -- output

Points to an extended code associated with the reason code. See Appendix D, Information Catalog Manager reason codes to see if a meaningful extended code is associated with the returned reason code.

Reason code (APIRET)

Represents the execution result of this API call.

See Appendix D, Information Catalog Manager reason codes for an explanation of the returned reason codes.

Usage

To issue an FLGOpen call for a program, the program object must be set up as described in Setting up Programs objects to start programs.

When the program described by the Programs object starts, it uses invocation parameters provided by the identified object instance. The Information Catalog Manager removes any formatting characters entered with the invocation parameters.

Examples

Figure 135 shows the C language code required to call the FLGOpen API call. This sample code launches a program named PRINTRPT using invocation parameters supplied by an object instance named REPORT1.

Figure 135. Sample C language call to FLGOpen

. APIRET rc; // reason code from FLGOpen UCHAR pszPgmFLGID[FLG_ID_LEN + 1]; UCHAR pszObjFLGID[FLG_ID_LEN + 1]; FLGEXTCODE ExtCode = 0; // Extended code . . /* set pszPgmFLGID Information Catalog Manager-id of 'PRINTRPT' */ . /* set pszObjFLGID to Information Catalog Manager-id of 'REPORT1' */ . rc = FLGOpen (pszPgmFLGID, pszObjFLGID, &ExtCode);