DialogStringEntry() function

Shows an alphanumeric keyboard on the screen, enabling the operator to change the current string value of a message tag in the Tagname Dictionary.

Category

misc

Syntax

[Result=]DialogStringEntry(MessageTag_Text, UserPrompt_Text);

Parameters

MessageTag_Text

The name of the message tag to be modified. This value is a string value. Specify the tagname within quotes or use the .Name dotfield without quotes. You can also use a message tag as a pointer.

UserPrompt_Text

The user message to show at the top of the keyboard.

Return Value

Returns one of the following integer values:

 0 = Cancel was pressed.

 1 = OK was pressed.

-1 = Internal error.

-2 = Could not initiate.

-3 = Tagname not defined.

-4 = Tagname is not a Message type.

-5 = Unable to write.

Remarks

This function is used primarily in applications containing touch screens.

Example

Errmsg=DialogStringEntry(MyMessageTag.Name, "Enter a new string...");

Errmsg=DialogStringEntry("MyMessageTag","Enter a new string...");

For example, the following script opens an alphanumeric keyboard, allowing modification of MyMessageTag while showing the message "Enter a new string..." at the top of the keyboard:

MessageTagX="MyMessageTag"; {assign the string MyMessageTag (which is actually the tagname to be modified) to the Memory Message tagname MessageTagX}

MessageDisplay="Enter a new string..."; {assign the new message string to the Memory Message tagname MessageDisplay}

Errmsg=DialogStringEntry(MessageTagX, MessageDisplay); {quotes are not required because MessageTagX was defined as a Message tagname}

See Also

DialogValueEntry()