LOTUSSCRIPT/COM/OLE CLASSES


Prompt method
Example

Displays a dialog box and returns a value based on your actions in the dialog box.

Note This method is new with Release 5.

Defined in

NotesUIWorkspace

Syntax

variant = notesUIWorkspace.Prompt( type%, title$, prompt$ [, default ] [, values ] )

Parameters

type%


title$
prompt$
default
values
Return value

Variant of type integerfor PROMPT_OK, PROMPT_YESNO, PROMPT_YESNOCANCEL
Variant of type stringfor PROMPT_OKCANCELEDIT, PROMPT_OKCANCELLIST, PROMPT_OKCANCELCOMBO, PROMPT_OKCANCELEDITCOMBO, and PROMPT_PASSWORD
Variant Array for PROMPT_CHOOSEDATABASE and PROMPT_OKCANCELLISTMULT

Type% PROMPT_OK always returns 1. For type% PROMPT_YESNO, returns 1 if you select Yes. If you select No, returns 0. For type% PROMPT_YESNOCANCEL, returns 1 if you select Yes, 0 if you select No, and -1 if you select Cancel. For PROMPT_OKCANCELLISTMULT, the return value is a variant containing a string array if you select OK, and EMPTY if you select Cancel. For PROMPT_CHOOSEDATABASE, the return value is a three-element array of strings, containing the server, filepath, and title of the database, in that order; if you press cancel, the return value is EMPTY. For all other type%s the return value is a string if you press OK, and EMPTY if you press Cancel.

Language cross-reference

@Prompt function in formula language

Example