Loading...
 

CX_SYSTEM_OBJECT::SetDialogTimeout

CX_SYSTEM_OBJECT::SetDialogTimeout

210371

Description:

Sets a system-wide timeout for all displayed dialogues. This includes Attention, DialogBox, FileDlg and error messages. An open attention or error message is simply closed after the timeout has expired. DialogBox and FileDlg deliver INVALID to the stack after the timeout has expired.

If a timeout is specified as a parameter in the dialogue box , it is valid if no timeout was set with SetDialogTimeout or if the timeout of the dialogue box is shorter than the one set with SetDialogTimeout .

If NULL or a CX_VALUE or CX_TIME with the value 0 is passed, the system-wide dialogue timeout is deactivated again. If one of the timeout is set via a CX_VALUE , then the unit must be convertible into seconds. The timeout only works to whole seconds, a timeout of 0.5 seconds will not work.

The currently set timeout can be queried again via GetDialogTimeout .

Code example:
LocalVar(prevTimeout) SystemObject Call(GetDialogTimeout) -> prevTimeout 20s SystemObject Call(SetDialogTimeout) "This Dialog will close in 20 seconds" Attention(,INFO) prevTimeout SystemObject Call(SetDialogTimeout)

Stack

Stack Position Object type Brief description
Stack(In) Top CX_VALUE | CX_TIME | ZERO The timeout to be set
Stack(Out) Top
Function call: Call(SetDialogTimeout)

See also: GetDialogTimeout