IPXC_Document::AddImageFromStream Method

From Tracker Software 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*      Stream,
+
<pre class="brush:cpp;gutter:false">HRESULT AddImageFromStream([in]                  IStream*      pStream,
                           [in, defaultvalue(0)]  ULONG        Page,
+
                           [in, defaultvalue(0)]  ULONG        nPage,
                           [in, defaultvalue(0)]  ULONG        Flags,
+
                           [in, defaultvalue(0)]  ULONG        nFlags,
                           [out, retval]          IPXC_Image**  Image);</pre>
+
                           [out, retval]          IPXC_Image**  pImage);</pre>
  
 
== Parameters ==
 
== Parameters ==
;Stream
+
;pStream
 
:[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.
;Page
+
;nPage
:[in, defaultvalue(0)] Specifies zero-based page index into the images specified by ''Stream''.
+
:[in, defaultvalue(0)] Specifies zero-based page index into the images specified by ''pStream''.
;Flags
+
;nFlags
 
:[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation.
 
:[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation.
;Image
+
;pImage
 
:[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.
  

Latest revision as of 02:24, 15 June 2015


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