VsShellUtilities.GetRDTDocumentInfo Method

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Gets an IVsPersistDocData interface and a document cookie from the running document table for the specified document.

public:
 static void GetRDTDocumentInfo(IServiceProvider ^ site, System::String ^ documentName, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ % hierarchy, [Runtime::InteropServices::Out] System::UInt32 % itemid, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsPersistDocData ^ % persistDocData, [Runtime::InteropServices::Out] System::UInt32 % docCookie);

public static void GetRDTDocumentInfo (IServiceProvider site, string documentName, out Microsoft.VisualStudio.Shell.Interop.IVsHierarchy hierarchy, out uint itemid, out Microsoft.VisualStudio.Shell.Interop.IVsPersistDocData persistDocData, out uint docCookie);

static member GetRDTDocumentInfo : IServiceProvider * string * IVsHierarchy * uint32 * IVsPersistDocData * uint32 -> unit

Public Sub GetRDTDocumentInfo (site As IServiceProvider, documentName As String, ByRef hierarchy As IVsHierarchy, ByRef itemid As UInteger, ByRef persistDocData As IVsPersistDocData, ByRef docCookie As UInteger)

Parameters

site

IServiceProvider

The service provider.

documentName

String

Path to the document.

hierarchy

IVsHierarchy

[out, optional] Reference to the IVsHierarchy interface for the project who owns the document.

itemid

UInt32

[out, optional] Reference to an item identifier in the hierarchy.

persistDocData

IVsPersistDocData

[out] A reference to the IVsPersistDocData interface associated to the document

docCookie

UInt32

[out, optional] A reference to an abstract handle to the document.

Remarks

The docCookie parameter can be used in calls to other IVsRunningDocumentTable methods on this document.