ホーム › UI.WindowsAndMessaging › CopyAcceleratorTableW

CopyAcceleratorTableW

関数

アクセラレータテーブルの内容を複製する(Unicode)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT CopyAcceleratorTableW(
    HACCEL hAccelSrc,
    ACCEL* lpAccelDst,   // optional
    INT cAccelEntries
);

パラメーター

名前	型	方向	説明
hAccelSrc	HACCEL	in	コピー元のアクセラレータテーブルへのハンドル。
lpAccelDst	ACCEL*	outoptional	アクセラレータテーブルの情報を受け取る ACCEL 構造体の配列。
cAccelEntries	INT	in	lpAccelDst パラメーターが指すバッファーにコピーする ACCEL 構造体の数。

戻り値の型: INT

公式ドキュメント

指定されたアクセラレータテーブルをコピーします。この関数は、アクセラレータテーブルハンドルに対応するアクセラレータテーブルのデータを取得したり、アクセラレータテーブルのデータのサイズを判定するために使用します。(Unicode)

戻り値

型: int

lpAccelDst が NULL の場合、戻り値は元のテーブル内のアクセラレータテーブルエントリの数を示します。それ以外の場合は、コピーされたアクセラレータテーブルエントリの数を示します。

解説(Remarks)

メモ

winuser.h ヘッダーは CopyAcceleratorTable をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT CopyAcceleratorTableW(
    HACCEL hAccelSrc,
    ACCEL* lpAccelDst,   // optional
    INT cAccelEntries
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int CopyAcceleratorTableW(
    IntPtr hAccelSrc,   // HACCEL
    IntPtr lpAccelDst,   // ACCEL* optional, out
    int cAccelEntries   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function CopyAcceleratorTableW(
    hAccelSrc As IntPtr,   ' HACCEL
    lpAccelDst As IntPtr,   ' ACCEL* optional, out
    cAccelEntries As Integer   ' INT
) As Integer
End Function

' hAccelSrc : HACCEL
' lpAccelDst : ACCEL* optional, out
' cAccelEntries : INT
Declare PtrSafe Function CopyAcceleratorTableW Lib "user32" ( _
    ByVal hAccelSrc As LongPtr, _
    ByVal lpAccelDst As LongPtr, _
    ByVal cAccelEntries As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CopyAcceleratorTableW = ctypes.windll.user32.CopyAcceleratorTableW
CopyAcceleratorTableW.restype = ctypes.c_int
CopyAcceleratorTableW.argtypes = [
    wintypes.HANDLE,  # hAccelSrc : HACCEL
    ctypes.c_void_p,  # lpAccelDst : ACCEL* optional, out
    ctypes.c_int,  # cAccelEntries : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
CopyAcceleratorTableW = Fiddle::Function.new(
  lib['CopyAcceleratorTableW'],
  [
    Fiddle::TYPE_VOIDP,  # hAccelSrc : HACCEL
    Fiddle::TYPE_VOIDP,  # lpAccelDst : ACCEL* optional, out
    Fiddle::TYPE_INT,  # cAccelEntries : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn CopyAcceleratorTableW(
        hAccelSrc: *mut core::ffi::c_void,  // HACCEL
        lpAccelDst: *mut ACCEL,  // ACCEL* optional, out
        cAccelEntries: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode)]
public static extern int CopyAcceleratorTableW(IntPtr hAccelSrc, IntPtr lpAccelDst, int cAccelEntries);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CopyAcceleratorTableW' -Namespace Win32 -PassThru
# $api::CopyAcceleratorTableW(hAccelSrc, lpAccelDst, cAccelEntries)

#uselib "USER32.dll"
#func global CopyAcceleratorTableW "CopyAcceleratorTableW" wptr, wptr, wptr
; CopyAcceleratorTableW hAccelSrc, varptr(lpAccelDst), cAccelEntries   ; 戻り値は stat
; hAccelSrc : HACCEL -> "wptr"
; lpAccelDst : ACCEL* optional, out -> "wptr"
; cAccelEntries : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global CopyAcceleratorTableW "CopyAcceleratorTableW" sptr, var, int
; res = CopyAcceleratorTableW(hAccelSrc, lpAccelDst, cAccelEntries)
; hAccelSrc : HACCEL -> "sptr"
; lpAccelDst : ACCEL* optional, out -> "var"
; cAccelEntries : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global CopyAcceleratorTableW "CopyAcceleratorTableW" sptr, sptr, int
; res = CopyAcceleratorTableW(hAccelSrc, varptr(lpAccelDst), cAccelEntries)
; hAccelSrc : HACCEL -> "sptr"
; lpAccelDst : ACCEL* optional, out -> "sptr"
; cAccelEntries : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。