IIXC_Inst::GetFormatInfo Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method returns the [[PXV:IXC_FormatInfo|IXC_FormatInfo]] of a file format specified by its index position in the list of formats.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 13:
 
== 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]  Pointer to [[PXV:IXC_FormatInfo|IXC_FormatInfo]].
Line 21: Line 21:
  
 
== See Also ==
 
== 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]]

Revision as of 00:00, 30 April 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            nIndex,
                      [out]  IXC_FormatInfo*  pInfo);

Parameters

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

Return Value

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

See Also

IIXC_Inst
IIXC_Inst:FormatsCount
IXC_FormatInfo