IG_PDF_action_get_destination

In This Topic

Gets an action's destination view.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_action_get_destination( HIG_PDF_ACTION hAction, LPHIG_PDF_DESTINATION lphDest );

Arguments:

hAction	HIG_PDF_ACTION	The action whose destination is obtained.
lphDest	HIG_PDF_DESTINATION	The action's destination, which may be either an explicit or named (basic string or name object). Use the IG_PDF_destination_resolve on this returned value to obtain an explicit destination.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

This only works for actions that contain a view destination - that is, actions whose type is GoTo. For named destinations, this function may return a basic string or name object. See Section 8.2.1 in the PDF Reference for more information on named destinations.

Since this function may not return an explicit destination, use the IG_PDF_destination_resolve on the returned value to obtain an explicit destination.

Get Product Support