IPXC_Document::AddImageFromStream Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Document::AddImageFromStream Method}}
 
{{#customTitle:IPXC_Document::AddImageFromStream Method}}
 +
{{#parentPage:PXV:IPXC_Document#Methods|AddImageFromStream|method}}
 +
{{ToReview}}
  
−
The method of interface of PDF-XChange Editor SDK.
+
Adds new image to the document from <code>IStream</code> source.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT AddImageFromStream([in] IStream* pStream, [in, defaultvalue(0)] ULONG nPage, [in, defaultvalue(0)] ULONG nFlags, [out, retval] IPXC_Image** ppImage);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT AddImageFromStream([in]                   IStream*     pStream,
 +
                          [in, defaultvalue(0)] ULONG         nPage,
 +
                          [in, defaultvalue(0)] ULONG         nFlags,
 +
                          [out, retval]         IPXC_Image** pImage);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''pStream''
+
;pStream
−
:[in] Pointer to IStream.
+
:[in] Pointer to <code>IStream</code> that contains image data in one of supported image file formats.
−
;''nPage''
+
;nPage
−
:[in, defaultvalue(0)] Value of ULONG.
+
:[in, defaultvalue(0)] Specifies zero-based page index into the images specified by ''pStream''.
−
;''nFlags''
+
;nFlags
−
:[in, defaultvalue(0)] 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 02:24, 15 June 2015

PDF Core Layer > Interfaces > IPXC_Document > IPXC_Document::AddImageFromStream Method


Adds new image to the document from IStream source.

Syntax

HRESULT AddImageFromStream([in]                   IStream*      pStream,
                           [in, defaultvalue(0)]  ULONG         nPage,
                           [in, defaultvalue(0)]  ULONG         nFlags,
                           [out, retval]          IPXC_Image**  pImage);

Parameters

pStream
[in] Pointer to IStream that contains image data in one of supported image file formats.
nPage
[in, defaultvalue(0)] Specifies zero-based page index into the images specified by pStream.
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

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXC_Document_AddImageFromStream&oldid=44786"