PGetPrivateList

Lists the type and size of private data and private strings for the specified input criteria. Using -2 for parameter values, you can list information about private data (with increasing granularity) by developer; by developer and plug-in; by developer, plug-in, and type of element; and so on.


Query constructor

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

const char * sDeveloperID;

Four-character string representing your name or company name (e.g. "ADBE" for Adobe)
kParmDontCare to list all private data in publica tion

const char * sPlugInID;

Four-character string representing plug-in (e.g. "KYLN" for Keyline plug-in)
kParmDontCare to list all private data in publication associated with specified sDeveloperID, or if sDeveloperID is set to kParmDontCare

short cTargetClass;

kClassObject for imported graphics and images, and for PageMaker-drawn lines, boxes, ovals, polygons, or text blocks
kClassStory for stories
kClassPub for publication (current publication only)
kClassPage for page
kClassMaster for master page
kParmDontCare or -2 to list all private data in publica tion associated with specified sDeveloperID and sPlugInID, or if any previous parameter is set to kParmDontCare

unsigned long nTypeFlag;

Identifier you defined to distinguish between types of private data for same cTargetClass (-1 is not allowed)
kParmDontCare to list all private data in publica tion associated with specified sDeveloperID, sPlugInID, and cTargetClass, or if any previous parameter is set to kParmDontCare

unsigned long nTargetID;

Internal PageMaker identifier for element (graphic, image, text block, story, page, or master page) to which private data is associated
0 (zero) for publication (PageMaker gets private data for current publication only)
kParmDontCare or -2 to list all private data in publica tion associated with specified sDeveloperID , sPlugInID, cTargetClass, and nTypeFlag, or if any previous parameter is set to kParmDontCare


Query results

This query returns a list of records about the private data associated with the specified object or objects. For each private data record:

const char * sDeveloperID;

Four-character string representing name or company name (e.g., ADBE for Adobe)

const char * sPlugInID;

Four-character string representing plug-in (e.g., KYLN for Keyline plug-in)

short cTargetClass;

kClassObject for imported graphics and images, and for PageMaker-drawn lines, boxes, ovals, polygons, or text blocks
kClassStory for stories
kClassPub for publication (current publication only)
kClassPage for page
kClassMaster for master page definitions

unsigned long nTypeFlag;

Identifier you defined to distinguish between types of private data for same cTargetClass

unsigned long nTargetID;

Internal PageMaker identifier for element (graphic, image, text block, story, page, or master page) to which private data is associated
0 (zero) for publication (PageMaker gets private data for current publication only)

short cPlatform;

0 for Windows
1 for Macintosh

unsigned long nSize;

Size of private data (for character strings, nSize equals the number of characters in the string plus one)

Exceptions. PGetPrivateList throws an exception if:

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

kParmDontCare. If you set any parameter to kParmDontCare, you must also set all subsequent parameters to kParmDontCare. For example, if you set cTargetClass to -2, you must set nTypeFlag and nTargetID to -2.

Example. The following example retrieves information about all the private data associated with the developer ADBE and the plug-in KYLN.

PGetPrivateList("ADBE", "KYLN", kParmDontCare, kParmDontCare, kParmDontCare);

The following example lists information about all private data in the publication that is associated with ADBE.

PGetPrivateList("ADBE", kParmDontCare, kParmDontCare, kParmDontCare, kParmDontCare);


See also

The PGetPrivateData and PGetPrivateString queries

The PDeletePrivateData, PPrivateData, and PPrivateString commands


Comments or suggestions? Contact Adobe Developer Support
Copyright © 1997 - 2001 Adobe Systems Incorporated. All rights reserved.
Legal notices and trademark attributions