IIXC_Inst::GetFormatInfo Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Inst::GetFormatInfo Method}}
 
{{#customTitle:IIXC_Inst::GetFormatInfo Method}}
{{#parentPage:PXV:IIXC_Inst|GetFormatInfo Method|method}}
+
{{#parentPage:PXV:IIXC_Inst#Methods|GetFormatInfo|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
  
The method returns the [[PXV:IXC_FormatInfo|IXC_FormatInfo]] of a file format specified by its index position in the list of formats.
+
The method returns the [[PXV:IIXC_FormatInfo|IIXC_FormatInfo]] of a file format specified by its index position in the list of formats.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetFormatInfo([in]   ULONG           nIndex,
+
<pre class="brush:cpp;gutter:false">HRESULT GetFormatInfo([in]           ULONG             nIndex,
                       [out]  IXC_FormatInfo*  pInfo);</pre>
+
                       [out, retvalIIXC_FormatInfo**  pInfo);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 15: Line 16:
 
:[in]  Specifies the zero-based index of the file format in the formats list.
 
:[in]  Specifies the zero-based index of the file format in the formats list.
 
;pInfo
 
;pInfo
:[out]  Pointer to [[PXV:IXC_FormatInfo|IXC_FormatInfo]].
+
:[out, retval]  Pointer to [[PXV:IIXC_FormatInfo|IIXC_FormatInfo]].
  
 
== Return Value ==
 
== Return Value ==
Line 21: Line 22:
  
 
== See Also ==
 
== See Also ==
:[[PXV:IIXC_Inst|IIXC_Inst]]
+
[[PXV:IIXC_Inst|IIXC_Inst]]
:[[PXV:IIXC_Inst_FormatsCount|IIXC_Inst:FormatsCount]]
+
:[[PXV:IXC_FormatInfo|IXC_FormatInfo]]
+

Latest revision as of 08:22, 13 June 2016


The method returns the IIXC_FormatInfo of a file format specified by its index position in the list of formats.

Syntax

HRESULT GetFormatInfo([in]           ULONG              nIndex,
                      [out, retval]  IIXC_FormatInfo**  pInfo);

Parameters

nIndex
[in] Specifies the zero-based index of the file format in the formats list.
pInfo
[out, retval] Pointer to IIXC_FormatInfo.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IIXC_Inst