ホーム › System.DataExchange › GlobalGetAtomNameW

GlobalGetAtomNameW

関数

グローバルアトムに関連付けられた文字列を取得する(Unicode)。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

DWORD GlobalGetAtomNameW(
    WORD nAtom,
    LPWSTR lpBuffer,
    INT nSize
);

パラメーター

名前	型	方向	説明
nAtom	WORD	in	取得する文字列に関連付けられたグローバルアトム。
lpBuffer	LPWSTR	out	文字列を格納するバッファー。
nSize	INT	in	バッファーのサイズ(文字数単位)。

戻り値の型: DWORD

公式ドキュメント

指定したグローバルアトムに関連付けられた文字列のコピーを取得します。(Unicode)

戻り値

型: UINT

関数が成功した場合、戻り値はバッファーにコピーされた文字列の長さ(終端の null 文字を含まない文字数)です。

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

解説(Remarks)

整数アトム(値が 0x0001 から 0xBFFF の範囲にあるアトム)に対して返される文字列は、最初の文字がシャープ記号(#)で、残りの文字が符号なし整数のアトム値を表す null 終端文字列です。

セキュリティに関する考慮事項

この関数を誤って使用すると、プログラムのセキュリティが損なわれる可能性があります。誤った使用には、lpBuffer パラメーターのサイズを正しく指定しないことが含まれます。また、グローバルアトムは誰からでもアクセス可能であるため、その内容のプライバシーや整合性は保証されない点に注意してください。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GlobalGetAtomName を定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因になることがあります。詳細については、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>

DWORD GlobalGetAtomNameW(
    WORD nAtom,
    LPWSTR lpBuffer,
    INT nSize
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GlobalGetAtomNameW(
    ushort nAtom,   // WORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer,   // LPWSTR out
    int nSize   // INT
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GlobalGetAtomNameW(
    nAtom As UShort,   ' WORD
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder,   ' LPWSTR out
    nSize As Integer   ' INT
) As UInteger
End Function

' nAtom : WORD
' lpBuffer : LPWSTR out
' nSize : INT
Declare PtrSafe Function GlobalGetAtomNameW Lib "kernel32" ( _
    ByVal nAtom As Integer, _
    ByVal lpBuffer As LongPtr, _
    ByVal nSize As Long) As Long
' 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

GlobalGetAtomNameW = ctypes.windll.kernel32.GlobalGetAtomNameW
GlobalGetAtomNameW.restype = wintypes.DWORD
GlobalGetAtomNameW.argtypes = [
    ctypes.c_ushort,  # nAtom : WORD
    wintypes.LPWSTR,  # lpBuffer : LPWSTR out
    ctypes.c_int,  # nSize : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GlobalGetAtomNameW = Fiddle::Function.new(
  lib['GlobalGetAtomNameW'],
  [
    -Fiddle::TYPE_SHORT,  # nAtom : WORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR out
    Fiddle::TYPE_INT,  # nSize : INT
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GlobalGetAtomNameW(
        nAtom: u16,  // WORD
        lpBuffer: *mut u16,  // LPWSTR out
        nSize: i32  // INT
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GlobalGetAtomNameW(ushort nAtom, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, int nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GlobalGetAtomNameW' -Namespace Win32 -PassThru
# $api::GlobalGetAtomNameW(nAtom, lpBuffer, nSize)

#uselib "KERNEL32.dll"
#func global GlobalGetAtomNameW "GlobalGetAtomNameW" wptr, wptr, wptr
; GlobalGetAtomNameW nAtom, varptr(lpBuffer), nSize   ; 戻り値は stat
; nAtom : WORD -> "wptr"
; lpBuffer : LPWSTR out -> "wptr"
; nSize : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GlobalGetAtomNameW "GlobalGetAtomNameW" int, var, int
; res = GlobalGetAtomNameW(nAtom, lpBuffer, nSize)
; nAtom : WORD -> "int"
; lpBuffer : LPWSTR out -> "var"
; nSize : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GlobalGetAtomNameW "GlobalGetAtomNameW" int, sptr, int
; res = GlobalGetAtomNameW(nAtom, varptr(lpBuffer), nSize)
; nAtom : WORD -> "int"
; lpBuffer : LPWSTR out -> "sptr"
; nSize : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。