Functions to Check the User Response from Vitesse UI
- Last UpdatedJan 07, 2026
- 2 minute read
These functions are used to check the resulting "User Response" in all Vitesse UI functions. After a call of such a UI function, a completed user input will yield the user response ok(), if nothing else is stated. Otherwise the cause of user interruption could be checked against any other function below.
Note: The "check" functions below do not cover all possible user responses from a UI function.
|
ok() |
||
|
The function returns a value that is equal to user response OK. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of OK |
|
Exceptions: |
||
|
None |
||
|
cancel() |
||
|
The function returns a value that is equal to user response CANCEL. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of CANCEL |
|
Exceptions: |
||
|
None |
||
|
quit() |
||
|
The function returns a value that is equal to user response QUIT. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of QUIT |
|
Exceptions: |
||
|
None |
||
|
options() |
||
|
The function returns a value that is equal to user response OPTIONS. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of OPTIONS |
|
Exceptions: |
||
|
None |
||
|
operation_complete() |
||
|
The function returns a value that is equal to user response OPERATION COMPLETE. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of OPERATION COMPLETE |
|
Exceptions: |
||
|
None |
||
|
yes() |
||
|
The function returns a value that is equal to user response YES. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of YES |
|
Exceptions: |
||
|
None |
||
|
no() |
||
|
The function returns a value that is equal to user response NO. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of NO |
|
Exceptions: |
||
|
None |
||
|
all() |
||
|
The function returns a value that is equal to user response ALL. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of ALL |
|
Exceptions: |
||
|
None |
||
|
undo() |
||
|
The function returns a value that is equal to user response UNDO. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of UNDO |
|
Exceptions: |
||
|
None |
||
|
reject() |
||
|
The function returns a value that is equal to user response REJECT. |
||
|
Note: REJECT is equal to CANCEL. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of REJECT |
|
Exceptions: |
||
|
None |
||
|
exit_function() |
||
|
The function returns a value that is equal to user response EXIT_FUNCTION. |
||
|
Note: EXIT_FUNCTION is equal to QUIT. |
||
|
Input parameters: |
||
|
None |
||
|
Result: |
||
|
[0] |
integer |
The value of EXIT_FUNCTION |
|
Exceptions: |
||
|
None |
||
Example
# Example: kcs_ex_util2.py