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

GlobalAddAtomExW

関数
フラグ指定で文字列をグローバルアトムに追加する(Unicode)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

WORD GlobalAddAtomExW(
    LPCWSTR lpString,   // optional
    DWORD Flags
);

パラメーター

名前方向説明
lpStringLPCWSTRinoptional

追加する null 終端文字列です。文字列の最大サイズは 255 バイトです。大文字と小文字のみが異なる文字列は同一とみなされます。この名前で最初にテーブルに追加された文字列の大文字・小文字の区別が保持され、GlobalGetAtomName 関数によって返されます。

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

FlagsDWORDin追加動作を制御するフラグ。大文字小文字を区別するならGA_NOFLAGS以外を指定。

戻り値の型: WORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

メモ

winbase.h ヘッダーは GlobalAddAtomEx をエイリアスとして定義しており、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 GlobalAddAtomExW(
    LPCWSTR lpString,   // optional
    DWORD Flags
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern ushort GlobalAddAtomExW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpString,   // LPCWSTR optional
    uint Flags   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GlobalAddAtomExW(
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String,   ' LPCWSTR optional
    Flags As UInteger   ' DWORD
) As UShort
End Function
' lpString : LPCWSTR optional
' Flags : DWORD
Declare PtrSafe Function GlobalAddAtomExW Lib "kernel32" ( _
    ByVal lpString As LongPtr, _
    ByVal Flags As Long) 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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGlobalAddAtomExW = kernel32.NewProc("GlobalAddAtomExW")
)

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

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

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

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

let globaladdatomexw =
  foreign "GlobalAddAtomExW"
    ((ptr uint16_t) @-> uint32_t @-> returning uint16_t)
(* lpString : LPCWSTR optional -> (ptr uint16_t) *)
(* Flags : 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 ("GlobalAddAtomExW" global-add-atom-ex-w :convention :stdcall) :uint16
  (lp-string (:string :encoding :utf-16le))   ; LPCWSTR optional
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GlobalAddAtomExW = Win32::API::More->new('KERNEL32',
    'WORD GlobalAddAtomExW(LPCWSTR lpString, DWORD Flags)');
# my $ret = $GlobalAddAtomExW->Call($lpString, $Flags);
# lpString : LPCWSTR optional -> LPCWSTR
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API