IPXC_Page::InsertNewAnnotFromDict Method

From PDF XChange PDF SDK
Jump to: navigation, search


Inserts new annotation with given variant dictionary into the given position with given Z-order.

Syntax

HRESULT InsertNewAnnotFromDict([in]                               IPXS_PDFVariant*   pAnnotDict,
                               [in, defaultvalue(NULL)]           PXC_Rect*          stLocation,
                               [in, defaultvalue(-1)]             ULONG              nPos,
                               [out, retval, defaultvalue(NULL)]  IPXC_Annotation**  pAnnot);

Parameters

pAnnotDict
[in] Pointer to IPXS_PDFVariant containing the source variant dictionary for the annotation insertion.
stLocation
[in, defaultvalue(NULL)] Pointer to PXC_Rect containing the coordinates of the inserted annotation.
nPos
[in, defaultvalue(-1)] Position in annotation's Z-order on page. By default the inserted annotation will appear on top of the other annotations on the page.
pAnnot
[out, retval, defaultvalue(NULL)] Pointer to IPXC_Annotation containing the resulting annotation.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXC_Page