RunningDocumentTable.GetRunningDocumentContents Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the contents of a specified document from the Running Document Table (RDT).
GetRunningDocumentContents(String) |
Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document. |
GetRunningDocumentContents(UInt32) |
Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document. |
These methods return the entire contents of the specified document, using either a path to the document or the Running Document Table's cookie for the document.
Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document.
public:
System::String ^ GetRunningDocumentContents(System::String ^ path);
public:
Platform::String ^ GetRunningDocumentContents(Platform::String ^ path);
std::wstring GetRunningDocumentContents(std::wstring const & path);
public string GetRunningDocumentContents (string path);
member this.GetRunningDocumentContents : string -> string
Public Function GetRunningDocumentContents (path As String) As String
Parameters
- path
- String
[in] Path to the desired document.
Returns
The contents of the document in a string format, or null
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.
Applies to
Uses the Running Document Table (RDT) to obtain the contents of a document given the path to the document.
public:
System::String ^ GetRunningDocumentContents(System::UInt32 docCookie);
public:
Platform::String ^ GetRunningDocumentContents(unsigned int docCookie);
std::wstring GetRunningDocumentContents(unsigned int docCookie);
public string GetRunningDocumentContents (uint docCookie);
member this.GetRunningDocumentContents : uint32 -> string
Public Function GetRunningDocumentContents (docCookie As UInteger) As String
Parameters
- docCookie
- UInt32
[in] The unique value that represents the requested document in the RDT.
Returns
The contents of the document in a string format, or null
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.