GetWindowLongPtrA 関数 (winuser.h)

  • [アーティクル]

指定したウィンドウに関する情報を取得します。 関数は、指定されたオフセットの値を余分なウィンドウ メモリに取得します。

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

構文

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

パラメーター

[in] hWnd

型: HWND

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

[in] nIndex

型: int

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

値 説明
GWL_EXSTYLE
-20
 拡張ウィンドウ スタイルを取得します。
GWLP_HINSTANCE
-6
 アプリケーション インスタンスへのハンドルを取得します。
GWLP_HWNDPARENT
-8
 親ウィンドウのハンドルがある場合は、そのハンドルを取得します。
GWLP_ID
-12
 ウィンドウの識別子を取得します。
GWL_STYLE
-16
 ウィンドウ スタイルを取得します。
GWLP_USERDATA
-21
 ウィンドウに関連付けられているユーザー データを取得します。 このデータは、ウィンドウを作成したアプリケーションで使用するためのものです。 その値は、最初は 0 です。
GWLP_WNDPROC
-4
 ウィンドウ プロシージャへのポインター、またはウィンドウ プロシージャへのポインターを表すハンドルを取得します。 ウィンドウ プロシージャを呼び出すには、 CallWindowProc 関数を使用する必要があります。
 

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

値 説明
DWLP_DLGPROC
DWLP_MSGRESULT + sizeof(LRESULT)
 ダイアログ ボックス プロシージャへのポインター、またはダイアログ ボックス プロシージャへのポインターを表すハンドルを取得します。 ダイアログ ボックス プロシージャを呼び出すには、 CallWindowProc 関数を使用する必要があります。
DWLP_MSGRESULT
0
 ダイアログ ボックス プロシージャで処理されたメッセージの戻り値を取得します。
DWLP_USER
DWLP_DLGPROC + sizeof(DLGPROC)
 ハンドルやポインターなど、アプリケーションにプライベートな追加情報を取得します。

戻り値

種類: LONG_PTR

関数が成功した場合、戻り値は要求された値です。

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

SetWindowLong または SetWindowLongPtr が以前に呼び出されていない場合、GetWindowLongPtr は余分なウィンドウまたはクラス メモリ内の値に対して 0 を返します。

解説

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

注意

winuser.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetWindowLongPtr を定義します。 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 で導入)

関連項目

CallWindowProc

概念

リファレンス

RegisterClassEx

SetParent

SetWindowLongPtr

WNDCLASSEX

ウィンドウ クラス