C++ Syntax

bool

MKI_DialogString(

HWND f_hWindow,

const LPCWSTR f_pszCaption,

const LPCWSTR f_pszPrefix,

LPWSTR f_pszText,

const size_t f_unMaxSize );

Shows and processes the dialog that allows editing a simple text string.

Parameters

Window

[HWND] Handle of the dialog window's parent window.

Caption

[const LPCWSTR] Title of the dialog window to be displayed. Be careful that the given title fits into the dialog window's caption.

Prefix

[const LPCWSTR] Text to be displayed in front of the edit field. Be careful that the given text fits into the dialog.

Text

[LPWSTR] Address of the text to be edited.

MaxSize

[const size_t] Maximum allowed size of the text in characters including the terminating zero.

Returns true if the dialog window was ended by pressing the OK button (no matter if anything inside the window was changed), else false.