BBjAPI::getAdmin

Description

In BBj 5.0 and higher, this method retrieves the current BBjAdmin object.

Syntax

Return Value

Method

BBjAdmin

getAdmin(string user, string password)

Parameters

Variable

Description

user

A user with administrator rights in BBjServices.

password

The password for user.

Return Value

The BBjAdmin object.

Remarks

Throws an !ERROR=13 (ACCESS) if the user/password is invalid.

Example

rem 'Obtain the instance of the BBjAdmin object

INPUT "Enter an Administrator User: ",user$
INPUT "Enter a password: ",password$
admin! = BBjAPI().getAdmin(user$, password$)

See Also

BBjAPI

Object Variables

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.