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)
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT AddImageFromStream([in]                  IStream*      pStream,
+
<pre class="brush:cpp;gutter:false">HRESULT AddImageFromStream([in]                  IStream*      Stream,
                           [in, defaultvalue(0)]  ULONG        nPage,
+
                           [in, defaultvalue(0)]  ULONG        Page,
                           [in, defaultvalue(0)]  ULONG        nFlags,
+
                           [in, defaultvalue(0)]  ULONG        Flags,
                           [out, retval]          IPXC_Image**  pImage);</pre>
+
                           [out, retval]          IPXC_Image**  Image);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pStream
+
;Stream
 
:[in] Pointer to <code>IStream</code> that contains image data in one of supported image file formats.
 
:[in] Pointer to <code>IStream</code> that contains image data in one of supported image file formats.
;nPage
+
;Page
:[in, defaultvalue(0)] Specifies zero-based page index into the images specified by ''pStream''.
+
:[in, defaultvalue(0)] Specifies zero-based page index into the images specified by ''Stream''.
;nFlags
+
;Flags
 
:[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation.
 
:[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation.
;pImage
+
;Image
 
:[out, retval] Returns an [[PXV:IPXC_Image|IPXC_Image]] object of newly created image.
 
:[out, retval] Returns an [[PXV:IPXC_Image|IPXC_Image]] object of newly created image.
  

Revision as of 06:59, 12 June 2015


Adds new image to the document from IStream source.

Syntax

HRESULT AddImageFromStream([in]                   IStream*      Stream,
                           [in, defaultvalue(0)]  ULONG         Page,
                           [in, defaultvalue(0)]  ULONG         Flags,
                           [out, retval]          IPXC_Image**  Image);

Parameters

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