RunningDocumentInfo Structure

Represents information about a document in the RunningDocumentTable. It includes all the information returned by GetDocumentInfo.

This API is not CLS-compliant. The CLS-compliant alternative is [None].

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Structure RunningDocumentInfo
[CLSCompliantAttribute(false)]
public struct RunningDocumentInfo
[CLSCompliantAttribute(false)]
public value class RunningDocumentInfo
[<Sealed>]
[<CLSCompliantAttribute(false)>]
type RunningDocumentInfo =  struct end
JScript supports the use of structures, but not the declaration of new ones.

The RunningDocumentInfo type exposes the following members.

Methods

  Name Description
Public method Equals Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from ValueType.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Fields

  Name Description
Public field DocCookie The document cookie.
Public field DocData The document object in the Running Document Table (RDT).
Public field EditLocks The number of edit locks held on the document.
Public field Flags The _VSRDTFLAGS set on the document.
Public field Hierarchy The IVsHierarchy interface of the hierarchy node that owns the document.
Public field ItemId The item ID of the node that holds the document.
Public field Moniker The absolute path of the document.
Public field ReadLocks The number of read locks held on the document.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Shell Namespace