WebPart.RegisterWorkItemCallback - Méthode
Remarque : cette API est désormais obsolète.
Un élément de travail de composant WebPart dans le pool de threads en file d'attente, appelle le délégué spécifié et spécifie un objet d'être passé au délégué lors de la prise en charge du pool de threads.
Espace de noms : Microsoft.SharePoint.WebPartPages
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)
Syntaxe
'Déclaration
<ObsoleteAttribute("Use Page.RegisterAsyncTask instead.")> _
Protected Function RegisterWorkItemCallback ( _
beginCallBack As WaitCallback, _
state As Object _
) As Boolean
'Utilisation
Dim beginCallBack As WaitCallback
Dim state As Object
Dim returnValue As Boolean
returnValue = Me.RegisterWorkItemCallback(beginCallBack, _
state)
[ObsoleteAttribute("Use Page.RegisterAsyncTask instead.")]
protected bool RegisterWorkItemCallback(
WaitCallback beginCallBack,
Object state
)
Paramètres
beginCallBack
Type : System.Threading.WaitCallbackUn objet System.Threading.WaitCallback représentant le délégué à appeler lorsqu'un thread dans le pool de threads sélectionne l'élément de travail.
state
Type : System.ObjectL'objet qui est passé au délégué lors de la prise en charge du pool de threads.
Valeur renvoyée
Type : System.Boolean
true si la méthode aboutit ; dans le cas contraire, false.
Remarques
Un composant WebPart doit utiliser un thread asynchrone pour toute opération qui peut prendre beaucoup de temps. Par exemple, si une base de données ou le HTTP demande doit être effectuée, cet élément de travail en cours d'exécution sur un thread asynchrone autorisera autres parties pour poursuivre le traitement sans être bloquées. La classe de base WebPart fournit des méthodes de création d'un thread distinct pour les extractions de données de composant WebPart et de gérer ces threads pour vous assurer qu'ils ne pas exécuter trop longs et bloquer la page à partir de rendu. La méthode RegisterWorkItemCallback peut être appelée à tout moment avant l' RenderWebPart l'appel de méthode. Cette méthode fonctionne de façon similaire à System.Threading.ThreadPool.QueueUserWorkItem, mais il est implémentée pour travailler avec le modèle d'événements dans une Page de composants WebPart.
S'il existe des threads non terminés lorsque le délai d'attente se produit, la méthode RenderWorkItemTimeout est appelée au lieu de la méthode RenderWebPart . Le paramètre de délai d'expiration est spécifié par la valeur de l'attribut Timeout de la balise < WebPartWorkItem > contenue dans la balise < SharePoint > dans le fichier web.config.