Information Catalog Manager Programming Guide and Reference

FLGConvertID

Retrieves the object type ID of an object type given the DP NAME, or the Name of an object instance given the FLGID.

Authorization

Administrator or user

Syntax

APIRET APIENTRY FLGConvertID( PSZ pszInBuffer, PSZ pszOutBuffer, FLGOPTIONS Options, PFLGEXTCODE pExtCode );

Parameters

pszInBuffer (PSZ) -- input

Points to an input buffer containing either a 16-character system-generated, unique identifier of an object instance (FLGID), or an 8-character short name for an object type (DP NAME).

pszOutBuffer (PSZ) -- output

Points to an output buffer containing either an 80-character external name of an object instance, or a 6-character object type ID.

Options (FLGOPTIONS) -- input

Choose one of the following options:

FLG_DPNAME

Indicates that the input buffer contains a DP NAME.

FLG_FLGID

Indicates that the input buffer contains an FLGID.

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 46 shows the C language code required to issue the FLGConvertID call. This sample code retrieves the object type identifier for a specified object type.

Figure 46. Sample C language call to FLGConvertID

APIRET rc; // reason code PSZ pszInBuffer; // pointer to input buffer PSZ pszOutBuffer; // pointer to output buffer FLGOPTIONS options=FLG_DPNAME; // option flag FLGEXTCODE xc = 0; // extended code . . . strcpy (pszInBuffer,"CHARTS"); // object type's DP NAME . . . rc = FLGConvertID (pszInBuffer, pszOutBuffer, options, &xc);