RunningDocumentTable.GetRunningDocumentContents Method

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Gets the contents of a specified document from the Running Document Table (RDT).

Overloads

GetRunningDocumentContents(String)	Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document.
GetRunningDocumentContents(UInt32)	Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document.

Remarks

These methods return the entire contents of the specified document, using either a path to the document or the Running Document Table's cookie for the document.

GetRunningDocumentContents(String)

Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document.

public:
 System::String ^ GetRunningDocumentContents(System::String ^ path);

public:
 Platform::String ^ GetRunningDocumentContents(Platform::String ^ path);

std::wstring GetRunningDocumentContents(std::wstring const & path);

public string GetRunningDocumentContents (string path);

member this.GetRunningDocumentContents : string -> string

Public Function GetRunningDocumentContents (path As String) As String

Parameters

path

String

[in] Path to the desired document.

Returns

String

The contents of the document in a string format, or null if the document is not registered with the RDT.

Remarks

If a null value is returned, the document is either not registered with the RDT or the document is something that does not contain any text.

GetRunningDocumentContents(UInt32)

Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document.

public:
 System::String ^ GetRunningDocumentContents(System::UInt32 docCookie);

public:
 Platform::String ^ GetRunningDocumentContents(unsigned int docCookie);

std::wstring GetRunningDocumentContents(unsigned int docCookie);

public string GetRunningDocumentContents (uint docCookie);

member this.GetRunningDocumentContents : uint32 -> string

Public Function GetRunningDocumentContents (docCookie As UInteger) As String

Parameters

docCookie

UInt32

[in] The unique value that represents the requested document in the RDT.

Returns

String

The contents of the document in a string format, or null if the document is not registered with the RDT.

Remarks

If a null value is returned, the document is either not registered with the RDT or the document is something that does not contain any text.

The cookie value can be obtained with a call to the FindDocument method.