DL Logo

PDSAttrObj Typedefs

PDSAttrObj

Header: PDSExpT.h:104

Description

Represents PDF logical structure attribute objects, which are dictionaries containing application-specific data that can be attached to PDSElement objects.

Syntax

typedef CosObj PDSAttrObj;

Used By

PDSAttrObj Functions

PDSAttrObjCreate

Header: PDSWriteProcs.h:584

Description

Creates a new attribute object with the specified owner.

Syntax

void PDSAttrObjCreate(IN PDDoc pdDoc, IN ASAtom owner, IN ASBool indirect, OUT PDSAttrObj *attrObj);

Parameters

pdDoc

The document in which the attribute object is created.

This may raise various exceptions.

owner
The owner of the new attribute object.
indirect
If true, it creates the attribute object as an indirect Cos object and sets the pdDoc parameter's PDDocNeedsSave flag (see PDDocFlags). If false, it creates the attribute object as a direct object.
attrObj
(Filled by the method) The newly created attribute object.

PDSAttrObjCreateFromStream

Header: PDSWriteProcs.h:600

Description

Creates an attribute object with the specified owner from the specified Cos stream.

Related Methods

Syntax

void PDSAttrObjCreateFromStream(IN ASAtom owner, IN OUT CosObj cosStreamObj, OUT PDSAttrObj *attrObj);

Parameters

owner
The owner of the new attribute object.
cosStreamObj
The Cos stream containing the data with which to create the attribute. The dictionary of this stream is modified.
attrObj
(Filled by the method) A pointer to the newly created attribute object. This actually points to cosStreamObj. May be NULL.

Exceptions

is raised if cosStreamObj is not a Cos stream. It may raise other exceptions as well.

PDSAttrObjGetCosObj

Header: PDSReadProcs.h:816

Description

Gets the Cos object corresponding to the specified attribute object. This method does not copy the object, but is instead the logical equivalent of a type cast.

Syntax

CosObj PDSAttrObjGetCosObj(PDSAttrObj attrObj);

Parameters

attrObj
The attribute object whose Cos object is obtained.

Returns

The dictionary Cos object for the attribute object.

PDSAttrObjGetOwner

Header: PDSReadProcs.h:480

Description

Gets the value of the key (Owner) in the specified attribute object.

This may throw various exceptions.

Related Methods

Syntax

ASAtom PDSAttrObjGetOwner(IN PDSAttrObj element);

Parameters

element
The attribute object whose owner is obtained.

Returns

The ASAtom for the owner's name.