IUIX_Inst::CreateImageFromFile Method

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