IVaryByCustomHandler.GetVaryByCustomString - Méthode

Varie en fonction de la sortie extraite d'un cache en fonction des valeurs de propriétés des propriétés de l' actuel HttpApplicationet l' HttpContext de la demande en cours.

Espace de noms :  Microsoft.SharePoint.ApplicationRuntime
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Function GetVaryByCustomString ( _
    app As HttpApplication, _
    context As HttpContext, _
    custom As String _
) As String
'Utilisation
Dim instance As IVaryByCustomHandler
Dim app As HttpApplication
Dim context As HttpContext
Dim custom As String
Dim returnValue As String

returnValue = instance.GetVaryByCustomString(app, _
    context, custom)
string GetVaryByCustomString(
    HttpApplication app,
    HttpContext context,
    string custom
)

Paramètres

  • custom
    Type : System.String

    La chaîne personnalisée qui spécifie quelle page mise en cache ou un contrôle est utilisée pour répondre à la demande en cours.

Valeur renvoyée

Type : System.String
String qui contient une ou plusieurs valeurs (converties en chaînes délimitées) des propriétés des objets context et app (ou des propriétés de l'un de leurs enfants) qui sont utilisées par le Gestionnaire de cache comme critères pour déterminer la version d'une page ou un contrôle doivent être récupérées à partir d'un cache (ou si une nouvelle version doit être extrait).

Remarques

En règle générale, custom est un jeu délimité de sous-chaînes, mais elle peut être une chaîne unique.

En règle générale, chaque sous-chaîne dans custom est un alias court et convivial pour un nom de propriété qualifié complet.

Lors de la réception d'une demande pour une page mise en cache ou d'un contrôle, le Gestionnaire de cache inspecte la sortie de valeurs de propriété par GetVaryByCustomString(HttpContext, String). Si elles sont exactement identiques sous la forme d'une version mise en cache de la page demandée ou le contrôle, la version mise en cache est retournée. Sinon, une nouvelle version est rendue retournée et mis en cache.

Remarques destinées aux responsables de l’implémentation

En règle générale, votre code doit ajouter une valeur (convertie en une chaîne avec un séparateur) à la valeur de retour pour chaque sous-chaîne vos directives de code ou @ OutputCache ajoutés à custom avant d'être passée à IVaryByCustomHandler.GetVaryByCustomString.

Avertissement

Les autres fournisseurs de solutions Windows SharePoint Services 3.0 peuvent utiliser leurs propre code et @ OutputCache directives pour ajouter leurs propres chaînes personnalisées à custom, à l'aide de leurs propres modèles de délimitation. Par conséquent, votre implémentation de IVaryByCustomHandler.GetVaryByCustomString doit être écrit pour ignorer les sous-chaînes dans custom qui ne sont pas pertinentes pour votre solution.

Voir aussi

Référence

IVaryByCustomHandler interface

IVaryByCustomHandler - Membres

Microsoft.SharePoint.ApplicationRuntime - Espace de noms