IVsAsyncFileChangeEx.AdviseFileChangeAsync Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.Framework.dll

Package:: Microsoft.VisualStudio.Shell.Framework v17.11.40262

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.

Creates a subscription to changes for a single file.

public System.Threading.Tasks.Task<uint> AdviseFileChangeAsync (string filename, Microsoft.VisualStudio.Shell.Interop._VSFILECHANGEFLAGS filter, Microsoft.VisualStudio.Shell.Interop.IVsFreeThreadedFileChangeEvents2 sink, System.Threading.CancellationToken cancellationToken = default);

abstract member AdviseFileChangeAsync : string * Microsoft.VisualStudio.Shell.Interop._VSFILECHANGEFLAGS * Microsoft.VisualStudio.Shell.Interop.IVsFreeThreadedFileChangeEvents2 * System.Threading.CancellationToken -> System.Threading.Tasks.Task<uint32>

Public Function AdviseFileChangeAsync (filename As String, filter As _VSFILECHANGEFLAGS, sink As IVsFreeThreadedFileChangeEvents2, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UInteger)

Parameters

filename: String

The name of the file to subscribe to.

filter: _VSFILECHANGEFLAGS

The flags describing the changes to be notified of.

sink: IVsFreeThreadedFileChangeEvents2

The event sink.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<UInt32>

A task that will complete once the subscription has been set up. The task's result will be the subscription cookie.

Remarks

This method is safe to access from any thread.

Applies to

Share via