Interface IAuthenticateUserEvent

Authenticate user event information.

Inherited Members

ILifeCycleEvent.ModelContext

IEvent.Logger

IEvent.CheckForTimeout()

IEvent.EventStack

IEvent.GetHandlerProperty(string)

IEvent.IsDesignEnvironment()

IEvent.CreateUserErrorMessage(string)

IEvent.CreateErrorMessage(int)

IEvent.CreateErrorMessage(int, object[])

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

public interface IAuthenticateUserEvent : ILifeCycleEvent, IEvent

Remarks

Authenticate user event information. See AuthenticateUser(IAuthenticateUserEvent)

Properties

Password

Gets the password provided in the connection request.

Declaration

string Password { get; }

Property Value

Type	Description
string	The password provided by the client.

User

Gets the username provided in the connection request.

Declaration

string User { get; }

Property Value

Type	Description
string	The user name provided by the client.

Methods

GetVariableNames()

Gets the names of the model variables.

Declaration

IList<string> GetVariableNames()

Returns

Type	Description
IList<string>	A list of variable values defined by the model.

GetVariableValue(string)

Gets the value of a model variable.

Declaration

string GetVariableValue(string name)

Parameters

Type	Name	Description
string	name	The name of a model variable.

Returns

Type	Description
string	The current value of the named model variable.

Exceptions

Type	Condition
ApptrieveException	Thrown if the model variable requested does not exist.

SetVariableValue(string, string)

Changes the value of the specified model variable.

Declaration

void SetVariableValue(string name, string varValue)

Parameters

Type	Name	Description
string	name	The name of a model variable.
string	varValue	The new desired value of the named model variable.

Exceptions

Type	Condition
ApptrieveException	Thrown if the model variable requested does not exist or is read-only.