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