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

Syntax

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

returnValue = instance.GetRunningDocumentContents(docCookie)
public string GetRunningDocumentContents(
    uint docCookie
)
public:
String^ GetRunningDocumentContents(
    unsigned int docCookie
)
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 a 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.

Permissions

See Also

Reference

RunningDocumentTable Class

RunningDocumentTable Members

GetRunningDocumentContents Overload

Microsoft.VisualStudio.Shell Namespace