GlobalAddAtomW 関数 (winbase.h)
グローバル atom テーブルに文字列を追加し、文字列を識別する一意の値 (atom) を返します。
構文
ATOM GlobalAddAtomW(
[in] LPCWSTR lpString
);
パラメーター
[in] lpString
型: LPCTSTR
追加する null で終わる文字列。 文字列の最大サイズは 255 バイトです。 大文字と小文字のみが異なる文字列は同一と見なされます。 テーブルに追加されたこの名前の最初の文字列の大文字と小文字は保持され、 GlobalGetAtomName 関数によって返されます。
または、 MAKEINTATOM マクロを使用して変換された整数原子を使用することもできます。 詳細については、「解説」を参照してください。
戻り値
種類: ATOM
関数が成功した場合、戻り値は新しく作成されたアトムです。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
グローバル atom テーブルに文字列が既に存在する場合は、既存の文字列の atom が返され、アトムの参照カウントがインクリメントされます。
atom に関連付けられている文字列は、参照カウントが 0 になるまでメモリから削除されません。 詳細については、「 GlobalDeleteAtom 関数」を参照してください。
グローバル原子は、アプリケーションが終了しても自動的には削除されません。 GlobalAddAtom 関数を呼び出すたびに、対応する GlobalDeleteAtom 関数の呼び出しが必要です。
lpString パラメーターの形式が "#1234" の場合、GlobalAddAtom は整数の atom を返します。この値は、文字列で指定された 10 進数の 16 ビット表現です (この例では0x04D2)。 指定した 10 進数の値が0x0000または0xC000以上の場合、戻り値は 0 であり、エラーを示します。 makeINTATOM マクロによって lpString が作成された場合、下位ワードは0xBFFF 0x0001範囲内にある必要があります。 下位ワードがこの範囲にない場合、関数は失敗します。
lpString に他の形式がある場合、GlobalAddAtom は文字列アトムを返します。
注意
winbase.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GlobalAddAtom を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winbase.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |
関連項目
参照