IUIX_Cmd::GetShortcut Method

Latest revision as of 01:50, 24 March 2016

UI Layer > Interfaces > IUIX_Cmd > IUIX_Cmd::GetShortcut Method

Gets single or double shortcut from the command's shortcuts list by index.

HRESULT GetShortcut([in]   LONG           nIndex,
                    [out]  UIX_CmdAccel*  stA1,
                    [out]  UIX_CmdAccel*  stA2);

nIndex: [in] Value of LONG containing index in the shortcuts list.
stA1: [out] Pointer to UIX_CmdAccel containing single shortcut or first part of the double shortcut.
stA2: [out] Pointer to UIX_CmdAccel containing the second part of the double shortcut (if present).

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IUIX_Cmd::GetShortcut Method}}
+{{#parentPage:PXV:IUIX_Cmd#Methods|GetShortcut|method}}
+{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Gets single or double shortcut from the command's shortcuts list by index.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT GetShortcut([in] LONG nIndex, [out] UIX_CmdAccel* pA1, [out] UIX_CmdAccel* pA2);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT GetShortcut([in]   LONG           nIndex,
+                    [out]  UIX_CmdAccel*  stA1,
+                    [out]  UIX_CmdAccel*  stA2);</pre>
 == Parameters ==
-;''nIndex''
+;nIndex
-:[in]  Value of LONG.
+:[in]  Value of LONG containing index in the shortcuts list.
-;''pA1''
+;stA1
-:[out]  Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]].
+:[out]  Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]] containing single shortcut or first part of the double shortcut.
-;''pA2''
+;stA2
-:[out]  Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]].
+:[out]  Pointer to [[PXV:UIX_CmdAccel|UIX_CmdAccel]] containing the second part of the double shortcut (if present).
 == Return Value ==
@@ Line 19: / Line 24: @@
 == See Also ==
-See also [[PXV:IUIX_Cmd|IUIX_Cmd]].
+[[PXV:IUIX_Cmd|IUIX_Cmd]]