DL Logo

Dump Callback Signatures

PDEAttrEnumProc

Header: PEExpT.h:2125

Description

A callback for PDEAttrEnumTable(). It is called once for each attribute in a table.

Syntax

ASBool PDEAttrEnumProc(IN void *attrHdrP, IN ASUns32 refCount, IN ASUns16 size, IN void *clientData);

Parameters

attrHdrP
An opaque pointer to the attribute. The actual attribute type is not specified in this function, since the storage mechanism only knows the size of the attribute, not its type.
refCount
The reference count of the attribute.
size
The size of attrHdrP in bytes.
clientData
User-supplied data that was specified in the call to PDEAttrEnumTable().

Returns

true to continue enumeration, false to halt enumeration.

Used By

PDEObjectDumpProc

Header: PEExpT.h:2107

Description

A callback for PDELogDump() or PDEObjectDump(). It is called once for each PDEObject, its children, and their attributes for the specified number of levels.

Syntax

void PDEObjectDumpProc(IN PDEObject obj, IN const char *dumpInfo, IN void *clientData);

Parameters

obj
IN/OUT The PDEObject.
dumpInfo
IN/OUT Contains information about an object. Information fields are delimited by tabs. There are no newline characters in this string.
clientData
IN/OUT User-supplied data that was specified in the call to PDELogDump() or PDEObjectDump().

Used By

Dump Functions

PDEAttrEnumTable

Header: PERProcs.h:1312

Description

Enumerates the table of attributes. This method enumerates the shared resource objects. It is useful when looking for orphaned attributes.

Syntax

void PDEAttrEnumTable(IN PDEAttrEnumProc enumProc, IN void *clientData);

Parameters

enumProc
IN/OUT A callback to call for each attribute.
clientData
IN/OUT A pointer to user-supplied data to pass to enumProc each time it is called.

Exceptions

PDELogDump

Header: PERProcs.h:1299

Description

Enumerates the PDEObject objects. This is useful when looking for orphaned objects.

Related Methods

Syntax

void PDELogDump(IN PDEObjectDumpProc proc, IN void *clientData);

Parameters

proc
A callback to call once for each PDEObject.
clientData
A pointer to user-supplied data to pass to proc each time it is called.

Exceptions

PDEObjectDump

Header: PERProcs.h:1284

Description

    The object, its children and attributes are dumped. The dump contains information about each individual object. The output for child elements is indented with respect to their parents.
  • The information for each object is char *- the string describing Object Type. (See PDEObjectGetType()).
  • The number representing Object Type. (See PEExpT.h: PDEType enum).
  • The object reference count.
  • The memory location for the object.

Related Methods

Syntax

void PDEObjectDump(IN PDEObject obj, IN ASInt32 levels, IN PDEObjectDumpProc proc, IN void *clientData);

Parameters

obj
The PDEObject to dump.
levels
The depth of children to dump.
proc
A callback with the dump information; it may be called more than once per object.
clientData
Provided by the caller as the parameter of the same name for proc.

Exceptions