IVsRunningDocumentTable5.HandsOffDocument(UInt32, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

This method is typically called prior to an operation that will change the document on disk. When the operation is complete, HandsOnDocument should be called.It performs the following actions: - IVsFileChangeEx.IgnoreFile(true) - IVsTrackProjectDocuments3.HandsOffFilesIf the document's docdata supports it: - IVsPersistDocData3.HandsOffDocDataStorage - IVsDocDataFileChangeControl.IgnoreFileChangesIf the document's hierarchy supports it: - IVsPersistHierarchyItem2.IgnoreItemFileChanges

public:
 void HandsOffDocument(System::UInt32 cookie, System::String ^ moniker);

public:
 void HandsOffDocument(unsigned int cookie, Platform::String ^ moniker);

void HandsOffDocument(unsigned int cookie, std::wstring const & moniker);

public void HandsOffDocument (uint cookie, string moniker);

abstract member HandsOffDocument : uint32 * string -> unit

Public Sub HandsOffDocument (cookie As UInteger, moniker As String)

Parameters

cookie

UInt32

(optional) The cookie for the document (if VSCOOKIE_NIL is used, the moniker parameter identifies the document).

moniker

String

(optional) The moniker for the document (only used if cookie == VSCOOKIE_NIL).

Remarks

This method must be accessed on the main thread.