StatusBarLockText()

Locks or unlocks the main window status bar text.

Token ID

BFTKN_STATUSBAR_LOCK_TEXT or 1077

Syntax

BOOLEAN StatusBarLockText([ENUM Pane];
                          [BOOLEAN Lock])

Parameters

Pane As ENUM

(Optional) Enumerated values:

Number

Value

0

All -- Locks all three panes of the main window status bar

1

Message (default)

2

SelectedItems

3

TotalItems
Lock As BOOLEAN

(Optional) If neither value is specified, the lock state of the status bar is toggled:

  • TRUE Locks the specified pane of the status bar
  • FALSE Unlocks the specified pane of the status bar

Return Values

BOOLEAN - Previous lock state of the status bar

Remarks

Make sure the main window has focus before calling StatusBarLockText. If a message window has focus at the time StatusBarLockText is called, the function fails and the GroupWise status bar might remain locked until GroupWise is restarted.

When the status bar is locked, any status bar messages posted internally by GroupWise are not displayed on the status bar. When the status bar is locked, only messages set by StatusBarSetText() are displayed. The token returns the previous lock state of the status bar.