ホーム › UI.WindowsAndMessaging › GetDlgItemInt

GetDlgItemInt

関数

ダイアログコントロールの文字列を整数として取得する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll
#include <windows.h>

DWORD GetDlgItemInt(
    HWND hDlg,
    INT nIDDlgItem,
    BOOL* lpTranslated,   // optional
    BOOL bSigned
);

パラメーター

名前	型	方向	説明
hDlg	HWND	in	対象のコントロールを含むダイアログボックスへのハンドル。
nIDDlgItem	INT	in	テキストを変換するコントロールの識別子。
lpTranslated	BOOL*	outoptional	成功または失敗を示します(TRUE は成功、FALSE は失敗を示します)。このパラメーターが NULL の場合、関数は成功または失敗に関する情報を返しません。
bSigned	BOOL	in	テキストの先頭にマイナス記号があるかどうかを調べ、マイナス記号が見つかった場合に符号付き整数値を返すかどうかを示します(TRUE はこれを行うことを、FALSE は行わないことを指定します)。

戻り値の型: DWORD

公式ドキュメント

ダイアログボックス内の指定されたコントロールのテキストを整数値に変換します。

戻り値

Type: UINT

関数が成功した場合、lpTranslated が指す変数は TRUE に設定され、戻り値はコントロールのテキストを変換した値になります。

関数が失敗した場合、lpTranslated が指す変数は FALSE に設定され、戻り値はゼロになります。ただし、ゼロは変換結果として取り得る値であるため、戻り値がゼロであること自体が失敗を示すわけではありません。

lpTranslated が NULL の場合、関数は成功または失敗に関する情報を返しません。

bSigned パラメーターが TRUE で、テキストの先頭にマイナス記号(–)がある場合、GetDlgItemInt はテキストを符号付き整数値に変換します。それ以外の場合、関数は符号なし整数値を生成します。この場合に正しい値を取得するには、戻り値を int 型にキャストしてください。

拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

GetDlgItemInt 関数は、指定されたコントロールに WM_GETTEXT メッセージを送信することで、そのコントロールのテキストを取得します。関数は、取得したテキストの先頭にある余分なスペースを取り除き、続いて十進数の数字を変換します。関数は、テキストの末尾に達するか、数字以外の文字に遭遇すると変換を停止します。

GetDlgItemInt 関数は、変換した値が INT_MAX(符号付き数値の場合)または UINT_MAX(符号なし数値の場合)より大きい場合、ゼロを返します。

Examples

例については、モードレスダイアログボックスの作成を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

DWORD GetDlgItemInt(
    HWND hDlg,
    INT nIDDlgItem,
    BOOL* lpTranslated,   // optional
    BOOL bSigned
);

[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint GetDlgItemInt(
    IntPtr hDlg,   // HWND
    int nIDDlgItem,   // INT
    IntPtr lpTranslated,   // BOOL* optional, out
    bool bSigned   // BOOL
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDlgItemInt(
    hDlg As IntPtr,   ' HWND
    nIDDlgItem As Integer,   ' INT
    lpTranslated As IntPtr,   ' BOOL* optional, out
    bSigned As Boolean   ' BOOL
) As UInteger
End Function

' hDlg : HWND
' nIDDlgItem : INT
' lpTranslated : BOOL* optional, out
' bSigned : BOOL
Declare PtrSafe Function GetDlgItemInt Lib "user32" ( _
    ByVal hDlg As LongPtr, _
    ByVal nIDDlgItem As Long, _
    ByVal lpTranslated As LongPtr, _
    ByVal bSigned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDlgItemInt = ctypes.windll.user32.GetDlgItemInt
GetDlgItemInt.restype = wintypes.DWORD
GetDlgItemInt.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    ctypes.c_int,  # nIDDlgItem : INT
    ctypes.c_void_p,  # lpTranslated : BOOL* optional, out
    wintypes.BOOL,  # bSigned : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetDlgItemInt = Fiddle::Function.new(
  lib['GetDlgItemInt'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_INT,  # nIDDlgItem : INT
    Fiddle::TYPE_VOIDP,  # lpTranslated : BOOL* optional, out
    Fiddle::TYPE_INT,  # bSigned : BOOL
  ],
  -Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetDlgItemInt(
        hDlg: *mut core::ffi::c_void,  // HWND
        nIDDlgItem: i32,  // INT
        lpTranslated: *mut i32,  // BOOL* optional, out
        bSigned: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern uint GetDlgItemInt(IntPtr hDlg, int nIDDlgItem, IntPtr lpTranslated, bool bSigned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetDlgItemInt' -Namespace Win32 -PassThru
# $api::GetDlgItemInt(hDlg, nIDDlgItem, lpTranslated, bSigned)

#uselib "USER32.dll"
#func global GetDlgItemInt "GetDlgItemInt" sptr, sptr, sptr, sptr
; GetDlgItemInt hDlg, nIDDlgItem, varptr(lpTranslated), bSigned   ; 戻り値は stat
; hDlg : HWND -> "sptr"
; nIDDlgItem : INT -> "sptr"
; lpTranslated : BOOL* optional, out -> "sptr"
; bSigned : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetDlgItemInt "GetDlgItemInt" sptr, int, var, int
; res = GetDlgItemInt(hDlg, nIDDlgItem, lpTranslated, bSigned)
; hDlg : HWND -> "sptr"
; nIDDlgItem : INT -> "int"
; lpTranslated : BOOL* optional, out -> "var"
; bSigned : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetDlgItemInt "GetDlgItemInt" sptr, int, sptr, int
; res = GetDlgItemInt(hDlg, nIDDlgItem, varptr(lpTranslated), bSigned)
; hDlg : HWND -> "sptr"
; nIDDlgItem : INT -> "int"
; lpTranslated : BOOL* optional, out -> "sptr"
; bSigned : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。