IdeaBlade DevForce 2010 Help Reference
Login(Guid) Method
See Also  Send Feedback
IdeaBlade.EntityModel Assembly > IdeaBlade.EntityModel Namespace > EntityManager Class > Login Method : Login(Guid) Method



sessionKey
Used to login to an Entity Server based on a previously established session key.

Syntax

Visual Basic (Declaration) 
<ObsoleteAttribute("Will be removed after 9/1/2012.  Use Authenticator.Instance.Login instead.")>
Public Overloads Function Login( _
   ByVal sessionKey As Guid _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As EntityManager
Dim sessionKey As Guid
Dim value As Boolean
 
value = instance.Login(sessionKey)
C# 
[ObsoleteAttribute("Will be removed after 9/1/2012.  Use Authenticator.Instance.Login instead.")]
public bool Login( 
   Guid sessionKey
)
C++/CLI 
[ObsoleteAttribute("Will be removed after 9/1/2012.  Use Authenticator.Instance.Login instead.")]
public:
bool Login( 
   Guid sessionKey
) 

Parameters

sessionKey

Exceptions

ExceptionDescription
IdeaBlade.EntityModel.LoginExceptionInvalid session key

Remarks

Use the 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 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.

Use of this method is not recommended for environments using a load balanced Entity Server.

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

See Also

© 2013 All Rights Reserved.