IEnumRunningDocuments Interface
Represents a list of Running Document Table (RDT) cookies that in turn each represent an open document.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
<GuidAttribute("D5C658C5-59A1-414F-AF5E-E72E83377EAE")> _
<InterfaceTypeAttribute()> _
Public Interface IEnumRunningDocuments
'Usage
Dim instance As IEnumRunningDocuments
[GuidAttribute("D5C658C5-59A1-414F-AF5E-E72E83377EAE")]
[InterfaceTypeAttribute()]
public interface IEnumRunningDocuments
[GuidAttribute(L"D5C658C5-59A1-414F-AF5E-E72E83377EAE")]
[InterfaceTypeAttribute()]
public interface class IEnumRunningDocuments
public interface IEnumRunningDocuments
Remarks
The RDT represents each open document in Visual Studio by a unique value known as a cookie. The IEnumRunningDocuments interface enumerates all cookies representing all open documents.
A cookie as used by the RDT is represented as a VSCOOKIE type. In C++, this is defined as a DWORD_PTR (or DWORD *) while in managed code such as C#, the VSCOOKIE is treated simply as an unsigned integer (uint). However, a cookie is a value that only the RDT knows how to use so always consider it as just an unsigned number to be passed around.
Notes to Implementers:
This interface is implemented by the environment for accessing a list of open documents as maintained by the RDT.
Notes to Callers:
Obtain this interface from the GetRunningDocumentsEnum method in the IVsRunningDocumentTable interface.