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

AddAtomW

関数
文字列をローカルアトムテーブルに追加しアトムを返す(Unicode)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

WORD AddAtomW(
    LPCWSTR lpString   // optional
);

パラメーター

名前方向説明
lpStringLPCWSTRinoptional

追加する null 終端文字列。文字列の最大サイズは 255 バイトです。大文字・小文字の違いのみの文字列は同一とみなされます。最初に追加された文字列の大文字・小文字はそのまま保持され、GetAtomName 関数によって返されます。

また、MAKEINTATOM マクロを使用して変換した整数アトムを指定することもできます。詳細については「解説」を参照してください。

戻り値の型: WORD

公式ドキュメント

文字列をローカルアトムテーブルに追加し、その文字列を識別する一意の値(アトム)を返します。(Unicode)

戻り値

型: ATOM

関数が成功した場合、戻り値は新しく作成されたアトムです。

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

解説(Remarks)

AddAtom 関数は、指定された文字列のコピーをアトムテーブルに 1 つだけ格納します。文字列が既にテーブルに存在する場合、関数は既存のアトムを返し、文字列アトムの場合はその文字列の参照カウントをインクリメントします。

lpString が "#1234" の形式である場合、AddAtom は、文字列で指定された 10 進数の 16 ビット表現(この例では 0x04D2)を値とする整数アトムを返します。指定された 10 進値が 0x0000 であるか、0xC000 以上である場合、戻り値は 0 となり、エラーを示します。lpStringMAKEINTATOM マクロによって作成された場合、下位ワードは 0x0001 から 0xBFFF の範囲でなければなりません。下位ワードがこの範囲にない場合、関数は失敗します。

lpString がその他の形式である場合、AddAtom は文字列アトムを返します。

メモ

winbase.h ヘッダーは AddAtom を、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)

各言語での呼び出し定義

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

WORD AddAtomW(
    LPCWSTR lpString   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern ushort AddAtomW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpString   // LPCWSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddAtomW(
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String   ' LPCWSTR optional
) As UShort
End Function
' lpString : LPCWSTR optional
Declare PtrSafe Function AddAtomW Lib "kernel32" ( _
    ByVal lpString As LongPtr) As Integer
' 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

AddAtomW = ctypes.windll.kernel32.AddAtomW
AddAtomW.restype = ctypes.c_ushort
AddAtomW.argtypes = [
    wintypes.LPCWSTR,  # lpString : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
AddAtomW = Fiddle::Function.new(
  lib['AddAtomW'],
  [
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR optional
  ],
  -Fiddle::TYPE_SHORT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn AddAtomW(
        lpString: *const u16  // LPCWSTR optional
    ) -> u16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern ushort AddAtomW([MarshalAs(UnmanagedType.LPWStr)] string lpString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_AddAtomW' -Namespace Win32 -PassThru
# $api::AddAtomW(lpString)
#uselib "KERNEL32.dll"
#func global AddAtomW "AddAtomW" wptr
; AddAtomW lpString   ; 戻り値は stat
; lpString : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global AddAtomW "AddAtomW" wstr
; res = AddAtomW(lpString)
; lpString : LPCWSTR optional -> "wstr"
; WORD AddAtomW(LPCWSTR lpString)
#uselib "KERNEL32.dll"
#cfunc global AddAtomW "AddAtomW" wstr
; res = AddAtomW(lpString)
; lpString : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procAddAtomW = kernel32.NewProc("AddAtomW")
)

// lpString (LPCWSTR optional)
r1, _, err := procAddAtomW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WORD
function AddAtomW(
  lpString: PWideChar   // LPCWSTR optional
): Word; stdcall;
  external 'KERNEL32.dll' name 'AddAtomW';
result := DllCall("KERNEL32\AddAtomW"
    , "WStr", lpString   ; LPCWSTR optional
    , "UShort")   ; return: WORD
●AddAtomW(lpString) = DLL("KERNEL32.dll", "int AddAtomW(char*)")
# 呼び出し: AddAtomW(lpString)
# lpString : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn AddAtomW(
    lpString: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc AddAtomW(
    lpString: WideCString  # LPCWSTR optional
): uint16 {.importc: "AddAtomW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
ushort AddAtomW(
    const(wchar)* lpString   // LPCWSTR optional
);
ccall((:AddAtomW, "KERNEL32.dll"), stdcall, UInt16,
      (Cwstring,),
      lpString)
# lpString : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint16_t AddAtomW(
    const uint16_t* lpString);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.AddAtomW(lpString)
-- lpString : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const AddAtomW = lib.func('__stdcall', 'AddAtomW', 'uint16_t', ['str16']);
// AddAtomW(lpString)
// lpString : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  AddAtomW: { parameters: ["buffer"], result: "u16" },
});
// lib.symbols.AddAtomW(lpString)
// lpString : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint16_t AddAtomW(
    const uint16_t* lpString);
C, "KERNEL32.dll");
// $ffi->AddAtomW(lpString);
// lpString : LPCWSTR optional
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    short AddAtomW(
        WString lpString   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun AddAtomW = AddAtomW(
    lpString : UInt16*   # LPCWSTR optional
  ) : UInt16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef AddAtomWNative = Uint16 Function(Pointer<Utf16>);
typedef AddAtomWDart = int Function(Pointer<Utf16>);
final AddAtomW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<AddAtomWNative, AddAtomWDart>('AddAtomW');
// lpString : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AddAtomW(
  lpString: PWideChar   // LPCWSTR optional
): Word; stdcall;
  external 'KERNEL32.dll' name 'AddAtomW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AddAtomW"
  c_AddAtomW :: CWString -> IO Word16
-- lpString : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let addatomw =
  foreign "AddAtomW"
    ((ptr uint16_t) @-> returning uint16_t)
(* lpString : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("AddAtomW" add-atom-w :convention :stdcall) :uint16
  (lp-string (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AddAtomW = Win32::API::More->new('KERNEL32',
    'WORD AddAtomW(LPCWSTR lpString)');
# my $ret = $AddAtomW->Call($lpString);
# lpString : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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