IUIX_Inst::CreateImageFromFile Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(4 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateImageFromFile Method}}
 
{{#customTitle:IUIX_Inst::CreateImageFromFile Method}}
{{#parentPage:PXV:IUIX_Inst#Methods|CreateImageFromFile Method|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|CreateImageFromFile|method}}
{{ToReview}}
+
 
  
 
Creates new ''image'' object of [[PXV:IUIX_ImageData|IUIX_ImageData]] data interface.
 
Creates new ''image'' object of [[PXV:IUIX_ImageData|IUIX_ImageData]] data interface.
Line 9: Line 9:
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT CreateImageFromFile([in]          IAFS_File*        pSource,
 
<pre class="brush:cpp;gutter:false">HRESULT CreateImageFromFile([in]          IAFS_File*        pSource,
                             [out, retval]  IUIX_ImageData**  ppImage);</pre>
+
                             [out, retval]  IUIX_ImageData**  pImage);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pSource
 
;pSource
 
:[in]  source file object of [[PXV:IAFS_File|IAFS_File]] interface.
 
:[in]  source file object of [[PXV:IAFS_File|IAFS_File]] interface.
;ppImage
+
;pImage
 
:[out, retval]  return object of [[PXV:IUIX_ImageData|IUIX_ImageData]] interface.
 
:[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 ==
 
[[PXV:IUIX_Inst|IUIX_Inst]]
 
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 09:54, 16 June 2015


Creates new image object of IUIX_ImageData data interface.

Syntax

HRESULT CreateImageFromFile([in]           IAFS_File*        pSource,
                            [out, retval]  IUIX_ImageData**  pImage);

Parameters

pSource
[in] source file object of IAFS_File interface.
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