Share via


RunningDocumentInfo Struct

Definition

Represents information about a document in the RunningDocumentTable. It includes all the information returned by GetDocumentInfo(UInt32, UInt32, UInt32, UInt32, String, IVsHierarchy, UInt32, IntPtr).

public value class RunningDocumentInfo
struct RunningDocumentInfo
public struct RunningDocumentInfo
type RunningDocumentInfo = struct
Public Structure RunningDocumentInfo
Inheritance
RunningDocumentInfo

Constructors

RunningDocumentInfo(IVsRunningDocumentTable, String)

Initializes a new instance of RunningDocumentTable.

RunningDocumentInfo(IVsRunningDocumentTable, UInt32)

Initializes a new instance of RunningDocumentTable.

Properties

DidDocumentInitializationFail
DocCookie

The document cookie

DocData

The document object in the Running Document Table (RDT).

EditLocks

The number of edit locks held on the document.

Flags

The _VSRDTFLAGS set on the document.

Hierarchy

The IVsHierarchy interface of the hierarchy node that owns the document.

IsDirty
IsDocumentInitialized

Determines whether the document has been initialized.

IsHierarchyInitialized

Determines whether the hierarchy has been initialized.

IsReadOnly
IsValid

Indicates whether the document represented by DocCookie is registered in RDT. If this is false, then all other properties of this struct are also invalid.

ItemId

The item ID of the node that holds the document.

Moniker

The absolute path of the document.

ProjectGuid

The GUID of the project.

ReadLocks

The number of read locks held on the document.

Methods

CreateInstanceAsync(IVsRunningDocumentTable, String, CancellationToken)
CreateInstanceAsync(IVsRunningDocumentTable, UInt32, CancellationToken)
Sync()

RunningDocumentInfo is a snapshot of information from RDT. In order to update this information you need to call Sync.

Applies to