CopyAcceleratorTable function

Copies the specified accelerator table. This function is used to obtain the accelerator-table data that corresponds to an accelerator-table handle, or to determine the size of the accelerator-table data.

Syntax


int WINAPI CopyAcceleratorTable(
  _In_      HACCEL  hAccelSrc,
  _Out_opt_ LPACCEL lpAccelDst,
  _In_      int     cAccelEntries
);

Parameters

hAccelSrc [in]

Type: HACCEL

A handle to the accelerator table to copy.

lpAccelDst [out, optional]

Type: LPACCEL

An array of ACCEL structures that receives the accelerator-table information.

cAccelEntries [in]

Type: int

The number of ACCEL structures to copy to the buffer pointed to by the lpAccelDst parameter.

Return value

Type: int

If lpAccelDst is NULL, the return value specifies the number of accelerator-table entries in the original table. Otherwise, it specifies the number of accelerator-table entries that were copied.

Examples

For an example, see Creating User Editable Accelerators.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

Unicode and ANSI names

CopyAcceleratorTableW (Unicode) and CopyAcceleratorTableA (ANSI)

See also

Reference
ACCEL
CreateAcceleratorTable
DestroyAcceleratorTable
LoadAccelerators
TranslateAccelerator
Conceptual
Keyboard Accelerators

 

 

Show: