GetDlgCtrlID 関数 (winuser.h)

  • [アーティクル]

指定したコントロールの識別子を取得します。

構文

int GetDlgCtrlID(
  [in] HWND hWnd
);

パラメーター

[in] hWnd

型: HWND

コントロールのハンドル。

戻り値

型: int

関数が成功した場合、戻り値はコントロールの識別子です。

関数が失敗した場合は、0 を返します。 たとえば、 hwndCtl パラメーターの値が無効な場合、関数は失敗します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

GetDlgCtrlID は、ダイアログ ボックス内のコントロールのハンドルだけでなく、子ウィンドウ ハンドルも受け入れます。 アプリケーションは、CreateWindow または CreateWindowEx 関数を呼び出すときに hmenu パラメーターに識別子値を割り当てることで、ウィンドウを作成するときに子ウィンドウの識別子を設定します。

hwndCtl が最上位ウィンドウのハンドルである場合、GetDlgCtrlID は値を返す場合がありますが、最上位のウィンドウには識別子を指定できず、そのような戻り値は無効です。

例

例については、「 ダイアログ ボックスの初期化」を参照してください。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winuser.h (Windows.h を含む)
Library User32.lib
[DLL] User32.dll
API セット ext-ms-win-ntuser-dialogbox-l1-1-0 (Windows 8 で導入)

関連項目

概念

CreateWindow

CreateWindowEx

ダイアログ ボックス

GetDlgItem

参照