WinQueryAccelTable: Difference between revisions

Latest revision as of 19:29, 14 May 2025

This function queries the window or queue accelerator table.

Syntax

WinQueryAccelTable(hab, hwndFrame)

Parameters

hab (HAB) - input

Anchor-block handle.

hwndFrame (HWND) - input

Frame-window handle.

NULLHANDLE: Return queue accelerator.

Other: Return the window accelerator table, by sending the WM_QUERYACCELTABLE message to hwndFrame.

Returns

haccelAccel (HACCEL) - returns

Accelerator-table handle.

NULLHANDLE: Error occurred

Other: Accelerator-table handle.

Errors

Possible returns from WinGetLastError

PMERR_INVALID_HWND (0x1001): An invalid window handle was specified.

Remarks

Example Code

This example shows how to get the accelerator table for the frame window.

#define INCL_WINWINDOWMGR
#define INCL_WINACCELERATORS
#include <os2.h>

HACCEL haccel;
HWND hwndFrame, hwndClient; /* window handles. */
HAB hab;                    /* anchor block.   */

hwndFrame = WinQueryWindow(hwndClient,
                           QW_PARENT); /* get handle of parent, */
                                       /* which is frame window. */


    /* Now  get the accel table for the frame window  */
haccel = WinQueryAccelTable(hab, hwndFrame);

Related Functions

Related Messages

WM_QUERYACCELTABLE

@@ Line 1: / Line 1: @@
+This function queries the window or queue accelerator table.
-This function queries the window or queue accelerator table.
 ==Syntax==
@@ Line 6: / Line 5: @@
 ==Parameters==
- hab (HAB) - input
+;hab (HAB) - input:Anchor-block handle.
+;hwndFrame (HWND) - input:Frame-window handle.
-    Anchor-block handle.
+::NULLHANDLE: Return queue accelerator.
+::Other: Return the window accelerator table, by sending the WM_QUERYACCELTABLE message to hwndFrame.
-hwndFrame (HWND) - input
-    Frame-window handle.
-    NULLHANDLE
-        Return queue accelerator. Other
-        Return the window accelerator table, by sending the WM_QUERYACCELTABLE message to hwndFrame.
 ==Returns==
-;haccelAccel (HACCEL) - returns
+;haccelAccel (HACCEL) - returns:Accelerator-table handle.
-:Accelerator-table handle.
+::NULLHANDLE: Error occurred
+::Other: Accelerator-table handle.
-:;NULLHANDLE
-::Error occurred
-:;Other
-::Accelerator-table handle.
 ==Errors==
 Possible returns from WinGetLastError
+;PMERR_INVALID_HWND (0x1001):An invalid window handle was specified.
-;PMERR_INVALID_HWND (0x1001)
-:An invalid window handle was specified.
 ==Remarks==
@@ Line 39: / Line 26: @@
 #define INCL_WINWINDOWMGR
 #define INCL_WINACCELERATORS
-#include <OS2.H>
+#include <os2.h>
 HACCEL haccel;
@@ Line 52: / Line 39: @@
      /* Now  get the accel table for the frame window  */
 haccel = WinQueryAccelTable(hab, hwndFrame);
-</pre>
-Definition
-<pre>
-#define INCL_WINACCELERATORS /* Or use INCL_WIN, INCL_PM, */
-#include <os2.h>
-HAB       hab;          /*  Anchor-block handle. */
-HWND      hwndFrame;    /*  Frame-window handle. */
-HACCEL    haccelAccel;  /*  Accelerator-table handle. */
-haccelAccel = WinQueryAccelTable(hab, hwndFrame);
 </pre>
@@ Line 74: / Line 48: @@
 * [[WinSetAccelTable]]
 * [[WinTranslateAccel]]
 ==Related Messages==
-* WM_QUERYACCELTABLE
+* [[WM_QUERYACCELTABLE]]
 [[Category:Win]]