IDL Reference Guide: iTools Object Classes

IDLitIMessaging::PromptUserText

The IDLitIMessaging::PromptUserText function method is used to prompt the iTool user with a question and retrieve a text answer. The text answer is returned to the caller of this method via a supplied IDL variable.

The actual method used to prompt the user depends on the user interface in use. Normally, the prompt is displayed as a modal dialog.

Syntax

Result = Obj->[IDLitIMessaging::]PromptUserText(StrPrompt, Answer [, TITLE=string])

Return Value

Returns 1 if the prompt was displayed and the user clicked the OK button. If the user clicks the Cancel button or dismisses the dialog, the return value is 0.

Arguments

StrPrompt

A scalar string or string array containing a prompt for the user to respond to.

Answer

A named variable that will contain the string value entered by the user.

Keywords

TITLE

Set this keyword to a string representing the title of the prompt. This value is placed in the title bar of the modal dialog.

Version History

  IDL Online Help (March 06, 2007)