StatusBarSetText()

Sets the text in the specified pane of the main window status bar.

Token ID

BFTKN_STATUSBAR_SET_TEXT or 1076

Syntax

VOID StatusBarSetText([ENUM Pane];
                          ANSISTRING Text) 

Parameters

Pane As ENUM

(Optional) Enumerated values:

Number

Value

Description

1

Message

Default

2

SelectedItems

If selected, the Text parameter should be the number of selected items (as a string). If the Text parameter cannot be parsed as a valid integer, the token fails.

3

TotalItems

If selected, the Text parameter should be the total number of items (as a string). If the Text parameter cannot be parsed as a valid integer, the token fails.

Text As ANSISTRING

The text to set in the specified pane of the status bar.

Remarks

Make sure the main window has focus before calling StatusBarSetText. If a message window has focus at the time StatusBarSetText is called, the function fails.

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 this function are displayed. The token returns the previous lock state of the status bar.