XYZDestinationHandle Class Reference

XYZ destination with optional left, top, and zoom parameters. More...

Inheritance diagram for XYZDestinationHandle:

error_type CALLING_CONVENTION	XYZDestination_FromDestination (DestinationHandle *handle, XYZDestinationHandle **result)
	Convert destination to XYZ destination if the type matches.
error_type CALLING_CONVENTION	XYZDestination_ToDestination (XYZDestinationHandle *handle, DestinationHandle **result)
	Convert XYZ destination back to base destination.
error_type CALLING_CONVENTION	XYZDestination_GetLeft (XYZDestinationHandle *handle, ObjectHandle **result)
	Get the left coordinate for XYZ destination (null means no change).
error_type CALLING_CONVENTION	XYZDestination_GetTop (XYZDestinationHandle *handle, ObjectHandle **result)
	Get the top coordinate for XYZ destination (null means no change).
error_type CALLING_CONVENTION	XYZDestination_GetZoom (XYZDestinationHandle *handle, ObjectHandle **result)
	Get the zoom factor for XYZ destination (null means no change).
error_type CALLING_CONVENTION	XYZDestination_Release (XYZDestinationHandle *handle)
	Decrement the internal reference counter.

Additional Inherited Members
Public Member Functions inherited from DestinationHandle
error_type CALLING_CONVENTION	Destination_CreateFromArray (ArrayObjectHandle *array_handle, DestinationHandle **result)
	Create a destination from an array object.
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from DestinationHandle
error_type CALLING_CONVENTION	Destination_CreateFromDictionary (DictionaryObjectHandle *dict_handle, DestinationHandle **result)
	Create a destination from a dictionary object.
error_type CALLING_CONVENTION	Destination_GetDestinationType (DestinationHandle *handle, DestinationType *result)
	Get the type of destination to determine available parameters.
error_type CALLING_CONVENTION	Destination_GetPageNumber (DestinationHandle *handle, ObjectHandle **result)
	The page of the document that shall be displayed.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

XYZ destination with optional left, top, and zoom parameters.

Member Function Documentation

XYZDestination_FromDestination()

error_type CALLING_CONVENTION XYZDestination_FromDestination	(	DestinationHandle *	handle,
		XYZDestinationHandle **	result
	)

Convert destination to XYZ destination if the type matches.

Returns

VANILLAPDF_ERROR_SUCCESS if destination is XYZ type, error otherwise

Friends And Related Symbol Documentation

XYZDestination_GetLeft()

error_type CALLING_CONVENTION XYZDestination_GetLeft ( XYZDestinationHandle *  handle, ObjectHandle **  result  )

related

Get the left coordinate for XYZ destination (null means no change).

Returns

VANILLAPDF_ERROR_OBJECT_MISSING if left coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

XYZDestination_GetTop()

error_type CALLING_CONVENTION XYZDestination_GetTop ( XYZDestinationHandle *  handle, ObjectHandle **  result  )

related

Get the top coordinate for XYZ destination (null means no change).

Returns

VANILLAPDF_ERROR_OBJECT_MISSING if top coordinate is null, VANILLAPDF_ERROR_SUCCESS otherwise

XYZDestination_GetZoom()

error_type CALLING_CONVENTION XYZDestination_GetZoom ( XYZDestinationHandle *  handle, ObjectHandle **  result  )

related

Get the zoom factor for XYZ destination (null means no change).

Returns

VANILLAPDF_ERROR_OBJECT_MISSING if zoom factor is null, VANILLAPDF_ERROR_SUCCESS otherwise

XYZDestination_Release()

error_type CALLING_CONVENTION XYZDestination_Release ( XYZDestinationHandle *  handle )

related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also

IUnknown_Release

---

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

• c_destinations.h