objects.h File Reference

Objects API. More...

#include <pdfsdk/core/atoms.h>
#include <pdfsdk/core/types.h>
#include <pdfsdk/math_types.h>

Go to the source code of this file.

Classes
struct	PDObject
struct	PDWriteStreamProcs

Macros
#define	nullPDObject   (PDObjectCreateNull())

Typedefs
typedef struct PDObject	PDObject
typedef PDErrCode(PDFSDK_CALLCONV *	PDObjectDictEnumProc) (PDAtom key, PDObject value, void *userData)
typedef struct PDReadStreamRec_ *	PDReadStream
typedef struct PDWriteStreamRec_ *	PDWriteStream
typedef PDErrCode(PDFSDK_CALLCONV *	PDWriteStreamWriteProc) (void *streamData, const void *buffer, size_t nbytes, size_t *pWritten)
typedef PDErrCode(PDFSDK_CALLCONV *	PDWriteStreamCloseProc) (void *streamData)
typedef void(PDFSDK_CALLCONV *	PDWriteStreamFreeDataProc) (void *streamData)

Enumerations
enum	PDObjectType {   kPDObjectNull , kPDObjectInteger , kPDObjectReal , kPDObjectBoolean ,   kPDObjectName , kPDObjectString , kPDObjectDict , kPDObjectArray ,   kPDObjectStream }
enum	PDObjectStreamOpenMode { kPDObjectStreamOpenRaw , kPDObjectStreamOpenDecrypted , kPDObjectStreamOpenFiltered }

Functions
PDObject	PDObjectCreateNull ()
PDF_CORE_API void PDFSDK_CALLCONV	PDObjectAcquire (PDObject object)
PDF_CORE_API void PDFSDK_CALLCONV	PDObjectRelease (PDObject object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocGetObjectByID (PDDoc file, uint32_t id, PDObject *pObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectCopy (PDDoc file, PDObject srcobject, PDObject *pObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocGetRootObject (PDDoc file, PDObject *pObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocGetInfoObject (PDDoc file, PDObject *pObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectGetType (PDObject object, PDObjectType *type)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectDeepEqual (PDObject objA, PDObject objB, bool *pEqual)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateBoolObject (PDDoc file, bool indirect, bool value, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectGetBool (PDObject object, bool *value)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateIntObject (PDDoc file, bool indirect, int64_t value, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectGetInt (PDObject object, int64_t *value)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateRealObject (PDDoc file, bool indirect, float value, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectGetReal (PDObject object, float *value)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateStringObjectFromUnicode (PDDoc file, bool indirect, const wchar_t *buffer, size_t bufSize, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateStringObject (PDDoc file, bool indirect, const void *buffer, size_t numBytes, bool hexString, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectGetUnicodeString (PDObject object, wchar_t *buffer, size_t bufSize, size_t *bufNeededSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectGetString (PDObject object, void *buffer, size_t numBytes, size_t *neededBytes)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateNameObject (PDDoc file, bool indirect, PDAtom name, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectGetName (PDObject object, PDAtom *name)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateArrayObject (PDDoc file, bool indirect, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectArrayAdd (PDObject array, PDObject objectToAdd)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectArrayGet (PDObject array, size_t index, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectArrayRemove (PDObject array, size_t index)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectArrayGetLength (PDObject array, size_t *index)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateDictObject (PDDoc file, bool indirect, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectDictPut (PDObject dict, PDAtom name, PDObject object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectDictPutName (PDObject dict, PDAtom name, PDAtom value)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectDictFind (PDObject dict, PDAtom name, PDObject *object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectDictFindName (PDObject dict, PDAtom name, PDAtom *pvalue)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectDictRemove (PDObject dict, PDAtom name)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectDictEnum (PDObject dict, PDObjectDictEnumProc enumProc, void *userData)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateStreamObject (PDDoc file, const void *buffer, size_t bufSize, PDObject attributesDict, PDObject encodeParms, bool encodeSource, PDObject *pObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectStreamGetDict (PDObject objectStream, PDObject *pDict)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectStreamOpen (PDObject object, PDObjectStreamOpenMode openMode, PDReadStream *pStm)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDReadStreamRead (PDReadStream readStream, void *buffer, size_t numBytes, size_t *numBytesRead)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDReadStreamClose (PDReadStream stream)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDCreateWriteStreamFromProcs (const PDWriteStreamProcs *procs, void *streamData, PDWriteStream *pStream)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWriteStreamWrite (PDWriteStream readStream, const void *buffer, size_t numBytes, size_t *numBytesWritten)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDWriteStreamClose (PDWriteStream stream)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectIsIndirect (PDObject object, bool *pIndirect)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectGetObjNumber (PDObject object, uint32_t *pObjNum)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDObjectGetGenNumber (PDObject object, uint16_t *pGenNum)

Detailed Description

Objects API.

Typedef Documentation

PDObjectDictEnumProc

typedef PDErrCode(PDFSDK_CALLCONV * PDObjectDictEnumProc) (PDAtom key, PDObject value, void *userData)

Used with a PDObjectDictEnum to enumerate dictionary entries.

Enumeration Type Documentation

PDObjectType

enum PDObjectType

Represents the type of a PDObject and my be retrieved using PDObjectGetType