IEnumRunningDocuments Interface
Represents a list of Running Document Table (RDT) cookies that in turn each represent an open document.
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
| Name | Description | |
|---|---|---|
![]() | Clone(IEnumRunningDocuments) | Creates a copy of this IEnumRunningDocuments object. |
![]() | Next(UInt32, UInt32[], UInt32) | Returns a specified number of document cookies from the enumeration sequence. |
![]() | Reset() | Resets the enumeration sequence to the beginning |
![]() | Skip(UInt32) | Skip over the specified number of document cookies in the enumeration sequence. |
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.
