LayerPDSEdit_Layer
ObjectPDSAttrObj

A PDSAttrObj represents a structure attribute object, which is a Cos dictionary or stream describing attributes associated with a PDSElement. The attribute's data may be application-specific, suiting the application that adds or extracts logical structure information. An attribute object can have a revision number to indicate whether other applications have modified either the associated element or the element's contents since the application created or modified the element.


Typedef Summary
 Typedef
 PDSAttrObj
Represents PDF logical structure attribute objects, which are dictionaries containing application-specific data that can be attached to PDSElement objects.
Method Summary
 Method
 
void PDSAttrObjCreate(INPDDoc pdDoc, INASAtom owner, INASBool indirect, OUTPDSAttrObj* attrObj)
Creates a new attribute object with the specified owner.
 
void PDSAttrObjCreateFromStream(INASAtom owner, IN OUTCosObj cosStreamObj, OUTPDSAttrObj* attrObj)
Creates an attribute object with the specified owner from the specified Cos stream.
 
CosObj PDSAttrObjGetCosObj(PDSAttrObj attrObj)
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.
 
ASAtom PDSAttrObjGetOwner(INPDSAttrObj element)
Gets the value of the key (Owner) in the specified attribute object.

Typedefs Detail
PDSAttrObj 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef CosObj PDSAttrObj;

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

See Also

PDSAttrObjCreate
PDSAttrObjCreateFromStream
PDSClassMapGetAttrObj
PDSElementGetAttrObj
PDSElementRemoveAttrObj

File: PDSExpT.h
Line: 108



Method Detail
PDSAttrObjCreate()
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDSAttrObjCreate(INPDDoc pdDoc, INASAtom owner, INASBool indirect, OUTPDSAttrObj* attrObj)

Creates a new attribute object with the specified owner.

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.

See Also

PDSAttrObjCreateFromStream

Since

PI_PDS_WRITE_VERSION >= 0x00040000

File: PDSWriteProcs.h
Line: 608
PDSAttrObjCreateFromStream() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDSAttrObjCreateFromStream(INASAtom owner, IN OUTCosObj cosStreamObj, OUTPDSAttrObj* attrObj)

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

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.

See Also

PDSAttrObjCreate

Exceptions

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

Since

PI_PDS_WRITE_VERSION >= 0x00040000

File: PDSWriteProcs.h
Line: 624
PDSAttrObjGetCosObj() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

CosObj PDSAttrObjGetCosObj(PDSAttrObj attrObj)

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.

Parameters

attrObj — 

The attribute object whose Cos object is obtained.

Returns

The dictionary Cos object for the attribute object.

Since

PI_PDS_READ_VERSION >= 0x00060000

File: PDSReadProcs.h
Line: 865
PDSAttrObjGetOwner() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom PDSAttrObjGetOwner(INPDSAttrObj element)

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

This may throw various exceptions.

Parameters

element — 

The attribute object whose owner is obtained.

Returns

The ASAtom for the owner's name.

See Also

PDSAttrObjCreate

Since

PI_PDS_READ_VERSION >= 0x00040000

File: PDSReadProcs.h
Line: 503



Copyright 2020 Adobe Systems Incorporated and its licensors. All rights reserved. Adobe and the Adobe logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. This product contains either BSAFE and/or TIPEM software by RSA Security, Inc. Portions utilize Microsoft Windows Media Technologies. Copyright © 2006 Microsoft Corporation. All Rights Reserved. Notices, terms and conditions pertaining to other third party software are located at http://www.adobe.com/go/thirdparty/ and incorporated herein by reference.
Wed Feb 7 2024, 2:16 pm IST