Monkeybread Software - DynaPDF Manual

DynaPDF Manual - Page 349

Function Reference

Page 349 of 821

Return values:

If the function succeeds the return value is the annotation handle, a value greater or equal zero. If

the function fails the return value is a negative error code.

FreeUniBuf

Syntax:

SI32 pdfFreeUniBuf(

const PPDF* IPDF) // Instance pointer

The function frees the internal buffer used by Unicode conversion functions such as

ConvToUnicode(), ToUTF16() and so on. The conversion is automatically freed by all conversion

functions before a new buffer is allocated. However, the buffer can be freed manually to reduce

memory usage.

Return values:

If the function succeeds the return value is 1. If the function fails the return value is 0. This function

can normally not fail; a return value of 0 indicates that an unknown fatal error occurred.

Get3DAnnotStream

Syntax:

LBOOL pdfGet3DAnnotStream(

const PPDF* IPDF, // Instance pointer

UI32 Annot,

// 3D annotation handle

BYTE** Data,

// Pointer to PRC or U3D file buffer

UI32* Size,

// Data size in bytes

char** SubType)

// U3D or PRC

The function retrieves the data stream of a 3D annotation. At time of publication, PDF supports U3D

and PRC files. Check the value of the string SubType to determine the file type. The default format is

U3D. SubType can be NULL in this case. For PRC files, SubType is required to be present.

The function returns pointers of the original values. Do not free or change the values.

Return values:

If the function succeeds the return value is 1. If the function fails the return value is 0.

GetActionCount

Syntax:

SI32 pdfGetActionCount(

const PPDF* IPDF) // Instance pointer

The function returns the number of actions contained in a document. This value can be used to

enumerate actions or to delete specific action types.