SetWindowLongPtrW 関数 (winuser.h)

[アーティクル]
07/21/2023

指定したウィンドウの属性を変更します。関数は、余分なウィンドウメモリ内の指定されたオフセットに値を設定します。

メモ 32 ビットバージョンと 64 ビットバージョンの両方の Windows と互換性のあるコードを記述するには、 SetWindowLongPtr を使用します。 32 ビット Windows 用にコンパイルする場合、 SetWindowLongPtr は SetWindowLong 関数の呼び出しとして定義されます。

構文

LONG_PTR SetWindowLongPtrW(
  [in] HWND     hWnd,
  [in] int      nIndex,
  [in] LONG_PTR dwNewLong
);

パラメーター

[in] hWnd

型: HWND

ウィンドウへのハンドルと、ウィンドウが属するクラスを間接的に指定します。 hWnd パラメーターで指定されたウィンドウを所有するプロセスが、呼び出し元スレッドが存在するプロセスよりも UIPI 階層のプロセス特権が高い場合、SetWindowLongPtr 関数は失敗します。

Windows XP/2000: hWnd パラメーターで指定されたウィンドウが呼び出し元のスレッドと同じプロセスに属していない場合、SetWindowLongPtr 関数は失敗します。

[in] nIndex

型: int

設定する値への 0 から始まるオフセット。有効な値は、余分なウィンドウメモリのバイト数からLONG_PTRのサイズを差し引いた範囲の 0 です。その他の値を設定するには、次のいずれかの値を指定します。

値	意味
GWL_EXSTYLE -20	新しい拡張ウィンドウスタイルを設定します。
GWLP_HINSTANCE -6	新しいアプリケーションインスタンスハンドルを設定します。
GWLP_ID -12	子ウィンドウの新しい識別子を設定します。ウィンドウを最上位のウィンドウにすることはできません。
GWL_STYLE -16	新しいウィンドウスタイルを設定します。
GWLP_USERDATA -21	ウィンドウに関連付けられているユーザーデータを設定します。このデータは、ウィンドウを作成したアプリケーションで使用するためのものです。その値は、最初は 0 です。
GWLP_WNDPROC -4	ウィンドウプロシージャの新しいアドレスを設定します。

hWnd パラメーターがダイアログボックスを識別する場合は、次の値も使用できます。

値	意味
DWLP_DLGPROC DWLP_MSGRESULT + sizeof(LRESULT)	ダイアログボックスプロシージャへの新しいポインターを設定します。
DWLP_MSGRESULT 0	ダイアログボックスプロシージャで処理されるメッセージの戻り値を設定します。
DWLP_USER DWLP_DLGPROC + sizeof(DLGPROC)	ハンドルやポインターなど、アプリケーションにプライベートな新しい追加情報を設定します。

[in] dwNewLong

種類: LONG_PTR

置換値。

戻り値

種類: LONG_PTR

関数が成功した場合、戻り値は指定されたオフセットの前の値になります。

関数が失敗した場合は、0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。

前の値が 0 で、関数が成功した場合、戻り値は 0 ですが、関数は最後のエラー情報をクリアしません。成功または失敗を判断するには、 SetLastError を 0 で呼び出して最後のエラー情報をクリアしてから、 SetWindowLongPtr を呼び出します。関数の失敗は、戻り値が 0 で、 GetLastError の結果が 0 以外で示されます。

注釈

特定のウィンドウデータがキャッシュされるため、 SetWindowLongPtr を 使用して行った変更は、SetWindowPos 関数を呼び出すまで有効になりません。

SetWindowLongPtr を GWLP_WNDPROC インデックスと共に使用してウィンドウプロシージャを置き換える場合、ウィンドウプロシージャは WindowProc コールバック関数の説明で指定されたガイドラインに準拠している必要があります。

SetWindowLongPtr を DWLP_MSGRESULT インデックスと共に使用して、ダイアログボックスプロシージャによって処理されるメッセージの戻り値を設定する場合、ダイアログボックスプロシージャは、その直後に TRUE を返す必要があります。それ以外の場合、ダイアログボックスプロシージャでウィンドウメッセージを受信する関数を呼び出すと、入れ子になったウィンドウメッセージによって、 DWLP_MSGRESULTを使用して設定した戻り値が上書きされる可能性があります。

GWLP_WNDPROC インデックスを使用して SetWindowLongPtr を呼び出すと、ウィンドウの作成に使用されるウィンドウクラスのサブクラスが作成されます。アプリケーションはシステムクラスをサブクラス化できますが、別のプロセスによって作成されたウィンドウクラスをサブクラス化することはできません。 SetWindowLongPtr 関数は、特定のウィンドウクラスに関連付けられているウィンドウプロシージャを変更してウィンドウサブクラスを作成し、システムが前のウィンドウプロシージャではなく新しいウィンドウプロシージャを呼び出します。アプリケーションは、CallWindowProc を呼び出して、新しいウィンドウプロシージャによって処理されないメッセージを前のウィンドウプロシージャに渡す必要があります。これにより、アプリケーションはウィンドウプロシージャのチェーンを作成できます。

RegisterClassEx 関数で使用される WNDCLASSEX 構造体の cbWndExtra メンバーに 0 以外の値を指定して、追加のウィンドウメモリを予約します。

GWLP_HWNDPARENT インデックスを使用して SetWindowLongPtr を呼び出して、子ウィンドウの親を変更しないでください。代わりに、 SetParent 関数を使用します。

ウィンドウのクラススタイルが CS_CLASSDC または CS_PARENTDC の場合は、拡張ウィンドウスタイル をWS_EX_COMPOSITED または WS_EX_LAYEREDに設定しないでください。

SetWindowLongPtr を呼び出して進行状況バーのスタイルを設定すると、その位置がリセットされます。

注意

winuser.h ヘッダーは、SetWindowLongPtr をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイルエラーまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	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-0 (Windows 8 で導入)