Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › LoadAcceleratorsA

LoadAcceleratorsA

関数
アクセラレータテーブルリソースを読み込む(ANSI)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

HACCEL LoadAcceleratorsA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpTableName
);

パラメーター

名前方向説明
hInstanceHINSTANCEinoptional読み込むアクセラレータテーブルを含む実行可能ファイルを持つモジュールのハンドル。
lpTableNameLPCSTRin読み込むアクセラレータテーブルの名前。あるいは、このパラメーターには、下位ワードにアクセラレータテーブルリソースのリソース識別子を、上位ワードに 0 を指定することもできます。この値を作成するには、MAKEINTRESOURCE マクロを使用します。

戻り値の型: HACCEL

公式ドキュメント

指定したアクセラレータテーブルを読み込みます。(ANSI)

戻り値

型: HACCEL

関数が成功した場合、戻り値は読み込まれたアクセラレータテーブルのハンドルです。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

アクセラレータテーブルがまだ読み込まれていない場合、関数は指定された実行可能ファイルからそれを読み込みます。

リソースから読み込まれたアクセラレータテーブルは、アプリケーションの終了時に自動的に解放されます。

例については、Creating Accelerators for Font Attributes を参照してください。

メモ

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

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

HACCEL LoadAcceleratorsA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpTableName
);
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr LoadAcceleratorsA(
    IntPtr hInstance,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPStr)] string lpTableName   // LPCSTR
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LoadAcceleratorsA(
    hInstance As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPStr)> lpTableName As String   ' LPCSTR
) As IntPtr
End Function
' hInstance : HINSTANCE optional
' lpTableName : LPCSTR
Declare PtrSafe Function LoadAcceleratorsA Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal lpTableName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LoadAcceleratorsA = ctypes.windll.user32.LoadAcceleratorsA
LoadAcceleratorsA.restype = ctypes.c_void_p
LoadAcceleratorsA.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    wintypes.LPCSTR,  # lpTableName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
LoadAcceleratorsA = Fiddle::Function.new(
  lib['LoadAcceleratorsA'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpTableName : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn LoadAcceleratorsA(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpTableName: *const u8  // LPCSTR
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr LoadAcceleratorsA(IntPtr hInstance, [MarshalAs(UnmanagedType.LPStr)] string lpTableName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LoadAcceleratorsA' -Namespace Win32 -PassThru
# $api::LoadAcceleratorsA(hInstance, lpTableName)
#uselib "USER32.dll"
#func global LoadAcceleratorsA "LoadAcceleratorsA" sptr, sptr
; LoadAcceleratorsA hInstance, lpTableName   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "sptr"
; lpTableName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global LoadAcceleratorsA "LoadAcceleratorsA" sptr, str
; res = LoadAcceleratorsA(hInstance, lpTableName)
; hInstance : HINSTANCE optional -> "sptr"
; lpTableName : LPCSTR -> "str"
; HACCEL LoadAcceleratorsA(HINSTANCE hInstance, LPCSTR lpTableName)
#uselib "USER32.dll"
#cfunc global LoadAcceleratorsA "LoadAcceleratorsA" intptr, str
; res = LoadAcceleratorsA(hInstance, lpTableName)
; hInstance : HINSTANCE optional -> "intptr"
; lpTableName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLoadAcceleratorsA = user32.NewProc("LoadAcceleratorsA")
)

// hInstance (HINSTANCE optional), lpTableName (LPCSTR)
r1, _, err := procLoadAcceleratorsA.Call(
	uintptr(hInstance),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpTableName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HACCEL
function LoadAcceleratorsA(
  hInstance: THandle;   // HINSTANCE optional
  lpTableName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'USER32.dll' name 'LoadAcceleratorsA';
result := DllCall("USER32\LoadAcceleratorsA"
    , "Ptr", hInstance   ; HINSTANCE optional
    , "AStr", lpTableName   ; LPCSTR
    , "Ptr")   ; return: HACCEL
●LoadAcceleratorsA(hInstance, lpTableName) = DLL("USER32.dll", "void* LoadAcceleratorsA(void*, char*)")
# 呼び出し: LoadAcceleratorsA(hInstance, lpTableName)
# hInstance : HINSTANCE optional -> "void*"
# lpTableName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn LoadAcceleratorsA(
    hInstance: ?*anyopaque, // HINSTANCE optional
    lpTableName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc LoadAcceleratorsA(
    hInstance: pointer,  # HINSTANCE optional
    lpTableName: cstring  # LPCSTR
): pointer {.importc: "LoadAcceleratorsA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
void* LoadAcceleratorsA(
    void* hInstance,   // HINSTANCE optional
    const(char)* lpTableName   // LPCSTR
);
ccall((:LoadAcceleratorsA, "USER32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cstring),
      hInstance, lpTableName)
# hInstance : HINSTANCE optional -> Ptr{Cvoid}
# lpTableName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* LoadAcceleratorsA(
    void* hInstance,
    const char* lpTableName);
]]
local user32 = ffi.load("user32")
-- user32.LoadAcceleratorsA(hInstance, lpTableName)
-- hInstance : HINSTANCE optional
-- lpTableName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const LoadAcceleratorsA = lib.func('__stdcall', 'LoadAcceleratorsA', 'void *', ['void *', 'str']);
// LoadAcceleratorsA(hInstance, lpTableName)
// hInstance : HINSTANCE optional -> 'void *'
// lpTableName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  LoadAcceleratorsA: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.LoadAcceleratorsA(hInstance, lpTableName)
// hInstance : HINSTANCE optional -> "pointer"
// lpTableName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* LoadAcceleratorsA(
    void* hInstance,
    const char* lpTableName);
C, "USER32.dll");
// $ffi->LoadAcceleratorsA(hInstance, lpTableName);
// hInstance : HINSTANCE optional
// lpTableName : LPCSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.ASCII_OPTIONS);
    Pointer LoadAcceleratorsA(
        Pointer hInstance,   // HINSTANCE optional
        String lpTableName   // LPCSTR
    );
}
@[Link("user32")]
lib LibUSER32
  fun LoadAcceleratorsA = LoadAcceleratorsA(
    hInstance : Void*,   # HINSTANCE optional
    lpTableName : UInt8*   # LPCSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LoadAcceleratorsANative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>);
typedef LoadAcceleratorsADart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>);
final LoadAcceleratorsA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<LoadAcceleratorsANative, LoadAcceleratorsADart>('LoadAcceleratorsA');
// hInstance : HINSTANCE optional -> Pointer<Void>
// lpTableName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LoadAcceleratorsA(
  hInstance: THandle;   // HINSTANCE optional
  lpTableName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'USER32.dll' name 'LoadAcceleratorsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LoadAcceleratorsA"
  c_LoadAcceleratorsA :: Ptr () -> CString -> IO (Ptr ())
-- hInstance : HINSTANCE optional -> Ptr ()
-- lpTableName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let loadacceleratorsa =
  foreign "LoadAcceleratorsA"
    ((ptr void) @-> string @-> returning (ptr void))
(* hInstance : HINSTANCE optional -> (ptr void) *)
(* lpTableName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("LoadAcceleratorsA" load-accelerators-a :convention :stdcall) :pointer
  (h-instance :pointer)   ; HINSTANCE optional
  (lp-table-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LoadAcceleratorsA = Win32::API::More->new('USER32',
    'HANDLE LoadAcceleratorsA(HANDLE hInstance, LPCSTR lpTableName)');
# my $ret = $LoadAcceleratorsA->Call($hInstance, $lpTableName);
# hInstance : HINSTANCE optional -> HANDLE
# lpTableName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目