IUIX_CmdPane::GetLineIndex Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdPane::GetLineIndex Method}} | {{#customTitle:IUIX_CmdPane::GetLineIndex Method}} | ||
| − | {{#parentPage:PXV:IUIX_CmdPane|GetLineIndex | + | {{#parentPage:PXV:IUIX_CmdPane#Methods|GetLineIndex|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Gets index of the command line in the command pane. | |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT GetLineIndex([in] IUIX_CmdLine* pLine, | <pre class="brush:cpp;gutter:false">HRESULT GetLineIndex([in] IUIX_CmdLine* pLine, | ||
| − | [out, retval] LONG* | + | [out, retval] LONG* nIndex);</pre> |
== Parameters == | == Parameters == | ||
;pLine | ;pLine | ||
| − | :[in] Pointer to [[PXV:IUIX_CmdLine|IUIX_CmdLine]]. | + | :[in] Pointer to [[PXV:IUIX_CmdLine|IUIX_CmdLine]] containing the command line. |
| − | ; | + | ;nIndex |
| − | :[out, retval] Pointer to LONG. | + | :[out, retval] Pointer to LONG containing the index of the command line in the command pane. If the command line is not in the current command pane then the '''-1''' will be returned instead. |
== Return Value == | == Return Value == | ||
| Line 21: | Line 21: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_CmdPane|IUIX_CmdPane]] | |
Latest revision as of 03:05, 25 March 2016
Gets index of the command line in the command pane.
Syntax
HRESULT GetLineIndex([in] IUIX_CmdLine* pLine,
[out, retval] LONG* nIndex);
Parameters
- pLine
- [in] Pointer to IUIX_CmdLine containing the command line.
- nIndex
- [out, retval] Pointer to LONG containing the index of the command line in the command pane. If the command line is not in the current command pane then the -1 will be returned instead.
Return Value
Returns S_OK if operation was successful or error code in other cases.
