Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

DynaPDF Manual - Page 421

Previous Page 420   Index   Next Page 422

Function Reference
Page 421 of 750
GetOCGCount
Syntax:
SI32 pdfGetOCGCount(
const PPDF* IPDF) // Instance pointer
The function returns the number of OCGs or layers which are available in document.
Return values:
This function cannot fail, the return value is always greater or equal zero.
GetOCGUsageUserName
Syntax:
LBOOL pdfGetOCGUsageUserName(
const PPDF* IPDF, // Instance pointer
UI32 Handle,
// OCG handle
UI32 Index,
// Array index of the name
char* ADDR NameA, // Address of a char* variable
UI16* ADDR NameW) // Address of a UI16* variable
The function returns a user name of a Content Usage dictionary that is associated with an OCG or
layer. The functions a pointer of the original string that is stored in the PDF file. Either the Ansi or
Unicode string is returned but never both. DynaPDF is the owner of the string. You must not modify
or free the string.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
GetOCHandle
Syntax:
SI32 pdfGetOCHandle(
const IOCG* OC) // Pointer of an OCG or OCMD
The function returns the handle of an OCG or OCMD. A pointer of an OCG (Optional Content
Group) or OCMD (Optional Content Membership Dictionary) is provided in functions like
GetImageObj(), or ParseContent().
Return values:
If OC points to an OCMD the return value is an OCMD handle, a value greater or equal 0x40000000.
If OC points to an OCG the return value is an OCG handle, a value greater or equal zero. If the
function fails the return value is a negative error code.
GetOpacity
Syntax:
double pdfGetOpacity(
 

Previous topic: GetOCGContUsage

Next topic: GetOutputIntent