RunningDocumentTable.GetRunningDocumentContents Method (UInt32)
Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document.
This API is not CLS-compliant.
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)
Syntax
'Declaration
<CLSCompliantAttribute(False)> _
Public Function GetRunningDocumentContents ( _
docCookie As UInteger _
) As String
[CLSCompliantAttribute(false)]
public string GetRunningDocumentContents(
uint docCookie
)
[CLSCompliantAttribute(false)]
public:
String^ GetRunningDocumentContents(
unsigned int docCookie
)
[<CLSCompliantAttribute(false)>]
member GetRunningDocumentContents :
docCookie:uint32 -> string
public function GetRunningDocumentContents(
docCookie : uint
) : String
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 nulla null reference (Nothing in Visual Basic) 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.
.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.