IPXC_Document::AddImageFromIXCPage Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 6: | Line 6: | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Creates a new image in the document based on specified [[PXV:IIXC_Page|image page]]. | |
== Syntax == | == Syntax == | ||
| Line 15: | Line 15: | ||
== Parameters == | == Parameters == | ||
;pPage | ;pPage | ||
| − | :[in] | + | :[in] Specifies a [[PXV:IIXC_Page|IIXC_Page]] object from which new document image will be created. |
;nFlags | ;nFlags | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation. |
;ppImage | ;ppImage | ||
| − | :[out, retval] | + | :[out, retval] Returns an [[PXV:IPXC_Image|IPXC_Image]] object of newly created image. |
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code in other cases. | + | Returns <tt>S_OK</tt> if operation was successful or error code in other cases. |
== See Also == | == See Also == | ||
[[PXV:IPXC_Document|IPXC_Document]] | [[PXV:IPXC_Document|IPXC_Document]] | ||
Revision as of 15:49, 25 May 2015
Creates a new image in the document based on specified image page.
Syntax
HRESULT AddImageFromIXCPage([in] IIXC_Page* pPage,
[in, defaultvalue(0)] ULONG nFlags,
[out, retval] IPXC_Image** ppImage);
Parameters
- pPage
- [in] Specifies a IIXC_Page object from which new document image will be created.
- nFlags
- [in, defaultvalue(0)] Specifies additional flags of image creation.
- ppImage
- [out, retval] Returns an IPXC_Image object of newly created image.
Return Value
Returns S_OK if operation was successful or error code in other cases.
