C++ Syntax

bool

MKI_DialogControlGetInt32(

HWND f_hWindow,

__int32 f_nEditID,

__int32& f_rnValue );

MKI_DialogControlGetInt32(

HWND f_hWindow,

__int32 f_nEditID,

__int32& f_rnValue,

__int32 f_nMin,

__int32 f_nMax,

const LPCWSTR f_pszError );

Read a value from a text or edit control in a dialog window and converts its to an 32-bit integer (optionally with checking for range).

Parameters

f_hWindow

[HWND] Handle of the dialog window.

f_nEditID

[__int32] ID of the text control in the dialog window containing the value.

f_rnValue

[&__int32] Reference to an integer value that shall receive the controls' content.

f_nMin

[__int32] Smallest value allowed. Will be ignored if MKI_INT32_NOVAL.

f_nMax

[__int32] Largest value allowed. Will be ignored if MKI_INT32_NOVAL.

f_pszError

[const LPCWSTR] Error message to be displayed if the value is either invalid (no integer value) or out of range. If nullptr, a generic message will be displayed.

Return Value

Returns true if the value was successfully read and converted into a integer. Otherwise, an error message will be displayed to the user and false will be returned.