IVsTaskList.RefreshTasks Method

Article
2013-02-04

Informs the task list that a task provider has new or updated tasks.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function RefreshTasks ( _
    dwProviderCookie As UInteger _
) As Integer

int RefreshTasks(
    uint dwProviderCookie
)

int RefreshTasks(
    [InAttribute] unsigned int dwProviderCookie
)

abstract RefreshTasks : 
        dwProviderCookie:uint32 -> int

function RefreshTasks(
    dwProviderCookie : uint
) : int

Parameters

dwProviderCookie
Type: System.UInt32
[in] The task provider ID given by the RegisterTaskProvider method.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsTaskList::RefreshTasks(
   [in] VSCOOKIE dwProviderCookie
);

A task provider should call this method to inform the task list that it has updated a current task or has new tasks to add to the task list. It is not necessary to call this method when a user deletes a task from the task list. However, this method must be called if the task is deleted any other way (for example, if the user deletes a line containing a shortcut task). The task list will perform a sort, based upon the current sort, after this method is called.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via