IUIX_Inst::CreateImageFromFile2 Method

Latest revision as of 08:58, 16 June 2015

UI Layer > Interfaces > IUIX_Inst > IUIX_Inst::CreateImageFromFile2 Method

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

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

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IUIX_Inst::CreateImageFromFile2 Method}}
-{{#parentPage:PXV:IUIX_Inst|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 ==
-<pre class="brush:cpp;gutter:false">HRESULT CreateImageFromFile2([in] BSTR pSourceFileName, [out, retval] IUIX_ImageData** ppImage);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT CreateImageFromFile2([in]           BSTR              sSourceFileName,
+                             [out, retval]  IUIX_ImageData**  pImage);</pre>
 == 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 ==
-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 [[PXV:IUIX_Inst|IUIX_Inst]].
+[[PXV:IUIX_Inst|IUIX_Inst]]