FSPDF_ACTIONDATA_EMBEDDEDGOTO Struct Reference

Structure for action type FSPDF_ACTION_EMBEDDEDGOTO. More...

#include <fpdf_base_r.h>

Public Attributes

FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGETtarget
 Pointer to a FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET structure which specifies path information to the target document.
 
FSPDF_ATTACHMENT attachment
 Handle to a FSPDF_ATTACHMENT object which is the root document of the target.
 
FSPDF_DESTDATA destData
 Destination data. More...
 
FSCRT_BSTR destName
 Destination name, in UTF-8. More...
 
FS_BOOL newWindow
 Whether a new window should be opened or not.
 

Detailed Description

Structure for action type FSPDF_ACTION_EMBEDDEDGOTO.

Note
Destination information of this action can be represented by either destData or destName.
  • At least, one of destData or destName should be valid.
  • If destName is valid, that means the destination is treated as a named destination and destData could be ignore.

Member Data Documentation

FSPDF_DESTDATA FSPDF_ACTIONDATA_EMBEDDEDGOTO::destData

Destination data.

Note
If destName is valid, that means the destination is treated as a named destination and this member will be ignored.
If destName is empty, this member should be valid.
FSCRT_BSTR FSPDF_ACTIONDATA_EMBEDDEDGOTO::destName

Destination name, 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(). If this member is valid, that means the destination is treated as a named destination.
If destData is NULL, this member should be valid.

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

Foxit Corporation