SetClassLongPtrA 関数 (winuser.h)
指定したウィンドウが属するクラスの、追加のクラス メモリまたは WNDCLASSEX 構造体内の指定したオフセットにある指定した値を置き換えます。
構文
ULONG_PTR SetClassLongPtrA(
[in] HWND hWnd,
[in] int nIndex,
[in] LONG_PTR dwNewLong
);
パラメーター
[in] hWnd
型: HWND
ウィンドウへのハンドルと、ウィンドウが属するクラスを間接的に指定します。
[in] nIndex
型: int
置き換える値。 追加のクラス メモリに値を設定するには、設定する値の正の 0 から始まるバイト オフセットを指定します。 有効な値は、余分なクラス メモリのバイト数から 8 を引いた範囲の 0 です。たとえば、24 バイト以上の余分なクラス メモリを指定した場合、値 16 は 3 番目の整数のインデックスになります。 WNDCLASSEX 構造体以外の値を設定するには、次のいずれかの値を指定します。
| 値 | 意味 |
|---|---|
|
クラスに関連付けられている余分なメモリのサイズをバイト単位で設定します。 この値を設定しても、既に割り当てられている余分なバイト数は変更されません。 |
|
クラス内の各ウィンドウに関連付けられている追加のウィンドウ メモリのサイズをバイト単位で設定します。 この値を設定しても、既に割り当てられている余分なバイト数は変更されません。 このメモリにアクセスする方法については、「 SetWindowLongPtr」を参照してください。 |
|
クラスに関連付けられている背景ブラシへのハンドルを置き換えます。 |
|
クラスに関連付けられているカーソルへのハンドルを置き換えます。 |
|
ハンドルを、 クラスに関連付けられているアイコンに置き換えます。 |
|
クラスに関連付けられている小さなアイコンへのハンドルを取得します。 |
|
クラスを登録したモジュールのハンドルを置き換えます。 |
|
メニュー名文字列へのポインターを置き換えます。 文字列は、 クラスに関連付けられているメニュー リソースを識別します。 |
|
ウィンドウ クラス スタイルのビットを置き換えます。 |
|
クラスに関連付けられているウィンドウ プロシージャへのポインターを置き換えます。 |
[in] dwNewLong
種類: LONG_PTR
置換値。
戻り値
種類: ULONG_PTR
関数が成功した場合、戻り値は指定したオフセットの前の値になります。 これが以前に設定されていない場合、戻り値は 0 です。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
SetClassLongPtr 関数とGCLP_WNDPROC インデックスを使用してウィンドウ プロシージャを置き換える場合、ウィンドウ プロシージャは WindowProc コールバック関数の説明で指定されているガイドラインに準拠している必要があります。
GCLP_WNDPROC インデックスで SetClassLongPtr を呼び出すと、その後 クラスで作成されたすべてのウィンドウに影響を与えるウィンドウ クラスのサブクラスが作成されます。 アプリケーションはシステム クラスをサブクラス化できますが、別のプロセスによって作成されたウィンドウ クラスをサブクラス化することはできません。
RegisterClassEx 関数で使用される WNDCLASSEX 構造体の cbClsExtra メンバーに 0 以外の値を指定して、追加のクラス メモリを予約します。
SetClassLongPtr 関数は注意して使用してください。 たとえば、 SetClassLongPtr を使用してクラスの背景色を変更することはできますが、この変更によって、 クラスに属するすべてのウィンドウがすぐに再描画されるわけではありません。
注意
winuser.h ヘッダーは、SetClassLongPtr をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winuser.h (Windows.h を含む) |
| Library | User32.lib |
| [DLL] | User32.dll |
| API セット | ext-ms-win-ntuser-windowclass-l1-1-2 (Windows 10 バージョン 10.0.10240 で導入) |
関連項目
概念
参照