Information Catalog Manager Programming Guide and Reference

FLGManageTagBuf

Queries or resets the current delete history. Delete history is a log of delete activity that can be turned on and off.

Authorization

Administrator

Syntax



APIRET  APIENTRY   FLGManageTagBuf( FLGOPTIONS       InOptions,
                                    PFLGOPTIONS      pOutOptions,
                                    PFLGEXTCODE      pExtCode );

Parameters

InOptions (FLGOPTIONS) -- input
Choose one of the following options:
FLG_TAGBUF_QUERY
Queries whether the delete history log currently contains entries
FLG_TAGBUF_RESET
Removes any existing entries from the delete history log

pOutOptions (PFLGOPTIONS) -- output
Points to the status returned by FLG_TAGBUF_QUERY, either:
FLG_TAGBUF_STATUS_EMPTY
FLG_TAGBUF_STATUS_NOT_EMPTY

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 FLGManageTagBuf successfully resets the delete history. If FLGManageTagBuf does not reset the delete history successfully, include a call to FLGRollback (see FLGRollback).

Examples

Figure 124 shows the C language code required to issue the FLGManageTagBuf call. This sample code deletes the current contents of the delete history.

Figure 124. Sample C language call to FLGManageTagBuf

 
 APIRET           rc;               // reason code
 FLGOPTIONS       Opt1=0;           //option
 FLGEXTCODE       xc=0;             // extended code
   .
   .  /*                                                 */
   .
 Opt1=Opt1 | FLG_TAGBUF_RESET;      //set reset option
 rc = FLGManageTagBuf (Opt1,
                       NULL,        // not used.
                       &xc);
 


[ Top of Page | Previous Page | Next Page ]