|
ovi_GetSetWindowLevel |
|---|
| ovi_GetSetWindowLevel (getSet;overlayRef;windowLevel) <- errorCode | |||
|---|---|---|---|
| Parameter | Type | Description | |
| -> | getSet | Integer | Get (0) or set (1) the parameter |
| -> | overlayRef | Long Integer | Overlay window reference |
| <-> | windowLevel | Long Integer | Level or new level |
| -> | Tokens | Text Integer | Tokens |
| <- | errorCode | Long Integer | Error Code (0 = no error) |
overlayRef is a reference to an overlay window returned by ovi_NewWindow.
This routine returns in windowLevel the level of the overlay window if getSet is 0 (constant kovi_GET). Else, it sets the level of the window to the new windowLevel value. Possible values for windowLevel are:
| Value | Constant |
|---|---|
| 0 | koviLEVEL_Utility |
| 1 | koviLEVEL_Toolbar |
| 2 | koviLEVEL_Overlay |
If getSet is 1 (constant kovi_SET) and the windowLevel is not one of those values, it is reset to koviLEVEL_Utility. To learn more about the different possible levels, please see the documentation of the ovi_NewWindow routine.