Information Catalog Manager Programming Guide and Reference

FLGDeleteReg

Deletes a specific object type registration from the information catalog.

You can delete registration for a type of any category except the Program and Attachment categories, because the Information Catalog Manager provides these categories when it creates the information catalog.

Authorization

Administrator

Syntax 



APIRET  APIENTRY  FLGDeleteReg( PSZ            pszObjTypeID,
                                PFLGEXTCODE    pExtCode );

Parameters

pszObjTypeID (PSZ) -- input
Points to the 6-character, system-generated unique identifier (object type ID) of the object type for which you are deleting the registration.

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

This action does not delete the object type itself; it deletes the registration for the object type.

Restrictions

The value for the input parameter pszObjTypeID must exist for an object registration in the information catalog.

Before you can delete the registration for the object type, the object type itself must not exist. If the object type exists, you must delete the object type using FLGDeleteType.

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 FLGDeleteReg completes successfully. If FLGDeleteReg does not complete successfully, you should include a call to FLGRollback (see FLGRollback).

Examples

Figure 57 shows the C language code required to invoke the FLGDeleteReg API call. This sample code deletes the registration information for an object type from the information catalogs.

Figure 57. Sample C language call to FLGDeleteReg

 
 APIRET       rc;           // Declare reason code
 UCHAR        pszObjTypeID[FLG_OBJTYPID_LEN + 1];
 FLGEXTCODE   ExtCode = 0;       // Declare extended code
   .
   .  /* Get object type ID using FLGConvertID. */
   .
 strcpy (pszObjTypeID,"000044");
 rc = FLGDeleteReg (pszObjTypeID,    // object type ID
                      &ExtCode);

The example shown in Figure 57 assumes that the object type ID that was returned when you created the object registration (using FLGCreateReg) was 000044.

[ Top of Page | Previous Page | Next Page ]