Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Overloads Function Login( _ ByVal sessionKey As Guid, _ Optional ByVal options As LoginOptions _ ) As IAuthenticationContext | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As Authenticator Dim sessionKey As Guid Dim options As LoginOptions Dim value As IAuthenticationContext value = instance.Login(sessionKey, options) | |
| C# | |
|---|---|
public IAuthenticationContext Login( Guid sessionKey, LoginOptions options ) | |
| C++/CLI | |
|---|---|
public: IAuthenticationContext^ Login( Guid sessionKey, LoginOptions^ options ) | |
Parameters
- sessionKey
- Uniquely identifies an existing session
- options
- Characterists of the Entity Server to log into.
Exceptions
| Exception | Description |
|---|---|
| IdeaBlade.EntityModel.LoginException | Invalid session key |
Remarks
Use the AuthenticationContext.SessionKey returned from a user session established previously. This login is most useful in ASP.NET applications where an EntityManager is constructed only for the lifetime of a request. Using an existing AuthenticationContext.SessionKey allows you to recreate the user session from a lightweight token.
User sessions will by default timeout after 30 minutes of inactivity. You will receive a IdeaBlade.EntityModel.LoginException if the session has timed out and you attempt to login with the session key. The timeout value can be modified via the UserSessionTimeout setting.
Requirements
Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family