SessionIDManager.Encode(String) Method

Definition

Namespace:

System.Web.SessionState

Assembly:

System.Web.dll

Encodes the session identifier for saving to either a cookie or the URL.

public:
 virtual System::String ^ Encode(System::String ^ id);

public virtual string Encode (string id);

abstract member Encode : string -> string
override this.Encode : string -> string

Public Overridable Function Encode (id As String) As String

Parameters

id

String

The session identifier to encode.

Returns

String

The encoded session identifier.

Remarks

This method is not intended to be called from application code.

This method is used internally by the SessionIDManager class to encode custom SessionID values created by classes that inherit the SessionIDManager class and override the CreateSessionID and Validate methods. To ensure the fidelity of a custom session-identifier value stored in the HTTP response by the SaveSessionID method, the SessionIDManager encodes the custom value using the UrlEncode method.

For an example of a class that inherits the SessionIDManager class and overrides the CreateSessionID and Validate methods, see the CreateSessionID method.

See also

• ASP.NET Session State Overview