IUIX_CmdPane::GetLineIndex Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IUIX_CmdPane::GetLineIndex Method}}
 
{{#customTitle:IUIX_CmdPane::GetLineIndex Method}}
 
{{#parentPage:PXV:IUIX_CmdPane#Methods|GetLineIndex|method}}
 
{{#parentPage:PXV:IUIX_CmdPane#Methods|GetLineIndex|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets index of the command line in the command pane.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 13:
 
== 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
 
;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 ==

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.

See Also

IUIX_CmdPane