IUIX_Inst::CreateImageFromFile2 Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateImageFromFile2 Method}}
 
{{#customTitle:IUIX_Inst::CreateImageFromFile2 Method}}
{{#parentPage:PXV:IUIX_Inst|CreateImageFromFile2 Method|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|CreateImageFromFile2|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Creates new ''image'' object of [[PXV:IUIX_ImageData|IUIX_ImageData]] data interface from image file.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateImageFromFile2([in]          BSTR              pSourceFileName,
+
<pre class="brush:cpp;gutter:false">HRESULT CreateImageFromFile2([in]          BSTR              sSourceFileName,
                             [out, retval]  IUIX_ImageData**  ppImage);</pre>
+
                             [out, retval]  IUIX_ImageData**  pImage);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pSourceFileName
+
;sSourceFileName
:[in]  Value of BSTR.
+
:[in]  path to image file.
;ppImage
+
;pImage
:[out, retval]  Pointer to [[PXV:IUIX_ImageData|IUIX_ImageData]].
+
:[out, retval]  return object of [[PXV:IUIX_ImageData|IUIX_ImageData]] interface.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.  
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 09:58, 16 June 2015


Creates new image object of IUIX_ImageData data interface from image file.

Syntax

HRESULT CreateImageFromFile2([in]           BSTR              sSourceFileName,
                             [out, retval]  IUIX_ImageData**  pImage);

Parameters

sSourceFileName
[in] path to image file.
pImage
[out, retval] return object of IUIX_ImageData interface.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IUIX_Inst