Information Catalog Manager Programming Guide and Reference

FLGXferTagBuf

Transfers the delete history, which is a log of delete activity, to a tag file to duplicate the deletions in other information catalogs, for example, "shadow" information catalogs in a distributed environment.

Authorization

Administrator

Syntax

APIRET APIENTRY FLGXferTagBuf( PSZ pszTagFileID, FLGOPTIONS Options, PFLGEXTCODE pExtCode );

Parameters

pszTagFileID (PSZ) -- input

Points to the name of the output tag language file. This parameter is required.

For OS/2, this parameter contains the drive, directory path, and file name, and must be valid for a file allocation table (FAT) or HPFS file. The file name and extension (excluding the drive and directories) cannot exceed 240 characters.

The target drive for this file can be either a fixed or removable disk.

Options (FLGOPTIONS) -- input

Choose one of the following options for the file to which you want to transfer the delete history:

FLG_TAGOPT_NEW

Create a new file

FLG_TAGOPT_REPLACE

Replaces an existing file

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

FLGXferTagBuf terminates abnormally when the target disk is full, even if the disk is removable.

To protect against erroneous deletions in other information catalogs, you should examine the contents of a delete history tag file before importing it to any other information catalog, especially if you have deleted Grouping object instances, or object types.

Examples

Figure 163 shows the C language code required to issue the FLGXferTagBuf call. This sample code creates the file c:\sampdel.tag, to which it then transfers the delete history.

Figure 163. Sample C language call to FLGXferTagBuf

APIRET rc; // reason code from API PSZ pszTagFile = "c:\\sampdel.tag"; FLGEXTCODE xc=0; // extended code FLGOPTIONS Options=0; . . /* */ . Options=Options | FLG_TAGOPT_NEW; rc = FLGXferTagBuf (pszTagFile, Options, &xc);