IPXC_Page::InsertNewAnnot Method

Revision as of 01:28, 25 May 2015

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

Syntax

HRESULT InsertNewAnnot([in]                               ULONG              nAnnotType,
                       [in]                               PXC_Rect*          pLocation,
                       [in, defaultvalue(-1)]             ULONG              nPos,
                       [out, retval, defaultvalue(NULL)]  IPXC_Annotation**  ppAnnot);

Parameters

nAnnotType

[in] Type of annotation that will be inserted.

pLocation

[in] 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.

ppAnnot

[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