LoginEx method

Logs in to an ArchestrA Galaxy and offers the option to perform synchronization at a later point in time and cancel synchronization. This method must be called before any other Galaxy method.

Class

IGalaxy

Syntax

[C#]

void LoginEx(

string UserName, string Password, bool bForceSynchronization

);

[Visual C++]

HRESULT LoginEx(

[in, optional] BSTR UserName,

[in, optional] BSTR Password,

[in, optional] VARIANT_BOOL bForceSynchronization

);

Parameters

UserName

The name of the user.

• When Galaxy Authentication mode is configured, blank or omitted 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 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 authenticate the user.

bForceSynchronization

Set to true to synchronize the client with the server if out of sync is detected.

Remarks

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