IIXC_Inst::GetFormatInfo Method
From PDF XChange PDF SDK
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] | + | <pre class="brush:cpp;gutter:false">HRESULT GetFormatInfo([in] ULONG nIndex, |
| − | [out] IXC_FormatInfo* stInfo);</pre> | + | [out, retval] IXC_FormatInfo* stInfo);</pre> |
== Parameters == | == Parameters == | ||
| Line 16: | 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. | ||
;stInfo | ;stInfo | ||
| − | :[out] Pointer to [[PXV:IXC_FormatInfo|IXC_FormatInfo]]. | + | :[out, retval] Pointer to [[PXV:IXC_FormatInfo|IXC_FormatInfo]]. |
== Return Value == | == Return Value == | ||
Revision as of 04:29, 17 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 nIndex,
[out, retval] IXC_FormatInfo* stInfo);
Parameters
- nIndex
- [in] Specifies the zero-based index of the file format in the formats list.
- stInfo
- [out, retval] Pointer to IXC_FormatInfo.
Return Value
Returns S_OK if operation was successful or error code in other cases.
