SessionStateStoreProviderBase.GetItem Méthode

Définition

Retourne des données d’état de session en lecture seule à partir du magasin de données de session.

public:
 abstract System::Web::SessionState::SessionStateStoreData ^ GetItem(System::Web::HttpContext ^ context, System::String ^ id, [Runtime::InteropServices::Out] bool % locked, [Runtime::InteropServices::Out] TimeSpan % lockAge, [Runtime::InteropServices::Out] System::Object ^ % lockId, [Runtime::InteropServices::Out] System::Web::SessionState::SessionStateActions % actions);
public abstract System.Web.SessionState.SessionStateStoreData GetItem(System.Web.HttpContext context, string id, out bool locked, out TimeSpan lockAge, out object lockId, out System.Web.SessionState.SessionStateActions actions);
abstract member GetItem : System.Web.HttpContext * string * bool * TimeSpan * obj * SessionStateActions -> System.Web.SessionState.SessionStateStoreData
Public MustOverride Function GetItem (context As HttpContext, id As String, ByRef locked As Boolean, ByRef lockAge As TimeSpan, ByRef lockId As Object, ByRef actions As SessionStateActions) As SessionStateStoreData

Paramètres

context
HttpContext

Pour HttpContext la requête actuelle.

id
String

Pour SessionID la requête actuelle.

locked
Boolean

Lorsque cette méthode est retournée, contient une valeur booléenne définie true si l’élément de session demandé est verrouillé au niveau du magasin de données de session ; sinon, false.

lockAge
TimeSpan

Lorsque cette méthode est retournée, contient un TimeSpan objet défini sur la durée pendant laquelle un élément du magasin de données de session a été verrouillé.

lockId
Object

Lorsque cette méthode est retournée, contient un objet défini sur l’identificateur de verrou pour la requête actuelle. Pour plus d’informations sur l’identificateur de verrou, consultez « Verrouillage Session-Store Données » dans le résumé de la SessionStateStoreProviderBase classe.

actions
SessionStateActions

Lorsque cette méthode est retournée, contient l’une SessionStateActions des valeurs, indiquant si la session active est une session sans cookie non initialisée.

Retours

Rempli SessionStateStoreData de valeurs de session et d’informations à partir du magasin de données de session.

Exemples

Pour obtenir un exemple d’implémentation d’un fournisseur de magasin d’état de session, consultez Implémentation d’un fournisseur de magasin Session-State.

Remarques

L’objet SessionStateModule appelle la GetItem méthode au début d’une requête, pendant l’événement AcquireRequestState , lorsque l’attribut EnableSessionState est défini ReadOnlysur . Si l’attribut EnableSessionState est défini sur true, l’objet SessionStateModule appelle plutôt la GetItemExclusive méthode.

La GetItem méthode retourne un SessionStateStoreData objet rempli d’informations de session à partir du magasin de données et met à jour la date d’expiration des données de session. Si aucune donnée d’élément de session n’est trouvée dans le magasin de données, la GetItem méthode définit le lockedout paramètre sur false et retourne null. Ainsi, l’objet SessionStateModule appelle la CreateNewStoreData méthode pour créer un élément de session dans le magasin de données.

Si des données d’élément de session sont trouvées dans le magasin de données, mais que les données sont verrouillées, la GetItem méthode définit le lockedout paramètre sur , définit le lockAgeout paramètre truesur la date et l’heure actuelles moins la date et l’heure à laquelle l’élément a été verrouillé (qui est récupéré à partir du magasin de données), définit le lockIdout paramètre sur l’identificateur de verrou récupéré à partir du magasin de données, et retourne null. Cela entraîne l’appel de la SessionStateModuleGetItem méthode après un intervalle d’une demi-seconde pour tenter de récupérer les informations de l’élément de session.

Si la valeur définie par le lockAgeout paramètre dépasse la ExecutionTimeout valeur, l’objet SessionStateModule appelle la ReleaseItemExclusive méthode pour effacer le verrou sur les données de l’élément de session, puis appelle à nouveau la GetItem méthode.

Le actionFlags paramètre est utilisé lorsque les attributs et regenerateExpiredSessionId les cookieless attributs sont définis sur true. Valeur actionFlags définie pour InitializeItem indiquer que l’entrée dans le magasin de données de session est une nouvelle session qui nécessite l’initialisation. Les entrées non initialisées dans le magasin de données de session sont créées par un appel à la CreateUninitializedItem méthode. Si l’élément du magasin de données de session n’est pas un élément non initialisé, le actionFlags paramètre est défini sur zéro.

Les implémenteurs de magasin d’état de session personnalisés qui prennent en charge les sessions sans cookie doivent définir le paramètre sur la actionFlagsout valeur retournée par le magasin de données de session pour l’élément actif. Si la actionFlags valeur du paramètre de l’élément de magasin de sessions demandé est égale à la InitializeItem valeur d’énumération, la GetItem méthode doit définir la valeur dans le magasin de données sur zéro après avoir défini le actionFlagsout paramètre.

S’applique à

Voir aussi