IPXC_Document::AddImageFromStream Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXC_Document::AddImageFromStream Method}}
 
{{#customTitle:IPXC_Document::AddImageFromStream Method}}
 
{{#parentPage:PXV:IPXC_Document#Methods|AddImageFromStream|method}}
 
{{#parentPage:PXV:IPXC_Document#Methods|AddImageFromStream|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Adds new image to the document from <code>IStream</code> source.
  
 
== Syntax ==
 
== Syntax ==
Line 16: Line 15:
 
== 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
+
;dwFlags
:[in, defaultvalue(0)] Value of ULONG.
+
:[in, defaultvalue(0)] Specifies additional [[PXV:PXC_ImageToXObjectFlags|flags]] of image creation.
 
;ppImage
 
;ppImage
:[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 ==
 
[[PXV:IPXC_Document|IPXC_Document]]
 
[[PXV:IPXC_Document|IPXC_Document]]

Revision as of 17:20, 25 May 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**  ppImage);

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

See Also

IPXC_Document