fpdf_objects_w.h File Reference

Header file for PDF Objects module of Foxit PDF SDK. More...

Go to the source code of this file.

Functions

FS_RESULT FSPDF_Object_CreateBoolean (FSCRT_DOCUMENT document, FS_BOOL boolean, FSPDF_OBJECT *object)
 Create a boolean PDF object. More...
 
FS_RESULT FSPDF_Object_CreateInteger (FSCRT_DOCUMENT document, FS_INT32 number, FSPDF_OBJECT *object)
 Create an integer number PDF object. More...
 
FS_RESULT FSPDF_Object_CreateFloat (FSCRT_DOCUMENT document, FS_FLOAT number, FSPDF_OBJECT *object)
 Create a float number PDF object. More...
 
FS_RESULT FSPDF_Object_CreateRawByteString (FSCRT_DOCUMENT document, const FSCRT_BSTR *string, FS_BOOL hexStr, FSPDF_OBJECT *object)
 Create a raw string PDF object. More...
 
FS_RESULT FSPDF_Object_CreateUnicodeString (FSCRT_DOCUMENT document, const FSCRT_BSTR *string, FSPDF_OBJECT *object)
 Create an UTF-8 string PDF object. More...
 
FS_RESULT FSPDF_Object_CreateDateTime (FSCRT_DOCUMENT document, const FSCRT_DATETIMEZONE *dt, FSPDF_OBJECT *object)
 Create a date PDF object. More...
 
FS_RESULT FSPDF_Object_CreateUnicodeName (FSCRT_DOCUMENT document, const FSCRT_BSTR *nameStr, FSPDF_OBJECT *object)
 Create an UTF-8 name PDF object. More...
 
FS_RESULT FSPDF_Object_CreateArray (FSCRT_DOCUMENT document, FSPDF_OBJECT *object)
 Create an array PDF object. More...
 
FS_RESULT FSPDF_Object_CreateRect (FSCRT_DOCUMENT document, const FSCRT_RECTF *rect, FSPDF_OBJECT *object)
 Create a rectangle PDF object. More...
 
FS_RESULT FSPDF_Object_CreateMatrix (FSCRT_DOCUMENT document, const FSCRT_MATRIX *matrix, FSPDF_OBJECT *object)
 Create a matrix PDF object. More...
 
FS_RESULT FSPDF_Object_CreateDict (FSCRT_DOCUMENT document, FSPDF_OBJECT *object)
 Create a dictionary PDF object. More...
 
FS_RESULT FSPDF_Object_CreateStream (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, FSPDF_OBJECT *object)
 Create a stream PDF object. More...
 
FS_RESULT FSPDF_Object_CreateReference (FSCRT_DOCUMENT document, FSPDF_OBJECT refObj, FSPDF_OBJECT *object)
 Create a reference PDF object. More...
 
FS_RESULT FSPDF_Object_CreateReferenceWithObjNum (FSCRT_DOCUMENT document, FS_DWORD objNum, FSPDF_OBJECT *object)
 Create a reference PDF object with an object number. More...
 
FS_RESULT FSPDF_Object_Release (FSCRT_DOCUMENT document, FSPDF_OBJECT object)
 Release a PDF object created but not inserted into any PDF document or other PDF objects. More...
 
FS_RESULT FSPDF_Array_InsertAt (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT element)
 Insert an element into array. More...
 
FS_RESULT FSPDF_Array_SetAt (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT element)
 Set a new element at parameter index position in array. More...
 
FS_RESULT FSPDF_Array_Add (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FSPDF_OBJECT element)
 Add an element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_AddBoolean (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_BOOL boolean)
 Add a boolean element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_AddInteger (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 number)
 Add an integer element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_AddFloat (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_FLOAT number)
 Add a float element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_AddRawByteString (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_BOOL hexStr, const FSCRT_BSTR *string)
 Add a raw string element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_AddUnicodeString (FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_BSTR *string)
 Add an UTF-8 string element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_AddDateTime (FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_DATETIMEZONE *dt)
 Add a date and time element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_AddUnicodeName (FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_BSTR *nameStr)
 Add an UTF-8 name element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_AddRect (FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_RECTF *rect)
 Add a rectangle element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_AddMatrix (FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_MATRIX *matrix)
 Add a matrix element into array, to the last position. More...
 
FS_RESULT FSPDF_Array_RemoveAt (FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index)
 Remove an element from array. More...
 
FS_RESULT FSPDF_Dictionary_SetAt (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSPDF_OBJECT object)
 Set an object as value to specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_SetAtBoolean (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_BOOL boolean)
 Set a boolean value with specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_SetAtInteger (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_INT32 number)
 Set an integer value to specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_SetAtFloat (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_FLOAT number)
 Set a float value to specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_SetAtRawByteString (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_BOOL hexStr, const FSCRT_BSTR *string)
 Set a raw byte string value to specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_SetAtUnicodeString (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_BSTR *string)
 Set a UTF-8 byte string value to specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_SetAtDateTime (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_DATETIMEZONE *dt)
 Set a date and time value to specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_SetAtUnicodeName (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_BSTR *nameStr)
 Set a UTF-8 name value to specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_SetAtRect (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_RECTF *rect)
 Set a rectangle value to specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_SetAtMatrix (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_MATRIX *matrix)
 Set a matrix value to specific key in dictionary. More...
 
FS_RESULT FSPDF_Dictionary_RemoveAt (FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key)
 Remove a specific key from dictionary. More...
 
FS_RESULT FSPDF_Stream_SetData (FSCRT_DOCUMENT document, FSPDF_OBJECT stream, FS_LPCVOID buffer, FS_DWORD length)
 Set stream data. More...
 
FS_RESULT FSPDF_Stream_ImportData (FSCRT_DOCUMENT document, FSPDF_OBJECT stream, FSCRT_FILE file)
 Import stream data from a file. More...
 

Detailed Description

Header file for PDF Objects module of Foxit PDF SDK.

Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

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:

  • 1. Create PDF objects.
  • 2. Add values to PDF array.
  • 3. Add values to PDF dictionary.
  • 4. Set data to PDF stream.
  • 5. Delete PDF objects.
Note
If you want to purchase Foxit PDF SDK license and use ANY of the following functions, please request for enabling Edit Add-on explicitly.

Foxit Corporation