IIXC_Inst::GetFormatInfo Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(12 intermediate revisions by 2 users 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#Methods|GetFormatInfo|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
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, [out] IXC_FormatInfo* pInfo);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetFormatInfo([in]           ULONG             nIndex,
 +
                      [out, retval] IIXC_FormatInfo** pInfo);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nIndex''
+
;nIndex
:[in]  Value of ULONG.
+
:[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 17: Line 22:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Inst|IIXC_Inst]].
+
[[PXV:IIXC_Inst|IIXC_Inst]]

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