<Return[A]><Top>

AddAtom

Declare Function Api_AddAtom% Lib "kernel32" Alias "AddAtomA" (ByVal lpString$)

Declare Function AddAtom Lib "kernel32" Alias "AddAtomA" (ByVal lpString As String) As Integer

文字列をローカルアトムテーブルに追加し、その文字列を識別する一意の値(アトム)を返す。

パラメータ

lpString
    [入力]ローカルアトムテーブルに追加したい、NULL で終わる文字列へのポインタを指定する。

    文字列の長さは最大 255 バイトである。追加した文字列の大文字と小文字はそのまま格納されるが、文字列を比較する際に大文字と小

    文字を区別することはない。この文字列を取得するには、GetAtomName 関数を使う。
    代わりに、 マクロを使って整数アトムを変換し、得られた文字列を使うこともできる。

戻り値
    関数が成功すると、新しく作成されたアトムが返る。
    関数が失敗すると、0 が返る。拡張エラー情報を取得するには、 関数を使う。

解説
    AddAtom 関数は、指定された文字列をローカルアトムテーブルに格納するが、同じものを重複して格納することはない。指定された文字列

    が既にテーブル内に存在していた場合は、既存のアトムを返し、そのアトムの参照カウントをインクリメントする。
    "#1234" の形式で lpString を指定すると、AddAtom は整数アトムを返す。これは、文字列で指定された 10 進数を 16 ビット値で表現する

    ものである( この場合は、10 進の 1234 に相当する 0x04D2 になる)。0x0000 に相当する 10 進数や、0xC000 以上の 10 進数を指定

    した場合は、0 が返り、エラーが発生したことを示す。MAKEINTATOM マクロを使ってlpString を作成した場合は、下位ワード

    (low-order word)は必ず 0x0001〜0xBFFF の範囲にある。下位ワードがこの範囲にない場合、この関数は失敗する。
    これ以外の形式で lpString を指定すると、AddAtom は文字列アトムを返す。