IVsRunningDocumentTable Interface
Definition
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.
Manages the set of currently open documents in the environment.
public interface class IVsRunningDocumentTablepublic interface class IVsRunningDocumentTable__interface IVsRunningDocumentTable[System.Runtime.InteropServices.Guid("A928AA21-EA77-47AC-8A07-355206C94BDD")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsRunningDocumentTable[System.Runtime.InteropServices.Guid("A928AA21-EA77-47AC-8A07-355206C94BDD")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsRunningDocumentTable[<System.Runtime.InteropServices.Guid("A928AA21-EA77-47AC-8A07-355206C94BDD")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsRunningDocumentTable = interface[<System.Runtime.InteropServices.Guid("A928AA21-EA77-47AC-8A07-355206C94BDD")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsRunningDocumentTable = interfacePublic Interface IVsRunningDocumentTable- Attributes
Remarks
Some members of this interface are safe to access from any thread.
Notes to Implementers
Implemented by the environment.
Notes to Callers
Called by VSPackages that open and track documents in their projects. Obtain this interface by calling QueryService(Guid, Guid, IntPtr) on a site provider with the service ID SVsRunningDocumentTable and the interface GUID of the IVsRunningDocumentTable interface.
Methods
| AdviseRunningDocTableEvents(IVsRunningDocTableEvents, UInt32) |
Enables the client to receive notifications of changes to the Running Document Table (RDT). |
| FindAndLockDocument(UInt32, String, IVsHierarchy, UInt32, IntPtr, UInt32) |
Locates a document in the RDT using the document file name, then obtains a read or edit lock on that document. |
| GetDocumentInfo(UInt32, UInt32, UInt32, UInt32, String, IVsHierarchy, UInt32, IntPtr) |
Returns information about a document registered in the RDT, given the cookie. |
| GetRunningDocumentsEnum(IEnumRunningDocuments) |
Enumerates through all documents in the RDT. |
| LockDocument(UInt32, UInt32) |
Obtains a read or edit lock on a document when it is opened. |
| ModifyDocumentFlags(UInt32, UInt32, Int32) |
Modifies the RDT document flags for a registered document. |
| NotifyDocumentChanged(UInt32, UInt32) |
Notifies the client when changes are made to the document. |
| NotifyOnAfterSave(UInt32) |
Fires after a document in the RDT has been saved. |
| NotifyOnBeforeSave(UInt32) |
Fires before a document in the RDT is saved. |
| RegisterAndLockDocument(UInt32, String, IVsHierarchy, UInt32, IntPtr, UInt32) |
Creates an entry in the running document table when a document is created or opened. |
| RegisterDocumentLockHolder(UInt32, UInt32, IVsDocumentLockHolder, UInt32) |
Registers a document lock holder in the running document table. |
| RenameDocument(String, String, IntPtr, UInt32) |
Renames and/or changes the ownership of a document. |
| SaveDocuments(UInt32, IVsHierarchy, UInt32, UInt32) |
Saves the documents. |
| UnadviseRunningDocTableEvents(UInt32) |
Disables the client from receiving notifications of changes to the RDT. |
| UnlockDocument(UInt32, UInt32) |
Releases a read or edit lock on the open document. |
| UnregisterDocumentLockHolder(UInt32) |
Unregisters a document lock holder in the running document table. |