The DLGTEXTPROMPTGETTEXT function returns the text string entered by the user into the dialog previously shown by dlgTextPrompt. This function must only be called after dlgTextPrompt has been successfully called and closed using the OK button.

 

Parameters

None

 

 

Return Value

The text string entered by the user. Note that if a default value is provided to the dlgTextPrompt function and the user clicks OK, the user is not forced to make any changes to the string.

Example Code

string DisplayText = "Default text";

// Open the prompt dialog with the specified options
if(dlgTextPrompt("The Title", "The Frame", "Enter some text",
                 DisplayText, -1, -1, True) == True)
{
    // Retrieve the text entered into the dialog
    DisplayText = dlgTextPromptGetText();
}