IIXC_Inst::GetFormatInfo Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 6: | Line 6: | ||
{{ToReview}} | {{ToReview}} | ||
− | The method returns the [[PXV: | + | 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] | + | <pre class="brush:cpp;gutter:false">HRESULT GetFormatInfo([in] ULONG nIndex, |
− | [out] | + | [out, retval] IIXC_FormatInfo** pInfo);</pre> |
== Parameters == | == Parameters == | ||
;nIndex | ;nIndex | ||
:[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 |
− | :[out] Pointer to [[PXV: | + | :[out, retval] Pointer to [[PXV:IIXC_FormatInfo|IIXC_FormatInfo]]. |
== Return Value == | == Return Value == |
Latest revision as of 07: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.