SessionStateStoreProviderBase.GetItem メソッド

.NET Framework クラス ライブラリ リファレンス

SessionStateStoreProviderBase.GetItem メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

セッション データ ストアから読み取り専用のセッション状態データを返します。

名前空間: System.Web.SessionState
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public MustOverride Function
 GetItem ( _
    context As HttpContext, _
    id As String, _
    <OutAttribute> ByRef locked As Boolean,
 _
    <OutAttribute> ByRef lockAge As TimeSpan,
 _
    <OutAttribute> ByRef lockId As Object,
 _
    <OutAttribute> ByRef actions As SessionStateActions
 _
) As SessionStateStoreData

Visual Basic (使用法)

Dim instance As SessionStateStoreProviderBase
Dim context As HttpContext
Dim id As String
Dim locked As Boolean
Dim lockAge As TimeSpan
Dim lockId As Object
Dim actions As SessionStateActions
Dim returnValue As SessionStateStoreData

returnValue = instance.GetItem(context, id, locked, lockAge, lockId, actions)

C#

public abstract SessionStateStoreData GetItem (
    HttpContext context,
    string id,
    out bool locked,
    out TimeSpan lockAge,
    out Object lockId,
    out SessionStateActions actions
)

C++

public:
virtual SessionStateStoreData^ GetItem (
    HttpContext^ context, 
    String^ id, 
    [OutAttribute] bool% locked, 
    [OutAttribute] TimeSpan% lockAge, 
    [OutAttribute] Object^% lockId, 
    [OutAttribute] SessionStateActions% actions
) abstract

J#

public abstract SessionStateStoreData GetItem (
    HttpContext context, 
    String id, 
    /** @attribute OutAttribute() */ /** @ref */ boolean locked, 
    /** @attribute OutAttribute() */ /** @ref */ TimeSpan lockAge, 
    /** @attribute OutAttribute() */ /** @ref */ Object lockId, 
    /** @attribute OutAttribute() */ /** @ref */ SessionStateActions actions
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

context

現在の要求に関する HttpContext。

id

現在の要求に関する SessionID。

locked

このメソッドが返されるときに、要求したセッション項目がセッション データ ストアでロックされているときはブール値 true、それ以外の場合は false を含みます。

lockAge

このメソッドが返されるときに、セッション データ ストアの項目がロックされた時間に設定された TimeSpan オブジェクトを含みます。

lockId

このメソッドが返されるときに、現在の要求のロック識別子に設定されたオブジェクトを含みます。ロック識別子の詳細については、SessionStateStoreProviderBase クラスの概要の「セッション ストア データのロック」を参照してください。

actions

このメソッドが返されるときに、現在のセッションが初期化されていない cookieless セッションかどうかを示す SessionStateActions 値の 1 つを含みます。

戻り値
セッション値およびセッション データ ストアからの情報を含む SessionStateStoreData。

解説

SessionStateModule オブジェクトは、要求の開始時の AcquireRequestState イベントで EnableSessionState 属性を ReadOnly に設定する際に、GetItem メソッドを呼び出します。EnableSessionState 属性を true に設定すると、代わりに SessionStateModule オブジェクトが GetItemExclusive メソッドを呼び出します。

GetItem メソッドはデータ ストアのセッション情報を含む SessionStateStoreData オブジェクトを返し、セッション データの有効期限を更新します。データ ストアにセッション項目データが見つからない場合、GetItem メソッドは locked out パラメータを false に設定し、null 参照 (Visual Basic では Nothing) を返します。その結果、SessionStateModule オブジェクトは CreateNewStoreData メソッドを呼び出してデータ ストアに新しいセッション項目を作成します。

セッション項目データがデータ ストアにあり、ロックされている場合、GetItem メソッドは locked out パラメータを true に設定し、lockAge out パラメータを現在の日時から項目がロックされた日時 (データ ストアから取得) を減算した値に設定し、lockId out パラメータをロック識別子 (データ ストアから取得) に設定し、null 参照 (Visual Basic では Nothing) を返します。その結果、SessionStateModule オブジェクトは、0.5 秒後に再び GetItem メソッドを呼び出してセッション項目情報の取得を試みます。

lockAge  out パラメータに設定されている値が ExecutionTimeout 値を超える場合、SessionStateModule オブジェクトは ReleaseItemExclusive メソッドを呼び出してセッション項目データのロックを解除し、再び GetItem メソッドを呼び出します。

cookieless 属性と regenerateExpiredSessionId 属性の両方が true に設定されている場合は、actionFlags パラメータが使用されます。InitializeItem に設定されている actionFlags 値は、セッション データ ストアのエントリが初期化を必要とする新しいセッションであることを示します。セッション データ ストアの初期化されていないエントリは、CreateUninitializedItem メソッドを呼び出して作成します。セッション データ ストアの項目が初期化されている場合、actionFlags パラメータはゼロに設定されます。

cookieless セッションをサポートするカスタム セッション状態ストアの実装側は、actionFlags out パラメータを現在の項目のセッション データ ストアから返される値に設定する必要があります。要求されたセッション ストア項目の actionFlags パラメータ値が InitializeItem 列挙値に等しい場合、GetItem メソッドは、actionFlags out パラメータを設定した後にデータ ストアの値をゼロに設定する必要があります。

使用例

セッション状態ストア プロバイダの実装の例については、「セッション状態ストア プロバイダの実装」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SessionStateStoreProviderBase クラス
SessionStateStoreProviderBase メンバ
System.Web.SessionState 名前空間
その他の技術情報
ASP.NET のセッション状態