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

GlobalAddAtomA

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

シグネチャ

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

WORD GlobalAddAtomA(
    LPCSTR lpString   // optional
);

パラメーター

名前方向説明
lpStringLPCSTRinoptional

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

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

戻り値の型: WORD

公式ドキュメント

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

戻り値

型: ATOM

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

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

解説(Remarks)

その文字列がグローバルアトムテーブルに既に存在する場合、既存の文字列のアトムが返され、そのアトムの参照カウントがインクリメントされます。

アトムに関連付けられた文字列は、参照カウントが 0 になるまでメモリから削除されません。詳細は GlobalDeleteAtom 関数を参照してください。

グローバルアトムは、アプリケーションの終了時に自動的に削除されません。GlobalAddAtom 関数を呼び出すたびに、対応する GlobalDeleteAtom 関数の呼び出しが必要です。

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

lpString がそれ以外の形式の場合、GlobalAddAtom は文字列アトムを返します。

メモ

winbase.h ヘッダーは GlobalAddAtom を、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  (ANSI / -A)
#include <windows.h>

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGlobalAddAtomA = kernel32.NewProc("GlobalAddAtomA")
)

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

extern "kernel32" fn GlobalAddAtomA(
    lpString: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) u16;
proc GlobalAddAtomA(
    lpString: cstring  # LPCSTR optional
): uint16 {.importc: "GlobalAddAtomA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
ushort GlobalAddAtomA(
    const(char)* lpString   // LPCSTR optional
);
ccall((:GlobalAddAtomA, "KERNEL32.dll"), stdcall, UInt16,
      (Cstring,),
      lpString)
# lpString : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint16_t GlobalAddAtomA(
    const char* lpString);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GlobalAddAtomA(lpString)
-- lpString : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GlobalAddAtomA = lib.func('__stdcall', 'GlobalAddAtomA', 'uint16_t', ['str']);
// GlobalAddAtomA(lpString)
// lpString : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GlobalAddAtomA: { parameters: ["buffer"], result: "u16" },
});
// lib.symbols.GlobalAddAtomA(lpString)
// lpString : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint16_t GlobalAddAtomA(
    const char* lpString);
C, "KERNEL32.dll");
// $ffi->GlobalAddAtomA(lpString);
// lpString : LPCSTR 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.ASCII_OPTIONS);
    short GlobalAddAtomA(
        String lpString   // LPCSTR optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GlobalAddAtomA = GlobalAddAtomA(
    lpString : UInt8*   # LPCSTR optional
  ) : UInt16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("GlobalAddAtomA" global-add-atom-a :convention :stdcall) :uint16
  (lp-string :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GlobalAddAtomA = Win32::API::More->new('KERNEL32',
    'WORD GlobalAddAtomA(LPCSTR lpString)');
# my $ret = $GlobalAddAtomA->Call($lpString);
# lpString : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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