Header file for PDF Objects module of Foxit PDF SDK. More...
Go to the source code of this file.
Macros | |
Macro Definitions for PDF Object Types. | |
| #define | FSPDF_OBJECTTYPE_INVALID 0 |
| Invalid PDF object. | |
| #define | FSPDF_OBJECTTYPE_BOOLEAN 1 |
| PDF object type for boolean. | |
| #define | FSPDF_OBJECTTYPE_NUMBER 2 |
| PDF object type for integer or real number. | |
| #define | FSPDF_OBJECTTYPE_STRING 3 |
| PDF object type for string. | |
| #define | FSPDF_OBJECTTYPE_NAME 4 |
| PDF object type for name. | |
| #define | FSPDF_OBJECTTYPE_ARRAY 5 |
| PDF object type for array. | |
| #define | FSPDF_OBJECTTYPE_DICTIONARY 6 |
| PDF object type for dictionary. | |
| #define | FSPDF_OBJECTTYPE_STREAM 7 |
| PDF object type for stream. | |
| #define | FSPDF_OBJECTTYPE_NULL 8 |
| PDF object type for a null object. | |
| #define | FSPDF_OBJECTTYPE_REFERENCE 9 |
| PDF object type for a reference object. | |
Functions | |
| FS_RESULT | FSPDF_Object_GetType (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FS_INT32 *type) |
| Get the type of an object. More... | |
| FS_RESULT | FSPDF_Object_GetObjNum (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FS_DWORD *objNum) |
| Get the object number. More... | |
| FS_RESULT | FSPDF_Object_GetBoolean (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FS_BOOL *boolean) |
| Get boolean value from a PDF object. More... | |
| FS_RESULT | FSPDF_Object_GetInteger (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FS_INT32 *number) |
| Get integer value from a PDF object. More... | |
| FS_RESULT | FSPDF_Object_GetFloat (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FS_FLOAT *number) |
| Get float value from a PDF object. More... | |
| FS_RESULT | FSPDF_Object_GetRawByteString (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FSCRT_BSTR *string) |
| Get the raw byte string value from a PDF object. More... | |
| FS_RESULT | FSPDF_Object_GetUnicodeString (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FSCRT_BSTR *string) |
| Get the UTF-8 byte string value from a PDF object. More... | |
| FS_RESULT | FSPDF_Object_GetDateTime (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FSCRT_DATETIMEZONE *dt) |
| Get the date value from a PDF object. More... | |
| FS_RESULT | FSPDF_Object_GetRect (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FSCRT_RECTF *rect) |
| Get rectangle value from a PDF object. More... | |
| FS_RESULT | FSPDF_Object_GetMatrix (FSCRT_DOCUMENT document, FSPDF_OBJECT object, FSCRT_MATRIX *matrix) |
| Get matrix value from a PDF object. More... | |
| FS_RESULT | FSPDF_Array_CountElements (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 *count) |
| Get the count of elements in an array. More... | |
| FS_RESULT | FSPDF_Array_GetElement (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT *object) |
| Get an element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetBoolean (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FS_BOOL *boolean) |
| Get a boolean element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetInteger (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FS_INT32 *number) |
| Get an integer element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetFloat (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FS_FLOAT *number) |
| Get a float element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetRawByteString (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSCRT_BSTR *string) |
| Get a raw byte string element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetUnicodeString (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSCRT_BSTR *string) |
| Get an UTF-8 byte string element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetDateTime (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSCRT_DATETIMEZONE *dt) |
| Get a date and time element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetArray (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT *subArray) |
| Get an array element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetRect (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSCRT_RECTF *rect) |
| Get a rectangle element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetMatrix (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSCRT_MATRIX *matrix) |
| Get a matrix element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetDict (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT *dictionary) |
| Get a dictionary element in an array. More... | |
| FS_RESULT | FSPDF_Array_GetStream (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT *stream) |
| Get a stream element in an array. More... | |
| FS_RESULT | FSPDF_Dictionary_HasKey (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_BOOL *exist) |
| Determine whether a specific key exists in a dictionary or not. More... | |
| FS_RESULT | FSPDF_Dictionary_GetElement (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSPDF_OBJECT *object) |
| Get an element from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_EnumEntry (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, FSCRT_POSITION *position, FSCRT_BSTR *key, FSPDF_OBJECT *object) |
| Enumerate entries in a dictionary and retrieve a key and a PDF object at a given position. More... | |
| FS_RESULT | FSPDF_Dictionary_GetBoolean (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_BOOL *boolean) |
| Get a boolean value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetInteger (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_INT32 *number) |
| Get an integer value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetFloat (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_FLOAT *number) |
| Get a float value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetRawByteString (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSCRT_BSTR *string) |
| Get a raw string value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetUnicodeString (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSCRT_BSTR *string) |
| Get an UTF-8 string value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetDateTime (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSCRT_DATETIMEZONE *dt) |
| Get a date and time value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetArray (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSPDF_OBJECT *array) |
| Get an array value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetRect (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSCRT_RECTF *rect) |
| Get a rectangle value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetMatrix (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSCRT_MATRIX *matrix) |
| Get a matrix value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetDict (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSPDF_OBJECT *subDictionary) |
| Get a dictionary value from dictionary. More... | |
| FS_RESULT | FSPDF_Dictionary_GetStream (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSPDF_OBJECT *stream) |
| Get a stream value from dictionary. More... | |
| FS_RESULT | FSPDF_Stream_GetDict (FSCRT_DOCUMENT document, FSPDF_OBJECT stream, FSPDF_OBJECT *dictionary) |
| Get the dictionary object associated to a stream. More... | |
| FS_RESULT | FSPDF_Stream_GetData (FSCRT_DOCUMENT document, FSPDF_OBJECT stream, FS_BOOL rawData, FS_LPVOID buffer, FS_DWORD *length) |
| Get stream data. More... | |
| FS_RESULT | FSPDF_Stream_ExportData (FSCRT_DOCUMENT document, FSPDF_OBJECT stream, FS_BOOL rawData, FSCRT_FILE *file) |
| Export stream data to a file asynchronously. More... | |
| FS_RESULT | FSPDF_Reference_GetReferObject (FSCRT_DOCUMENT document, FSPDF_OBJECT reference, FSPDF_OBJECT *referObj) |
| Get the referred object associated to a reference object. More... | |
Header file for PDF Objects module of Foxit PDF SDK.
Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.
The following code is copyrighted and contains proprietary information and trade secrets of Foxit Software Inc.. You cannot distribute any part of Foxit PDF SDK to any third party or general public, unless there is a separate license agreement with Foxit Software Inc. which explicitly grants you such rights.
This header file provides direct access to PDF objects.
It contains:
