IUIX_CmdAccelTargetCallback::OnGetCmdAccelTarget Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
 
{{#customTitle:IUIX_CmdAccelTargetCallback::OnGetCmdAccelTarget Method}}
 
{{#customTitle:IUIX_CmdAccelTargetCallback::OnGetCmdAccelTarget Method}}
 
{{#parentPage:PXV:IUIX_CmdAccelTargetCallback#Methods|OnGetCmdAccelTarget|method}}
 
{{#parentPage:PXV:IUIX_CmdAccelTargetCallback#Methods|OnGetCmdAccelTarget|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets target object of the given [[PXV:UIX_CmdAccel|shortcut]].
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT OnGetCmdAccelTarget([in]  IUIX_Obj*      pStart,
 
<pre class="brush:cpp;gutter:false">HRESULT OnGetCmdAccelTarget([in]  IUIX_Obj*      pStart,
                             [in]  UIX_CmdAccel*  pA1,
+
                             [in]  UIX_CmdAccel*  stA1,
                             [in]  UIX_CmdAccel*  pA2,
+
                             [in]  UIX_CmdAccel*  stA2,
                             [out]  LONG*          pCmdID,
+
                             [out]  LONG*          nCmdID,
                             [out]  LONG*          pCmdState,
+
                             [out]  LONG*          nCmdState,
                             [out]  IUIX_Obj**    ppCmdTarget);</pre>
+
                             [out]  IUIX_Obj**    pCmdTarget);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pStart
 
;pStart
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]] containing the starting object.
;pA1
+
;stA1
:[in]  Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]].
+
:[in]  Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]] containing the first part of the shortcut.
;pA2
+
;stA2
:[in]  Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]].
+
:[in]  Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]] containing the second part of the shortcut.
;pCmdID
+
;nCmdID
:[out]  Pointer to LONG.
+
:[out]  Pointer to LONG containing the resulting command ID.
;pCmdState
+
;nCmdState
:[out]  Pointer to LONG.
+
:[out]  Pointer to LONG containing the [[PXV:UIX_CmdItemState|command's state]].
;ppCmdTarget
+
;pCmdTarget
:[out]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+
:[out]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]] containing the command's target.
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 07:12, 4 April 2016


Gets target object of the given shortcut.

Syntax

HRESULT OnGetCmdAccelTarget([in]   IUIX_Obj*      pStart,
                            [in]   UIX_CmdAccel*  stA1,
                            [in]   UIX_CmdAccel*  stA2,
                            [out]  LONG*          nCmdID,
                            [out]  LONG*          nCmdState,
                            [out]  IUIX_Obj**     pCmdTarget);

Parameters

pStart
[in] Pointer to IUIX_Obj containing the starting object.
stA1
[in] Pointer to UIX_CmdAccel containing the first part of the shortcut.
stA2
[in] Pointer to UIX_CmdAccel containing the second part of the shortcut.
nCmdID
[out] Pointer to LONG containing the resulting command ID.
nCmdState
[out] Pointer to LONG containing the command's state.
pCmdTarget
[out] Pointer to IUIX_Obj containing the command's target.

Return Value

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

See Also

IUIX_CmdAccelTargetCallback