Information Catalog Manager Programming Guide and Reference

FLGManageFlags

Queries or starts or stops recording delete history. Delete history is a log of delete activity that can be turned on and off.

Authorization

Administrator; user (FLG_ACTION_GET only)

Syntax

APIRET APIENTRY FLGManageFlags( FLGOPTIONS Action, FLGOPTIONS FlagType, UCHAR chValue, UCHAR * pchValue, PFLGEXTCODE pExtCode );

Parameters

Action (FLGOPTIONS) -- input

Choose one of the following action options:

FLG_ACTION_GET

Indicates whether logging of delete history is currently enabled or disabled

FLG_ACTION_UPDATE

Turns on or off logging of delete history

FlagType (FLGOPTIONS) -- input

Indicates the flag type. This value must be FLG_HISTORY_TYPE_DELETE.

chValue (UCHAR) -- input

Indicates desired flag value for FLG_ACTION_UPDATE. Choose one of the following flags:

FLG_YES

Enables logging of delete history

FLG_NO

Disables logging of delete history

pchValue (UCHAR) -- output

Points to the status returned by FLG_ACTION_GET, either:

FLG_YES

Logging of delete history is enabled

FLG_NO

Logging of delete history is disabled

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

Controlling updates to your information catalog

To keep your program as synchronized as possible with your information catalog, you should include a call to FLGCommit (see FLGCommit) after FLGManageFlagssuccessfully updates flags. If FLGManageFlags does not update flags successfully, you should include a call to FLGRollback (see FLGRollback).

Examples

Figure 122 shows the C language code required to issue the FLGManageFlags call. This sample code enables logging of the delete history.

Figure 122. Sample C language call to FLGManageFlags

APIRET rc; // reason code for API FLGOPTIONS Action=0; FLGOPTIONS Type=0; UCHAR chValue=FLG_YES; FLGEXTCODE xc=0; // extended code . . . Action= Action | FLG_ACTION_UPDATE; Type = Type | FLG_HISTORY_TYPE_DELETE; rc = FLGManageFlags (Action, Type, chValue, NULL, &xc);