IIXC_Inst::GetFormatInfo Method

Latest revision as of 07:22, 13 June 2016

Images Core Layer > Interfaces > IIXC_Inst > IIXC_Inst::GetFormatInfo Method

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

HRESULT GetFormatInfo([in]           ULONG              nIndex,
                      [out, retval]  IIXC_FormatInfo**  pInfo);

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

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#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 ==
-<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 ==
-;''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 ==
@@ Line 17: / Line 22: @@
 == See Also ==
-See also [[PXV:IIXC_Inst|IIXC_Inst]].
+[[PXV:IIXC_Inst|IIXC_Inst]]