Win32 API 日本語リファレンス
ホームSystem.DataExchange › InitAtomTable

InitAtomTable

関数
ローカルアトムテーブルを指定サイズで初期化する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL InitAtomTable(
    DWORD nSize
);

パラメーター

名前方向説明
nSizeDWORDin

アトムテーブルに使用するハッシュバケットの数。このパラメーターが 0 の場合、既定の数のハッシュバケットが作成されます。

パフォーマンスを向上させるには、 nSize に素数を指定してください。

戻り値の型: BOOL

公式ドキュメント

ローカルアトムテーブルを初期化し、ハッシュバケットの数を指定したサイズに設定します。

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。

解説(Remarks)

アプリケーションがローカルアトムテーブルを使用するために、この関数を使用する必要はありません。使用される既定のハッシュバケット数は 37 です。ただし、アプリケーションが InitAtomTable を使用する場合は、他のアトム管理関数を呼び出す前にこの関数を呼び出す必要があります。

アプリケーションが多数のローカルアトムを使用する場合、テーブルのサイズを大きくすることで、ローカルアトムテーブルへのアトムの追加やテーブル内のアトムの検索に要する時間を短縮できます。ただし、これによりテーブルの保持に必要なメモリ量が増加します。

グローバルアトムテーブルのバケット数は変更できません。事前の InitAtomTable 呼び出しによって明示的に、またはアトム管理関数の使用によって暗黙的に、アトムテーブルが既に初期化されている場合、InitAtomTable はハッシュバケットの数を変更せずに成功を返します。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL InitAtomTable(
    DWORD nSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool InitAtomTable(
    uint nSize   // DWORD
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function InitAtomTable(
    nSize As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' nSize : DWORD
Declare PtrSafe Function InitAtomTable Lib "kernel32" ( _
    ByVal nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

InitAtomTable = ctypes.windll.kernel32.InitAtomTable
InitAtomTable.restype = wintypes.BOOL
InitAtomTable.argtypes = [
    wintypes.DWORD,  # nSize : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
InitAtomTable = Fiddle::Function.new(
  lib['InitAtomTable'],
  [
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn InitAtomTable(
        nSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool InitAtomTable(uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_InitAtomTable' -Namespace Win32 -PassThru
# $api::InitAtomTable(nSize)
#uselib "KERNEL32.dll"
#func global InitAtomTable "InitAtomTable" sptr
; InitAtomTable nSize   ; 戻り値は stat
; nSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global InitAtomTable "InitAtomTable" int
; res = InitAtomTable(nSize)
; nSize : DWORD -> "int"
; BOOL InitAtomTable(DWORD nSize)
#uselib "KERNEL32.dll"
#cfunc global InitAtomTable "InitAtomTable" int
; res = InitAtomTable(nSize)
; nSize : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procInitAtomTable = kernel32.NewProc("InitAtomTable")
)

// nSize (DWORD)
r1, _, err := procInitAtomTable.Call(
	uintptr(nSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InitAtomTable(
  nSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'InitAtomTable';
result := DllCall("KERNEL32\InitAtomTable"
    , "UInt", nSize   ; DWORD
    , "Int")   ; return: BOOL
●InitAtomTable(nSize) = DLL("KERNEL32.dll", "bool InitAtomTable(dword)")
# 呼び出し: InitAtomTable(nSize)
# nSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn InitAtomTable(
    nSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc InitAtomTable(
    nSize: uint32  # DWORD
): int32 {.importc: "InitAtomTable", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int InitAtomTable(
    uint nSize   // DWORD
);
ccall((:InitAtomTable, "KERNEL32.dll"), stdcall, Int32,
      (UInt32,),
      nSize)
# nSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t InitAtomTable(
    uint32_t nSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.InitAtomTable(nSize)
-- nSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const InitAtomTable = lib.func('__stdcall', 'InitAtomTable', 'int32_t', ['uint32_t']);
// InitAtomTable(nSize)
// nSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  InitAtomTable: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.InitAtomTable(nSize)
// nSize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InitAtomTable(
    uint32_t nSize);
C, "KERNEL32.dll");
// $ffi->InitAtomTable(nSize);
// nSize : DWORD
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean InitAtomTable(
        int nSize   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun InitAtomTable = InitAtomTable(
    nSize : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InitAtomTableNative = Int32 Function(Uint32);
typedef InitAtomTableDart = int Function(int);
final InitAtomTable = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<InitAtomTableNative, InitAtomTableDart>('InitAtomTable');
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InitAtomTable(
  nSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'InitAtomTable';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InitAtomTable"
  c_InitAtomTable :: Word32 -> IO CInt
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let initatomtable =
  foreign "InitAtomTable"
    (uint32_t @-> returning int32_t)
(* nSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("InitAtomTable" init-atom-table :convention :stdcall) :int32
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InitAtomTable = Win32::API::More->new('KERNEL32',
    'BOOL InitAtomTable(DWORD nSize)');
# my $ret = $InitAtomTable->Call($nSize);
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目