IIXC_Inst::GetFormatInfo Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 9: Line 9:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetFormatInfo([in]  ULONG            nIndex,
+
<pre class="brush:cpp;gutter:false">HRESULT GetFormatInfo([in]  ULONG            Index,
                       [out]  IXC_FormatInfo*  stInfo);</pre>
+
                       [out]  IXC_FormatInfo*  Info);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nIndex
+
;Index
 
:[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.
;stInfo
+
;Info
 
:[out]  Pointer to [[PXV:IXC_FormatInfo|IXC_FormatInfo]].
 
:[out]  Pointer to [[PXV:IXC_FormatInfo|IXC_FormatInfo]].
  

Revision as of 05:50, 12 June 2015


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

Syntax

HRESULT GetFormatInfo([in]   ULONG            Index,
                      [out]  IXC_FormatInfo*  Info);

Parameters

Index
[in] Specifies the zero-based index of the file format in the formats list.
Info
[out] Pointer to IXC_FormatInfo.

Return Value

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

See Also

IIXC_Inst