GlobalAddAtomW
関数シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
WORD GlobalAddAtomW(
LPCWSTR lpString // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpString | LPCWSTR | inoptional | 追加する null 終端文字列です。文字列の最大サイズは 255 バイトです。大文字と小文字のみが異なる文字列は同一とみなされます。この名前で最初にテーブルに追加された文字列の大文字小文字が保持され、GlobalGetAtomName 関数によって返されます。 あるいは、MAKEINTATOM マクロで変換した整数アトムを使用することもできます。詳細については「解説」を参照してください。 |
戻り値の型: WORD
公式ドキュメント
文字列をグローバル アトム テーブルに追加し、その文字列を識別する一意の値(アトム)を返します。(GlobalAddAtomW)
戻り値
解説(Remarks)
文字列が既にグローバル アトム テーブルに存在する場合は、既存の文字列に対するアトムが返され、そのアトムの参照カウントがインクリメントされます。
アトムに関連付けられた文字列は、参照カウントが 0 になるまでメモリから削除されません。詳細については、GlobalDeleteAtom 関数を参照してください。
グローバル アトムは、アプリケーションの終了時に自動的には削除されません。GlobalAddAtom 関数の呼び出しごとに、対応する GlobalDeleteAtom 関数の呼び出しが必要です。
lpString パラメーターが "#1234" の形式である場合、GlobalAddAtom は、文字列で指定された 10 進数の 16 ビット表現を値とする整数アトムを返します(この例では 0x04D2)。指定された 10 進値が 0x0000 であるか、0xC000 以上である場合、戻り値は 0 となり、エラーを示します。lpString が MAKEINTATOM マクロで作成された場合、下位ワードは 0x0001 から 0xBFFF の範囲でなければなりません。下位ワードがこの範囲にない場合、関数は失敗します。
lpString がそれ以外の形式である場合、GlobalAddAtom は文字列アトムを返します。
winbase.h ヘッダーは、GlobalAddAtom を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じ、コンパイル エラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
WORD GlobalAddAtomW(
LPCWSTR lpString // optional
);[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern ushort GlobalAddAtomW(
[MarshalAs(UnmanagedType.LPWStr)] string lpString // LPCWSTR optional
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GlobalAddAtomW(
<MarshalAs(UnmanagedType.LPWStr)> lpString As String ' LPCWSTR optional
) As UShort
End Function' lpString : LPCWSTR optional
Declare PtrSafe Function GlobalAddAtomW 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
GlobalAddAtomW = ctypes.windll.kernel32.GlobalAddAtomW
GlobalAddAtomW.restype = ctypes.c_ushort
GlobalAddAtomW.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')
GlobalAddAtomW = Fiddle::Function.new(
lib['GlobalAddAtomW'],
[
Fiddle::TYPE_VOIDP, # lpString : LPCWSTR optional
],
-Fiddle::TYPE_SHORT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn GlobalAddAtomW(
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 GlobalAddAtomW([MarshalAs(UnmanagedType.LPWStr)] string lpString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GlobalAddAtomW' -Namespace Win32 -PassThru
# $api::GlobalAddAtomW(lpString)#uselib "KERNEL32.dll"
#func global GlobalAddAtomW "GlobalAddAtomW" wptr
; GlobalAddAtomW lpString ; 戻り値は stat
; lpString : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global GlobalAddAtomW "GlobalAddAtomW" wstr
; res = GlobalAddAtomW(lpString)
; lpString : LPCWSTR optional -> "wstr"; WORD GlobalAddAtomW(LPCWSTR lpString)
#uselib "KERNEL32.dll"
#cfunc global GlobalAddAtomW "GlobalAddAtomW" wstr
; res = GlobalAddAtomW(lpString)
; lpString : LPCWSTR optional -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procGlobalAddAtomW = kernel32.NewProc("GlobalAddAtomW")
)
// lpString (LPCWSTR optional)
r1, _, err := procGlobalAddAtomW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WORDfunction GlobalAddAtomW(
lpString: PWideChar // LPCWSTR optional
): Word; stdcall;
external 'KERNEL32.dll' name 'GlobalAddAtomW';result := DllCall("KERNEL32\GlobalAddAtomW"
, "WStr", lpString ; LPCWSTR optional
, "UShort") ; return: WORD●GlobalAddAtomW(lpString) = DLL("KERNEL32.dll", "int GlobalAddAtomW(char*)")
# 呼び出し: GlobalAddAtomW(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 GlobalAddAtomW(
lpString: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc GlobalAddAtomW(
lpString: WideCString # LPCWSTR optional
): uint16 {.importc: "GlobalAddAtomW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
ushort GlobalAddAtomW(
const(wchar)* lpString // LPCWSTR optional
);ccall((:GlobalAddAtomW, "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 GlobalAddAtomW(
const uint16_t* lpString);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GlobalAddAtomW(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 GlobalAddAtomW = lib.func('__stdcall', 'GlobalAddAtomW', 'uint16_t', ['str16']);
// GlobalAddAtomW(lpString)
// lpString : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GlobalAddAtomW: { parameters: ["buffer"], result: "u16" },
});
// lib.symbols.GlobalAddAtomW(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 GlobalAddAtomW(
const uint16_t* lpString);
C, "KERNEL32.dll");
// $ffi->GlobalAddAtomW(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 GlobalAddAtomW(
WString lpString // LPCWSTR optional
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun GlobalAddAtomW = GlobalAddAtomW(
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 GlobalAddAtomWNative = Uint16 Function(Pointer<Utf16>);
typedef GlobalAddAtomWDart = int Function(Pointer<Utf16>);
final GlobalAddAtomW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GlobalAddAtomWNative, GlobalAddAtomWDart>('GlobalAddAtomW');
// lpString : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GlobalAddAtomW(
lpString: PWideChar // LPCWSTR optional
): Word; stdcall;
external 'KERNEL32.dll' name 'GlobalAddAtomW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GlobalAddAtomW"
c_GlobalAddAtomW :: CWString -> IO Word16
-- lpString : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let globaladdatomw =
foreign "GlobalAddAtomW"
((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 ("GlobalAddAtomW" global-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 $GlobalAddAtomW = Win32::API::More->new('KERNEL32',
'WORD GlobalAddAtomW(LPCWSTR lpString)');
# my $ret = $GlobalAddAtomW->Call($lpString);
# lpString : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f GlobalAddAtomA (ANSI版) — 文字列をグローバルアトムテーブルに追加しアトムを返す(ANSI)。
- f GlobalAddAtomExW — フラグ指定で文字列をグローバルアトムに追加する(Unicode)。
- f AddAtomW — 文字列をローカルアトムテーブルに追加しアトムを返す(Unicode)。
- f DeleteAtom — ローカルアトムテーブルのアトム参照カウントを減らし削除する。
- f FindAtomW — 指定文字列に対応するローカルアトムを検索する(Unicode)。
- f GetAtomNameW — ローカルアトムに関連付けられた文字列を取得する(Unicode)。
- f GlobalDeleteAtom — グローバルアトムテーブルのアトム参照カウントを減らし削除する。
- f GlobalFindAtomW — 指定文字列に対応するグローバルアトムを検索する(Unicode)。
- f GlobalGetAtomNameW — グローバルアトムに関連付けられた文字列を取得する(Unicode)。