PDSEdit_Layer.General (PDFL)

	Define
	IN
	kPDSAfterLast
	kPDSBeforeFirst
	OUT
	PDSEditError
	PDSReadHFT_LATEST_VERSION
	PDSReadHFTName
	_PDSRead_IS_BETA
	_PDSRead_LAST_BETA_COMPATIBLE_VERSION
	_PDSRead_LATEST_VERSION
	PDSRead_VERSION_2
	PDSRead_VERSION_5
	PDSRead_VERSION_6
	PDSRead_VERSION_7
	PDSRead_VERSION_8
	PDSWriteHFT_LATEST_VERSION
	PDSWriteHFTName
	_PDSWrite_IS_BETA
	_PDSWrite_LAST_BETA_COMPATIBLE_VERSION
	_PDSWrite_LATEST_VERSION
	PDSWrite_VERSION_5
	PDSWrite_VERSION_6
	PDSWrite_VERSION_7
	PDSWrite_VERSION_8
	PDSWrite_VERSION_B

	Typedef
	PDUserPropertiesXMLLabels

	Enumeration
	`PDSEditErrors`
	`PDSType` PDS object types.

	Structure
	_t_PDUserPropertiesXMLLabels Information about XML labels for exporting user properties.

	Callback
	EnumElementsWithUserPropertiesProc A callback for PDDocEnumPDSElementsWithUserProperties() and PDSElementEnumKidsWithUserProperties().

	Method
	void PDSOBJGetParent(INCosObj obj, OUTPDSElement* parent) Gets the parent element of the specified PDF object.

Defines Detail

_PDSRead_IS_BETA

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define _PDSRead_IS_BETA 0

File: PDSReadCalls.h

Line: 87

_PDSRead_LAST_BETA_COMPATIBLE_VERSION

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define _PDSRead_LAST_BETA_COMPATIBLE_VERSION 0x00080000

File: PDSReadCalls.h

Line: 86

_PDSRead_LATEST_VERSION

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define _PDSRead_LATEST_VERSION 0x00080000

File: PDSReadCalls.h

Line: 85

_PDSWrite_IS_BETA

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define _PDSWrite_IS_BETA 0

File: PDSWriteCalls.h

Line: 88

_PDSWrite_LAST_BETA_COMPATIBLE_VERSION

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define _PDSWrite_LAST_BETA_COMPATIBLE_VERSION 0x00080000

File: PDSWriteCalls.h

Line: 87

_PDSWrite_LATEST_VERSION

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define _PDSWrite_LATEST_VERSION 0x00080000

File: PDSWriteCalls.h

Line: 86

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define IN

File: PDSExpT.h

Line: 46

kPDSAfterLast

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPDSAfterLast (ASMAXInt32 - 1)

File: PDSExpT.h

Line: 229

kPDSBeforeFirst

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPDSBeforeFirst ((ASInt32) -1)

File: PDSExpT.h

Line: 228

OUT

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define OUT

File: PDSExpT.h

Line: 47

PDSEditError

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSEditError ErrBuildCode(ErrAlways, ErrSysPDSEdit, e)

File: AcroErr.h

Line: 318

PDSRead_VERSION_2

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSRead_VERSION_2 0x00020000

File: PDSReadCalls.h

Line: 92

PDSRead_VERSION_5

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSRead_VERSION_5 0x00050000

File: PDSReadCalls.h

Line: 93

PDSRead_VERSION_6

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSRead_VERSION_6 0x00060000

File: PDSReadCalls.h

Line: 94

PDSRead_VERSION_7

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSRead_VERSION_7 0x00070000

File: PDSReadCalls.h

Line: 95

PDSRead_VERSION_8

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSRead_VERSION_8 0x00080000

File: PDSReadCalls.h

Line: 96

PDSReadHFT_LATEST_VERSION

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSReadHFT_LATEST_VERSION  _PDSRead_LATEST_VERSION)

File: PDSReadCalls.h

Line: 90

PDSReadHFTName

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSReadHFTName "PDSRead"

File: PDSReadHFTVers.h

Line: 24

PDSWrite_VERSION_5

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSWrite_VERSION_5 0x00050000

File: PDSWriteCalls.h

Line: 94

PDSWrite_VERSION_6

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSWrite_VERSION_6 0x00060000

File: PDSWriteCalls.h

Line: 95

PDSWrite_VERSION_7

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSWrite_VERSION_7 0x00070000

File: PDSWriteCalls.h

Line: 96

PDSWrite_VERSION_8

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSWrite_VERSION_8 0x00080000

