Information Catalog Manager Programming Guide and Reference

FLGFreeMem

Frees the memory allocated to an output structure created by an Information Catalog Manager API call; for example FLGListObjTypes or FLGNavigate.

Authorization

Administrator or user

Syntax

APIRET APIENTRY FLGFreeMem( PFLGHEADERAREA pFLGOutputStruct, PFLGEXTCODE pExtCode );

Parameters

pFLGOutputStruct (PFLGHEADERAREA) -- input

Points to the Information Catalog Manager output structure to be deallocated.

When you issue an API call that creates an output structure, you need to save the value of the pointer to the output structure that is generated by the Information Catalog Manager and stored at the address indicated by the PFLGHEADERAREA data type so that you can pass this pointer as a parameter to FLGFreeMem to free the allocated memory.

FLGFreeMem works only with output structures produced by the Information Catalog Manager API calls.

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.

Examples

Figure 72 shows the C language code required to invoke the FLGFreeMem API call. This sample code frees an Information Catalog Manager output structure in memory.

Figure 72. Sample C language call to FLGFreeMem

PFLGHEADERAREA pFLGOutputStruct; // pointer to the FLG output structure APIRET rc; // reason code FLGEXTCODE ExtCode = 0; // Extended code rc = FLGFreeMem ( pFLGOutputStruct, &ExtCode );