ホーム › System.DataExchange › GlobalAddAtomExA
GlobalAddAtomExA
関数フラグ指定で文字列をグローバルアトムに追加する(ANSI)。
シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
WORD GlobalAddAtomExA(
LPCSTR lpString, // optional
DWORD Flags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpString | LPCSTR | inoptional | 追加する null 終端文字列です。文字列の最大サイズは 255 バイトです。大文字と小文字のみが異なる文字列は同一とみなされます。この名前としてテーブルに最初に追加された文字列の大文字小文字が保持され、GlobalGetAtomName 関数によって返されます。 あるいは、MAKEINTATOM マクロで変換した整数アトムを使用することもできます。詳細については「解説」を参照してください。 |
| Flags | DWORD | in | 追加動作を制御するフラグ。大文字小文字を区別するならGA_NOFLAGS以外を指定。 |
戻り値の型: WORD
公式ドキュメント
文字列をグローバルアトムテーブルに追加し、その文字列を識別する一意の値(アトム)を返します。(GlobalAddAtomExA)
戻り値
関数が成功した場合、戻り値は新しく作成されたアトムです。
関数が失敗した場合、戻り値は 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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
WORD GlobalAddAtomExA(
LPCSTR lpString, // optional
DWORD Flags
);[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern ushort GlobalAddAtomExA(
[MarshalAs(UnmanagedType.LPStr)] string lpString, // LPCSTR optional
uint Flags // DWORD
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GlobalAddAtomExA(
<MarshalAs(UnmanagedType.LPStr)> lpString As String, ' LPCSTR optional
Flags As UInteger ' DWORD
) As UShort
End Function' lpString : LPCSTR optional
' Flags : DWORD
Declare PtrSafe Function GlobalAddAtomExA Lib "kernel32" ( _
ByVal lpString As String, _
ByVal Flags As Long) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GlobalAddAtomExA = ctypes.windll.kernel32.GlobalAddAtomExA
GlobalAddAtomExA.restype = ctypes.c_ushort
GlobalAddAtomExA.argtypes = [
wintypes.LPCSTR, # lpString : LPCSTR 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')
GlobalAddAtomExA = Fiddle::Function.new(
lib['GlobalAddAtomExA'],
[
Fiddle::TYPE_VOIDP, # lpString : LPCSTR optional
-Fiddle::TYPE_INT, # Flags : DWORD
],
-Fiddle::TYPE_SHORT)#[link(name = "kernel32")]
extern "system" {
fn GlobalAddAtomExA(
lpString: *const u8, // LPCSTR optional
Flags: u32 // DWORD
) -> u16;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern ushort GlobalAddAtomExA([MarshalAs(UnmanagedType.LPStr)] string lpString, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GlobalAddAtomExA' -Namespace Win32 -PassThru
# $api::GlobalAddAtomExA(lpString, Flags)#uselib "KERNEL32.dll"
#func global GlobalAddAtomExA "GlobalAddAtomExA" sptr, sptr
; GlobalAddAtomExA lpString, Flags ; 戻り値は stat
; lpString : LPCSTR optional -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global GlobalAddAtomExA "GlobalAddAtomExA" str, int
; res = GlobalAddAtomExA(lpString, Flags)
; lpString : LPCSTR optional -> "str"
; Flags : DWORD -> "int"; WORD GlobalAddAtomExA(LPCSTR lpString, DWORD Flags)
#uselib "KERNEL32.dll"
#cfunc global GlobalAddAtomExA "GlobalAddAtomExA" str, int
; res = GlobalAddAtomExA(lpString, Flags)
; lpString : LPCSTR optional -> "str"
; Flags : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procGlobalAddAtomExA = kernel32.NewProc("GlobalAddAtomExA")
)
// lpString (LPCSTR optional), Flags (DWORD)
r1, _, err := procGlobalAddAtomExA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpString))),
uintptr(Flags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WORDfunction GlobalAddAtomExA(
lpString: PAnsiChar; // LPCSTR optional
Flags: DWORD // DWORD
): Word; stdcall;
external 'KERNEL32.dll' name 'GlobalAddAtomExA';result := DllCall("KERNEL32\GlobalAddAtomExA"
, "AStr", lpString ; LPCSTR optional
, "UInt", Flags ; DWORD
, "UShort") ; return: WORD●GlobalAddAtomExA(lpString, Flags) = DLL("KERNEL32.dll", "int GlobalAddAtomExA(char*, dword)")
# 呼び出し: GlobalAddAtomExA(lpString, Flags)
# lpString : LPCSTR optional -> "char*"
# Flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn GlobalAddAtomExA(
lpString: [*c]const u8, // LPCSTR optional
Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u16;proc GlobalAddAtomExA(
lpString: cstring, # LPCSTR optional
Flags: uint32 # DWORD
): uint16 {.importc: "GlobalAddAtomExA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
ushort GlobalAddAtomExA(
const(char)* lpString, // LPCSTR optional
uint Flags // DWORD
);ccall((:GlobalAddAtomExA, "KERNEL32.dll"), stdcall, UInt16,
(Cstring, UInt32),
lpString, Flags)
# lpString : LPCSTR optional -> Cstring
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint16_t GlobalAddAtomExA(
const char* lpString,
uint32_t Flags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GlobalAddAtomExA(lpString, Flags)
-- lpString : LPCSTR optional
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GlobalAddAtomExA = lib.func('__stdcall', 'GlobalAddAtomExA', 'uint16_t', ['str', 'uint32_t']);
// GlobalAddAtomExA(lpString, Flags)
// lpString : LPCSTR optional -> 'str'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GlobalAddAtomExA: { parameters: ["buffer", "u32"], result: "u16" },
});
// lib.symbols.GlobalAddAtomExA(lpString, Flags)
// lpString : LPCSTR optional -> "buffer"
// Flags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint16_t GlobalAddAtomExA(
const char* lpString,
uint32_t Flags);
C, "KERNEL32.dll");
// $ffi->GlobalAddAtomExA(lpString, Flags);
// lpString : LPCSTR 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.ASCII_OPTIONS);
short GlobalAddAtomExA(
String lpString, // LPCSTR optional
int Flags // DWORD
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GlobalAddAtomExA = GlobalAddAtomExA(
lpString : UInt8*, # LPCSTR 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 GlobalAddAtomExANative = Uint16 Function(Pointer<Utf8>, Uint32);
typedef GlobalAddAtomExADart = int Function(Pointer<Utf8>, int);
final GlobalAddAtomExA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GlobalAddAtomExANative, GlobalAddAtomExADart>('GlobalAddAtomExA');
// lpString : LPCSTR optional -> Pointer<Utf8>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GlobalAddAtomExA(
lpString: PAnsiChar; // LPCSTR optional
Flags: DWORD // DWORD
): Word; stdcall;
external 'KERNEL32.dll' name 'GlobalAddAtomExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GlobalAddAtomExA"
c_GlobalAddAtomExA :: CString -> Word32 -> IO Word16
-- lpString : LPCSTR optional -> CString
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let globaladdatomexa =
foreign "GlobalAddAtomExA"
(string @-> uint32_t @-> returning uint16_t)
(* lpString : LPCSTR optional -> string *)
(* 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 ("GlobalAddAtomExA" global-add-atom-ex-a :convention :stdcall) :uint16
(lp-string :string) ; LPCSTR optional
(flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GlobalAddAtomExA = Win32::API::More->new('KERNEL32',
'WORD GlobalAddAtomExA(LPCSTR lpString, DWORD Flags)');
# my $ret = $GlobalAddAtomExA->Call($lpString, $Flags);
# lpString : LPCSTR optional -> LPCSTR
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f GlobalAddAtomExW (Unicode版) — フラグ指定で文字列をグローバルアトムに追加する(Unicode)。
類似 API
- f GlobalAddAtomA — 文字列をグローバルアトムテーブルに追加しアトムを返す(ANSI)。