CopyAcceleratorTableA function (winuser.h)

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 CopyAcceleratorTableA(
  [in]            HACCEL  hAccelSrc,
  [out, optional] LPACCEL lpAccelDst,
  [in]            int     cAccelEntries
);

Parameters

[in] hAccelSrc

Type: HACCEL

A handle to the accelerator table to copy.

[out, optional] lpAccelDst

Type: LPACCEL

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

[in] cAccelEntries

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.

Remarks

Note

The winuser.h header defines CopyAcceleratorTable as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll

See also

ACCEL

Conceptual

CreateAcceleratorTable

DestroyAcceleratorTable

Keyboard Accelerators

LoadAccelerators

Reference

TranslateAccelerator