IPXC_Document::AddImageFromIXCPage Method

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Document::AddImageFromIXCPage Method}}
 
{{#customTitle:IPXC_Document::AddImageFromIXCPage Method}}
 +
{{#parentPage:PXV:IPXC_Document#Methods|AddImageFromIXCPage|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Creates a new image in the document based on specified [[PXV:IIXC_Page|image page]].
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT AddImageFromIXCPage([in] IIXC_Page* pPage, [in, optional] ULONG nFlags, [out, retval] IPXC_Image** ppImage);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT AddImageFromIXCPage([in]                   IIXC_Page*   pPage,
 +
                            [in, defaultvalue(0)] ULONG         nFlags,
 +
                            [out, retval]         IPXC_Image** pImage);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pPage''
+
;pPage
:[in] Pointer to [[PXV:IIXC_Page|IIXC_Page]].
+
:[in] Specifies a [[PXV:IIXC_Page|IIXC_Page]] object from which new document image will be created.
;''nFlags''
+
;nFlags
:[in, optional] Value of ULONG.
+
:[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation.
;''ppImage''
+
;pImage
:[out, retval] Pointer to [[PXV:IPXC_Image|IPXC_Image]].
+
:[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 ==
See also [[PXV:IPXC_Document|IPXC_Document]].
+
[[PXV:IPXC_Document|IPXC_Document]]

Latest revision as of 03:24, 15 June 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**  pImage);

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.
pImage
[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.

See Also

IPXC_Document