PDeletePrivateData

Deletes the private data and private strings associated with the specified input criteria. Using kParmDontCare for parameter values, you can delete all private data and strings associated with any of the following: your plug-in; your plug-in and a class of objects; your plug-in, a class of objects, and a private ID; or your plug-in, a class of objects, a private ID, and a specific element.

Command constructor

PDeletePrivateData(const char * sDeveloperID, const char * sPlugInID, short cTargetClass,
unsigned long nTypeFlag, short nCount, unsigned long nTargetID);

const char * sDeveloperID;
Four-character string representing your name or your company name, (e.g., "ADBE" for Adobe)
const char * sPlugInID;
Four-character string representing the plug-in (e.g., "KYLN"for Keyline plug-in)
short cTargetClass;
kClassObject for imported graphics and images, and for PageMaker lines, boxes, ovals, polygons, and text blocks
kClassStory for stories
kClassPub for publication (current publication only)
kClassPage for page
kClassMaster for master page
kParmDontCare to delete all private data associated with specified sDeveloperID and sPlugInID.
unsigned long nTypeFlag;
Identifier you defined to distinguish between types of private data for same cTargetClass
kParmDontCare to delete all private data for specified cTargetClass and associated with specified plug-in, or if cTargetClass is kParmDontCare
short nCount;
Number of deletions
1 if nTypeFlag is set to kParmDontCare
unsigned long nTargetID;
Internal PageMaker identifier for element (graphic, image, text block, page, master page, or story) to which private data is associated
0 (zero) for publication (PageMaker deletes private data in current publication only)
kParmDontCare to delete all private data for all elements in specified cTargetClass and associated with a specified nTypeFlag, or if nTypeFlag is set to kParmDontCare

Exceptions. PDeletePrivateData throws an exception if:

The specified element has no private data associated with the specified plug-in and nTypeFlag (CQ_NOPDATA).
cTargetClass and nTargetID together do not specify an existing element (graphic, image, text block, page, master page, story, or publication) (CQ_INVALID_TARGET).
nTypeFlag is -1 (CQ_INVALID_CONTEXT).

Five parameters needed to identify data. PageMaker requires five parameters to identify private data:

sDeveloperID and sPlugInID to identify the plug-in.
cTargetClass and nTargetID to identify the element being assigned the data.
nTypeFlag to distinguish between data types (you define this parameter).

kParmDontCare. If you set any parameter to kParmDontCare, you must set all subsequent parameters to kParmDontCare as well, except nCount, which must be set to 1. If you set cTargetClass to kParmDontCare, then set nTypeFlag and nTargetID to kParmDontCare and set nCount to 1.

Examples. The following example deletes all private data of all ClassObject elements that are associated with "ADBE" and "KYLN"and have a private ID of 15.

PDeletePrivateData("ADBE", "KYLN", kClassObject, 15, 1, kParmDontCare);

This example deletes all private data of all kClassObject elements that are associated with "ADBE" and "KYLN".

PDeleteprivatedata("ADBE", "KYLN", kClassObject, kParmDontCare, 1, kParmDontCare);

This example deletes all private data in the publication that is associated with "ADBE" and "KYLN".

PDeletePrivateData("ADBE", "KYLN", kParmDontCare, kParmDontCare, 1, kParmDontCare);

PDeletePrivateData

Command constructor

See also