Routines for user_br.kb


LoadLocalUserList

File Name

user_br.kb

Syntax

PROCEDURE LoadLocalUserList ( VAL w: Window, VAL controlName: STRING, VAL excludeSelf: BOOLEAN);

Parameters

w - window which contains the control to populate

controlName - control name in dialog box which will contain the

list of users

excludeSelf - exclude the currently logged user from the list

Returns

Nothing

Side Effects

Inserts users into the given control of the given window.

Description

This function will populate a dialog box control with the list of all available users (possibly excluding the currently logged user). The dialog box control will be cleared and then repopulated with the new list of users.

Dialog Forms Called

None


LoadUserList

File Name

user_br.kb

Syntax

PROCEDURE LoadUserList ( VAL w: Window, VAL controlName: STRING, VAL excludeSelf: BOOLEAN);

Parameters

w - window which contains the control to populate

controlName - control name in dialog box which will contain the

list of users

excludeSelf - exclude the currently logged user from the list

Returns

Nothing

Side Effects

Inserts users into the given control of the given window.

Description

This function will populate a dialog box control with the list of all available users (possibly excluding the currently logged user). The dialog box control will be cleared and then repopulated with the new list of users.

Dialog Forms Called

None


PickLocalUser

File Name

user_br.kb

Syntax

FUNCTION PickLocalUser ( VAL w: Window, REF multiSelectUser_ID: LIST OF STRING, VAL multiOnOrOff: BOOLEAN ): BOOLEAN;

Parameters

w - window to create selection list

multiSelectUser_ID - destination user IDs selected by user

multiOnOrOff - turn on or off the multi-selection capability

Returns

TRUE, if user successful in selection, FALSE otherwise

Side Effects

None

Description

This function will present a list of users for selection. If one is selected successfully then the function will return TRUE with the selected user stored in the reference parameter user_id.

Dialog Forms Called

None


PickUser

File Name

user_br.kb

Syntax

FUNCTION PickUser ( VAL w: Window, REF multiSelectUser_ID: LIST OF STRING, VAL multiOnOrOff: BOOLEAN ): BOOLEAN;

Parameters

w - window on which to create selection list

multiSelectUser_ID - destination user IDs selected by user

multiOnOrOff - turn on or off the multi-selection capability

Returns

TRUE, if user successful in selection, FALSE otherwise

Side Effects

None

Description

This function will present a list of users for selection. If one is selected successfully, then the function will return TRUE with the selected user stored in the reference parameter user_id.

Dialog Forms Called

None