IVsTaskList.RefreshTasks(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int RefreshTasks(System::UInt32 dwProviderCookie);

public:
 int RefreshTasks(unsigned int dwProviderCookie);

int RefreshTasks(unsigned int dwProviderCookie);

public int RefreshTasks (uint dwProviderCookie);

abstract member RefreshTasks : uint32 -> int

Public Function RefreshTasks (dwProviderCookie As UInteger) As Integer

Parameters

dwProviderCookie: UInt32

[in] The task provider ID given by the RegisterTaskProvider(IVsTaskProvider, UInt32) method.

Returns

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.

Applies to