Structure for target of FSPDF_ACTIONDATA_EMBEDDEDGOTO. More...

#include <fpdf_base_r.h>

Public Attributes
struct _FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET *	next
	Pointer to a FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET structure which specifies additional path information to the target document. More...

FSCRT_BSTR	relationship
	Relationship between current document and the target document, in UTF-8. Valid values are "P"(the target is the parent of the current document) and "C"(the target is a child of the current document). More...

FSCRT_BSTR	filename
	Name of the file in the EmbeddedFiles name tree, in UTF-8. More...

FSCRT_BSTR	destname
	A named destination in target document that provides the page index of the file attachment annotation, in UTF-8. More...

FSCRT_BSTR	annotname
	Value of NM in the annotation dictionary, in UTF-8. More...

FS_INT32	pageindex
	Page index(zero-based) in target document containing the file attachment annotation. More...

FS_INT32	annotindex
	Annotation index(zero-based) of the page specified by parameter pageindex. More...

Detailed Description

Structure for target of FSPDF_ACTIONDATA_EMBEDDEDGOTO.

Note: Specify path information to a target document. Each target specifies one element in the full path to the target and may have nested target specifying additional elements.

Member Data Documentation

FS_INT32 FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET::annotindex

Annotation index(zero-based) of the page specified by parameter pageindex.

It should use annotname when parameter annotindex is -1.

FSCRT_BSTR FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET::annotname

Value of NM in the annotation dictionary, in UTF-8.

Note: If FSCRT_BSTR::str of annotname is a const string, the application should set this to NULL before calling function FSPDF_ActionData_Clear() to release resources of action data. Otherwise, the application should release action data by itself, instead of using function FSPDF_ActionData_Clear().

FSCRT_BSTR FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET::destname

A named destination in target document that provides the page index of the file attachment annotation, in UTF-8.

Note: If FSCRT_BSTR::str of destname is a const string, the application should set this to NULL before calling function FSPDF_ActionData_Clear() to release resources of action data. Otherwise, the application should release action data by itself, instead of using function FSPDF_ActionData_Clear().

FSCRT_BSTR FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET::filename

Name of the file in the EmbeddedFiles name tree, in UTF-8.

Please refer to section 3.6.3 in PDF Reference 1.7.

Note: If FSCRT_BSTR::str of filename is a const string, the application should set this to NULL before calling function FSPDF_ActionData_Clear() to release resources of action data. Otherwise, the application should release action data by itself, instead of using function FSPDF_ActionData_Clear().

struct _FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET* FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET::next

Pointer to a FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET structure which specifies additional path information to the target document.

If this entry is absent (NULL), the current document is the target file containing the destination.

FS_INT32 FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET::pageindex

Page index(zero-based) in target document containing the file attachment annotation.

It should use destname when parameter pageindex is -1.

FSCRT_BSTR FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET::relationship

Relationship between current document and the target document, in UTF-8. Valid values are "P"(the target is the parent of the current document) and "C"(the target is a child of the current document).

Note: If FSCRT_BSTR::str of relationship is a const string, application should set this to NULL before calling function FSPDF_ActionData_Clear() to release resources of action data. Otherwise, the application should release action data by itself, instead of using function FSPDF_ActionData_Clear().

The documentation for this struct was generated from the following file:

fpdf_base_r.h

Public Attributes

Detailed Description

Member Data Documentation