hiChangeBannerLabel
hiChangeBannerLabel(
w_windowId
t_bannerLabel
x_labelPosition
)
=> t / nil
Description
Overwrites an existing label or adds a new label in the banner bar of a window.
Arguments
|
w_windowId
|
Window to which you want to add the label.
|
|
t_bannerLabel
|
Specifies the label.
|
|
x_labelPosition
|
Integer specifying the position for the label. 0 represents the leftmost user-defined label, 1 the one to its right, and so on. If a label already exists at the position you specify, it is overwritten. Otherwise, if x_labelPosition is greater than the current number of labels, the new label is added to the right of the existing labels.
|
Values Returned
|
t
|
The label was added.
|
|
nil
|
The label was not added. An error message is also issued.
|
Examples
Adds Label 1 in the banner bar of hiGetCurrentWindow.
hiChangeBannerLabel(hiGetCurrentWindow( ) "Label 1" 0)
=> t
Related Topics
Window Banner Functions
hiDeleteBannerLabel
hiGetBannerLabels
Return to top
