DeleteAtom

Declare Function Api_DeleteAtom% Lib "kernel32" Alias "DeleteAtom" (ByVal nAtom%)

Declare Function DeleteAtom Lib "kernel32" Alias "DeleteAtom" (ByVal nAtom As Integer) As Integer

ローカル文字列アトムの参照カウントをデクリメントする。参照カウントが 0 になったときは、アトムに関連付けられている文字列を、ローカルアトムテーブルから削除する。

パラメータ
nAtom
    ［入力］削除したい文字列アトムを指定する。

戻り値
    関数が成功すると、0 が返る。
    関数が失敗すると、nAtom パラメータで指定した値が返る。拡張エラー情報を取得するには、 関数を使う。

解説
    文字列アトムの参照カウントは、そのアトムがアトムテーブルに追加された回数を表す。AddAtom 関数を呼び出すたびに、この関数は参照

    カウントをインクリメントする。DeleteAtom 関数を呼び出すたびに、この関数は指定された文字列アトムの参照カウントをデクリメントし、参照

    カウントが 0 になった場合は、文字列をアトムテーブルから削除する。
    AddAtom を呼び出すたびに、最終的にはそれに対応する DeleteAtom を呼び出すべきである。AddAtom を呼び出した回数を超えて

    DeleteAtom を呼び出すことは避けること。もしそのような呼び出しを行うと、他のクライアントがまだアトムを使っている最中に、そのアトムを

    削除してしまう可能性がある。
    DeleteAtom 関数は、整数アトム（0x0001〜0xBFFF の範囲の値を取るアトム）に対しては機能しない。常に 0 を返す。