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

GlobalFindAtomW

関数
指定文字列に対応するグローバルアトムを検索する(Unicode)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

WORD GlobalFindAtomW(
    LPCWSTR lpString   // optional
);

パラメーター

名前方向説明
lpStringLPCWSTRinoptional

検索対象となる、null で終端された文字列。

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

戻り値の型: WORD

公式ドキュメント

指定した文字列をグローバルアトムテーブルから検索し、その文字列に関連付けられたグローバルアトムを取得します。(Unicode)

戻り値

型: ATOM

関数が成功した場合、戻り値は指定した文字列に関連付けられたグローバルアトムです。

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

解説(Remarks)

システムは、最初に入力されたとおりに文字列の大文字小文字をアトムテーブル内で保持しますが、GlobalFindAtom が実行する検索では大文字小文字は区別されません。

lpStringMAKEINTATOM マクロで作成された場合、下位ワードは 0x0001 から 0xBFFF の範囲内でなければなりません。下位ワードがこの範囲外の場合、関数は失敗します。

メモ

winbase.h ヘッダーは GlobalFindAtom を、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 GlobalFindAtomW(
    LPCWSTR lpString   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern ushort GlobalFindAtomW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpString   // LPCWSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GlobalFindAtomW(
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String   ' LPCWSTR optional
) As UShort
End Function
' lpString : LPCWSTR optional
Declare PtrSafe Function GlobalFindAtomW 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

GlobalFindAtomW = ctypes.windll.kernel32.GlobalFindAtomW
GlobalFindAtomW.restype = ctypes.c_ushort
GlobalFindAtomW.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')
GlobalFindAtomW = Fiddle::Function.new(
  lib['GlobalFindAtomW'],
  [
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR optional
  ],
  -Fiddle::TYPE_SHORT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GlobalFindAtomW(
        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 GlobalFindAtomW([MarshalAs(UnmanagedType.LPWStr)] string lpString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GlobalFindAtomW' -Namespace Win32 -PassThru
# $api::GlobalFindAtomW(lpString)
#uselib "KERNEL32.dll"
#func global GlobalFindAtomW "GlobalFindAtomW" wptr
; GlobalFindAtomW lpString   ; 戻り値は stat
; lpString : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GlobalFindAtomW "GlobalFindAtomW" wstr
; res = GlobalFindAtomW(lpString)
; lpString : LPCWSTR optional -> "wstr"
; WORD GlobalFindAtomW(LPCWSTR lpString)
#uselib "KERNEL32.dll"
#cfunc global GlobalFindAtomW "GlobalFindAtomW" wstr
; res = GlobalFindAtomW(lpString)
; lpString : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGlobalFindAtomW = kernel32.NewProc("GlobalFindAtomW")
)

// lpString (LPCWSTR optional)
r1, _, err := procGlobalFindAtomW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WORD
function GlobalFindAtomW(
  lpString: PWideChar   // LPCWSTR optional
): Word; stdcall;
  external 'KERNEL32.dll' name 'GlobalFindAtomW';
result := DllCall("KERNEL32\GlobalFindAtomW"
    , "WStr", lpString   ; LPCWSTR optional
    , "UShort")   ; return: WORD
●GlobalFindAtomW(lpString) = DLL("KERNEL32.dll", "int GlobalFindAtomW(char*)")
# 呼び出し: GlobalFindAtomW(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 GlobalFindAtomW(
    lpString: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GlobalFindAtomW(
    lpString: WideCString  # LPCWSTR optional
): uint16 {.importc: "GlobalFindAtomW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
ushort GlobalFindAtomW(
    const(wchar)* lpString   // LPCWSTR optional
);
ccall((:GlobalFindAtomW, "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 GlobalFindAtomW(
    const uint16_t* lpString);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GlobalFindAtomW(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 GlobalFindAtomW = lib.func('__stdcall', 'GlobalFindAtomW', 'uint16_t', ['str16']);
// GlobalFindAtomW(lpString)
// lpString : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GlobalFindAtomW: { parameters: ["buffer"], result: "u16" },
});
// lib.symbols.GlobalFindAtomW(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 GlobalFindAtomW(
    const uint16_t* lpString);
C, "KERNEL32.dll");
// $ffi->GlobalFindAtomW(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 GlobalFindAtomW(
        WString lpString   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GlobalFindAtomW = GlobalFindAtomW(
    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 GlobalFindAtomWNative = Uint16 Function(Pointer<Utf16>);
typedef GlobalFindAtomWDart = int Function(Pointer<Utf16>);
final GlobalFindAtomW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GlobalFindAtomWNative, GlobalFindAtomWDart>('GlobalFindAtomW');
// lpString : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GlobalFindAtomW(
  lpString: PWideChar   // LPCWSTR optional
): Word; stdcall;
  external 'KERNEL32.dll' name 'GlobalFindAtomW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let globalfindatomw =
  foreign "GlobalFindAtomW"
    ((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 ("GlobalFindAtomW" global-find-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 $GlobalFindAtomW = Win32::API::More->new('KERNEL32',
    'WORD GlobalFindAtomW(LPCWSTR lpString)');
# my $ret = $GlobalFindAtomW->Call($lpString);
# lpString : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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