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
Assemblies: Microsoft.VisualStudio.Shell (in Microsoft.VisualStudio.Shell.dll)
Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)
Microsoft.VisualStudio.Shell.9.0 (in Microsoft.VisualStudio.Shell.9.0.dll)
Syntax
'Déclaration
Public Function GetRunningDocumentContents ( _
path As String _
) As String
'Utilisation
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
)
member GetRunningDocumentContents :
path:string -> string
public function GetRunningDocumentContents(
path : String
) : String
Parameters
- path
Type: System.String
[in] Path to the desired document.
Return Value
Type: System.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
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.