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

DeleteAtom

関数
ローカルアトムテーブルのアトム参照カウントを減らし削除する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

WORD DeleteAtom(
    WORD nAtom
);

パラメーター

名前方向説明
nAtomWORDin削除するアトム。

戻り値の型: WORD

公式ドキュメント

ローカル文字列アトムの参照カウントをデクリメントします。アトムの参照カウントが 0 になった場合、DeleteAtom はそのアトムに関連付けられた文字列をローカルアトムテーブルから削除します。

戻り値

型: ATOM

関数が成功した場合、戻り値は 0 です。

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

解説(Remarks)

文字列アトムの参照カウントは、そのアトムがアトムテーブルに追加された回数を示します。AddAtom 関数は呼び出しごとにカウントをインクリメントします。DeleteAtom 関数は呼び出しごとにカウントをデクリメントしますが、アトムの参照カウントが 0 になった場合にのみ文字列を削除します。

AddAtom の各呼び出しには、対応する DeleteAtom の呼び出しが必要です。DeleteAtomAddAtom の呼び出し回数より多く呼び出さないでください。そうしないと、他のクライアントが使用している最中にアトムを削除してしまう可能性があります。

DeleteAtom 関数は、整数アトム(値が 0x0001 から 0xBFFF の範囲にあるアトム)には影響しません。整数アトムに対して、この関数は常に 0 を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

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

DeleteAtom = ctypes.windll.kernel32.DeleteAtom
DeleteAtom.restype = ctypes.c_ushort
DeleteAtom.argtypes = [
    ctypes.c_ushort,  # nAtom : WORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procDeleteAtom = kernel32.NewProc("DeleteAtom")
)

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

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

typedef DeleteAtomNative = Uint16 Function(Uint16);
typedef DeleteAtomDart = int Function(int);
final DeleteAtom = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<DeleteAtomNative, DeleteAtomDart>('DeleteAtom');
// nAtom : WORD -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeleteAtom(
  nAtom: Word   // WORD
): Word; stdcall;
  external 'KERNEL32.dll' name 'DeleteAtom';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

公式の関連項目