IVsRunningDocumentTable4.GetDocumentCookie(String) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assemblies:
Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.12.0.dll
Assemblies:
Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.12.0.dll
Assembly:
Microsoft.VisualStudio.Shell.Interop.12.0.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.9.37000

This is functionally identical to calling IVsRunningDocumentTable.FindAndLockDocument with RDT_NoLock and requesting only the cookie, but it is easier to consume from managed code. In managed code it is impossible to request the flags without also requesting all of the other information, and requesting all of the other information can result in the potentially unnecessary initialization of an RDT_PendingInitialization document.

public:
 System::UInt32 GetDocumentCookie(System::String ^ moniker);
public:
 unsigned int GetDocumentCookie(Platform::String ^ moniker);
unsigned int GetDocumentCookie(std::wstring const & moniker);
public uint GetDocumentCookie (string moniker);
abstract member GetDocumentCookie : string -> uint32
Public Function GetDocumentCookie (moniker As String) As UInteger

Parameters

moniker
String

The moniker.

Returns

UInt32

The cookie.

Applies to