Login method

Logs in to an ArchestrA Galaxy and performs a forced synchronization of the client with the Galaxy Repository. This method must be called before any other Galaxy method.

Class

IGalaxy

Syntax

[C#]

void Login(

string UserName, string Password

);

[Visual C++]

HRESULT Login(

[in, optional] BSTR UserName,

[in, optional] BSTR Password

);

Parameters

UserName

The name of the user.

• When Galaxy Authentication mode is configured, blank or omitted UserName means log in as "admin".

• When OS User based or OS Group based Authentication mode is configured, UserName is ignored and the current logged in user or current user group membership is used to authenticate the user.

Password

The user's password.

• When Galaxy Authentication mode is configured, blank or omitted Password means use a blank password.

• When OS User based or OS Group based Authentication mode is configured, Password is ignored and the current logged in user or current user group membership is used to authentication the user.

Remarks

If GRAccess is already logged into a Galaxy, the session is logged off and re-established with the specified Galaxy.