RunningDocumentTable::GetRunningDocumentContents Method (UInt32)

 

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

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

public:
String^ GetRunningDocumentContents(
	unsigned int docCookie
)

Parameters

docCookie
Type: System::UInt32

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

Return Value

Type: System::String^

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

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.

Return to top
Show: