WebPart.RegisterWorkItemCallback 方法

请注意:此 API 现在已过时。

队列中的 Web 部件工作项的线程池、 调用指定的委托,并指定要传递给线程池中的服务时的代理人的对象。

命名空间:  Microsoft.SharePoint.WebPartPages
程序集:  Microsoft.SharePoint(位于 Microsoft.SharePoint.dll 中)

语法

声明
<ObsoleteAttribute("Use Page.RegisterAsyncTask instead.")> _
Protected Function RegisterWorkItemCallback ( _
    beginCallBack As WaitCallback, _
    state As Object _
) As Boolean
用法
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
)

参数

  • beginCallBack
    类型:System.Threading.WaitCallback

    工作项中提取一个System.Threading.WaitCallback对象,该对象代表在线程池中的线程时要调用的委托。

  • state
    类型:System.Object

    从线程池传递给委托服务时的对象。

返回值

类型:System.Boolean
true如果该方法成功 ;否则为false。

备注

Web 部件应使用异步线程,可能需要很长时间的任何操作。例如,如果数据库或 HTTP 请求需要执行,在异步线程上运行此工作项将允许其他部件继续处理而被阻止。WebPart基类提供用于创建单独的线程的 Web 部件数据读取和管理这些线程,以确保它们不运行太长,并阻止呈现页面的方法。只要在RenderWebPart之前调用方法,可调用RegisterWorkItemCallback方法。此方法运行方式类似于System.Threading.ThreadPool.QueueUserWorkItem,但实现以使用 Web 部件页面中的事件模型。

如果发生超时时未完成的线程,而不是RenderWebPart方法调用RenderWorkItemTimeout方法。包含在 web.config 文件中的 < SharePoint > 标记内的 < WebPartWorkItem > 标记Timeout属性的值由指定的超时设置。

另请参阅

引用

WebPart 类

WebPart 成员

Microsoft.SharePoint.WebPartPages 命名空间