Monkeybread Software - DynaPDF Manual

DynaPDF Manual - Page 529

Function Reference

Page 529 of 883

if loaded without a symbol name. The number of symbols that a SVG file contains can be

determined with the function GetSVGSymbolCount(). The parameter SymbolID must be the name of

the desired symbol in UTF-8 format or NULL.

Errors and warnings are passed to the error log. See GetErrLogMessage() for further information.

Return values:

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

GetSVGSymbolCount

Syntax:

SI32 pdfGetSVGSymbolCount(

const ISVG* ISVG) // Instance pointer

The function returns the number of symbols or separate SVG files which are included in the file. The

function considers <svg> elements with an id only. <symbol> elements are not considered because

such elements are usually private.

The name of the symbols in the list is returned by the function GetSVGSymbolName().

Please note that SVG files with a symbol count > 0 contain usually no visible element if loaded

without a valid symbol name.

If the return value is zero, call InsertSVG() without a symbol name. If the return value is greater

zero, get the symbol names with GetSVGSymbolName() and pass the desired name to InsertSVG().

Return values:

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

GetSVGSymbolName

Syntax:

LBOOL pdfGetSVGSymbolName(

const ISVG* ISVG,

// Instance pointer

UI32 Index,

// List index

const char** Symbol) // Address of char* variable

The function retrieves the name of a SVG symbol. SVG symbol names are UTF-8 encoded. The

C/C++ API of DynaPDF returns the pointer of the UTF-8 encoded raw string. Note that this is the

pointer of the original string, do not free or change the value.

The parameter Index must be in the range 0 through GetSVGSymbolCount() -1.

The interfaces for C#, VB Net, and VB 6 convert the string to UTF-16 because this is the internal

string format of these programming languages and dealing with UTF-8 strings would be

unnecessary complicated.