RunningDocumentTable.GetRunningDocumentContents Method (String)

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 (in Microsoft.VisualStudio.Shell.dll)

Syntax

'宣言
Public Function GetRunningDocumentContents ( _
    path As String _
) As String
'使用
Dim instance As RunningDocumentTable
Dim path As String
Dim returnValue As String

returnValue = instance.GetRunningDocumentContents(path)
public string GetRunningDocumentContents(
    string path
)
public:
String^ GetRunningDocumentContents(
    String^ path
)
public function GetRunningDocumentContents(
    path : String
) : String

Parameters

Return Value

Type: System.String

The contents of the document in a string format, or a null reference (Nothing in Visual Basic) if the document is not registered with the RDT.

Remarks

If a a null reference (Nothing in Visual Basic) value is returned, the document is either not registered with the RDT or the document is something that does not contain any text.

Permissions

See Also

Reference

RunningDocumentTable Class

RunningDocumentTable Members

GetRunningDocumentContents Overload

Microsoft.VisualStudio.Shell Namespace