File: PDSWriteCalls.h

Line: 97

PDSWrite_VERSION_B

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSWrite_VERSION_B 0x00000006

File: PDSWriteCalls.h

Line: 93

PDSWriteHFT_LATEST_VERSION

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSWriteHFT_LATEST_VERSION  _PDSWrite_LATEST_VERSION)

File: PDSWriteCalls.h

Line: 91

PDSWriteHFTName

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PDSWriteHFTName "PDSWrite"

File: PDSWriteHFTVers.h

Line: 24

Typedefs Detail

PDUserPropertiesXMLLabels

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDUserPropertiesXMLLabels PDUserPropertiesXMLLabels;

File: PDSExpT.h

Line: 301

Enumeration Detail

PDSEditErrors

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDSEditErrors {

  pdsErrRequiredMissing,


 


  pdsErrBadPDF,


 


  pdsErrWrongTypeEntry,


 


  pdsErrWrongTypeParameter,


 


  pdsErrAlreadyExists,


 


  pdsErrCantDo

}

File: AcroErr.h

Line: 2566

Elements

	pdsErrRequiredMissing	A required field was missing from a dictionary.

	pdsErrBadPDF	An incorrect structure was found in the PDF file.

	pdsErrWrongTypeEntry	The dictionary entry has the wrong Cos type.

	pdsErrWrongTypeParameter	The wrong type parameter was supplied to a `PDS` procedure.

	pdsErrAlreadyExists	There is already a table entry with the same name.

	pdsErrCantDo	Some software required to perform this operation is not present in this version of Acrobat.

PDSType

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDSType {

  kPDSElement,


 


  kPDSAttrObj,


 


  kPDSMCR,


 


  kPDSMC,


 


  kPDSRoleMap,


 


  kPDSClassMap,


 


  kPDSLastType

}

File: PDSExpT.h

Line: 176

Structure Detail

_t_PDUserPropertiesXMLLabels

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDUserPropertiesXMLLabels {

  ASSize_t size;  


 


  ASText rootTag;  


 


  ASText nodeTag;  


 


  ASText propTag;  


 


  ASText classTag;  


 


  ASText classDefTag;  


 


  ASText nodeNameTag;  


 


  ASText propNameTag;  


 


  ASText propValueTag;  


 


  ASText propTypeTag;  


 


  ASText propFormatTag;  


 


  ASText propHiddenTag;  


 


  ASText classNameTag;  


 


  ASText classDefNameTag;  

}

Information about XML labels for exporting user properties.

Tag	Name
`nodeTag`	`"xyz_Node"`
`nodeNameTag`	`"xyz_NodeName"`
`propTag`	`"xyz_Property"`
`propNameTag`	`"xyz_PropertyName"`
`propValTag`	`"xyz_Value"`

File: PDSExpT.h

Line: 286

Callbacks Detail

EnumElementsWithUserPropertiesProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*EnumElementsWithUserPropertiesProc)(PDSElement elem, PDSElement closestAncestorWithUserProperties, void *clientData)

A callback for PDDocEnumPDSElementsWithUserProperties() and PDSElementEnumKidsWithUserProperties().

File: PDSExpT.h

Line: 266

Method Detail

PDSOBJGetParent

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDSOBJGetParent(INCosObj obj, OUTPDSElement* parent)

Gets the parent element of the specified PDF object.

This may throw various exceptions.

Parameters

	`obj` —	IN/OUT The PDF object whose parent element is obtained. It must be referred to via an OBJR from some element (that is, it has a `struct` parent key), otherwise it is undefined.

	`parent` —	IN/OUT (Filled by the method) The parent element of `obj`.

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
General	Defines \| Typedefs \| Enumerations \| Structures \| Callbacks \| Methods

	pdsErrRequiredMissing,

	pdsErrBadPDF,

	pdsErrWrongTypeEntry,

	pdsErrWrongTypeParameter,

	pdsErrAlreadyExists,

	pdsErrCantDo

	kPDSElement,

	kPDSAttrObj,

	kPDSMCR,

	kPDSMC,

	kPDSRoleMap,

	kPDSClassMap,

	kPDSLastType

	ASSize_t size;

	ASText rootTag;

	ASText nodeTag;

	ASText propTag;

	ASText classTag;

	ASText classDefTag;

	ASText nodeNameTag;

	ASText propNameTag;

	ASText propValueTag;

	ASText propTypeTag;

	ASText propFormatTag;

	ASText propHiddenTag;

	ASText classNameTag;

	ASText classDefNameTag;

Layer	PDSEdit_Layer
Object	General