ホーム › System.DataExchange › GetAtomNameA

GetAtomNameA

関数

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

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

シグネチャ

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

DWORD GetAtomNameA(
    WORD nAtom,
    LPSTR lpBuffer,
    INT nSize
);

パラメーター

名前	型	方向	説明
nAtom	WORD	in	取得する文字列を識別するローカルアトム。
lpBuffer	LPSTR	out	文字列。
nSize	INT	in	バッファーのサイズ(文字数単位)。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

型: UINT

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

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

解説(Remarks)

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

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

この関数を誤って使用すると、プログラムのセキュリティが損なわれるおそれがあります。誤った使用には、lpBuffer パラメーターのサイズを正しく指定しないことが含まれます。

メモ

winbase.h ヘッダーは GetAtomName を、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>

DWORD GetAtomNameA(
    WORD nAtom,
    LPSTR lpBuffer,
    INT nSize
);

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

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

' nAtom : WORD
' lpBuffer : LPSTR out
' nSize : INT
Declare PtrSafe Function GetAtomNameA Lib "kernel32" ( _
    ByVal nAtom As Integer, _
    ByVal lpBuffer As String, _
    ByVal nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetAtomNameA = ctypes.windll.kernel32.GetAtomNameA
GetAtomNameA.restype = wintypes.DWORD
GetAtomNameA.argtypes = [
    ctypes.c_ushort,  # nAtom : WORD
    wintypes.LPSTR,  # lpBuffer : LPSTR 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')
GetAtomNameA = Fiddle::Function.new(
  lib['GetAtomNameA'],
  [
    -Fiddle::TYPE_SHORT,  # nAtom : WORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPSTR out
    Fiddle::TYPE_INT,  # nSize : INT
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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