SetWindowLongA 関数 (winuser.h)

[アーティクル]
03/15/2023

指定したウィンドウの属性を変更します。また、関数は、指定したオフセットの 32 ビット (long) 値を追加のウィンドウメモリに設定します。

メモこの関数は SetWindowLongPtr 関数に置き換わりました。 32 ビットバージョンと 64 ビットバージョンの両方の Windows と互換性のあるコードを記述するには、 SetWindowLongPtr 関数を使用します。

構文

LONG SetWindowLongA(
  [in] HWND hWnd,
  [in] int  nIndex,
  [in] LONG dwNewLong
);

パラメーター

[in] hWnd

型: HWND

ウィンドウへのハンドルと、ウィンドウが属するクラスを間接的に指定します。

[in] nIndex

型: int

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

値	意味
GWL_EXSTYLE -20	新しい拡張ウィンドウスタイルを設定します。
GWL_HINSTANCE -6	新しいアプリケーションインスタンスハンドルを設定します。
GWL_ID -12	子ウィンドウの新しい識別子を設定します。ウィンドウを最上位のウィンドウにすることはできません。
GWL_STYLE -16	新しいウィンドウスタイルを設定します。
GWL_USERDATA -21	ウィンドウに関連付けられているユーザーデータを設定します。このデータは、ウィンドウを作成したアプリケーションで使用するためのものです。その値は、最初は 0 です。
GWL_WNDPROC -4	ウィンドウプロシージャの新しいアドレスを設定します。ウィンドウが呼び出し元スレッドと同じプロセスに属していない場合、この属性を変更することはできません。

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

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

[in] dwNewLong

型: LONG

置換値。

戻り値

型: LONG

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

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

指定した 32 ビット整数の前の値が 0 で、関数が成功した場合、戻り値は 0 ですが、関数は最後のエラー情報をクリアしません。これにより、成功または失敗を判断することが困難になります。これに対処するには、SetWindowLong を呼び出す前に SetLastError を 0 で呼び出して、最後のエラー情報をクリアする必要があります。その後、関数エラーは 0 の戻り値と 0 以外の GetLastError 結果で示されます。

注釈

特定のウィンドウデータがキャッシュされるため、 SetWindowLong を使用して行った変更は、SetWindowPos 関数を呼び出すまで有効になりません。具体的には、いずれかのフレームスタイルを変更する場合は、キャッシュが正しく更新されるように、SWP_FRAMECHANGED フラグを指定して SetWindowPos を呼び出す必要があります。

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

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

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

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

子ウィンドウの親を変更するには、GWL_HWNDPARENT インデックスで SetWindowLong を呼び出す必要があります。代わりに、 SetParent 関数を使用します。

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

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

例

例については、「ウィンドウのサブクラス化」を参照してください。

注意

winuser.h ヘッダーは、SetWindowLong をエイリアスとして定義し、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 で導入)