Dela via


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

Syntax

'Declaration
Public Function GetRunningDocumentContents ( _
    path As String _
) As String
public string GetRunningDocumentContents(
    string path
)
public:
String^ GetRunningDocumentContents(
    String^ path
)
member GetRunningDocumentContents : 
        path:string -> string
public function GetRunningDocumentContents(
    path : String
) : String

Parameters

  • path
    Type: String

    [in] Path to the desired document.

Return Value

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

Remarks

If a nulla 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.

.NET Framework Security

See Also

Reference

RunningDocumentTable Class

GetRunningDocumentContents Overload

Microsoft.VisualStudio.Shell Namespace