RunningDocumentTable::FindDocument Method (String^, UInt32)

Visual Studio 2015
 

Gets a cookie from the Running Document Table (RDT) that represents the document specified by the given path.

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

C#
C++
F#
VB
Copy 
public:
Object^ FindDocument(
	String^ moniker,
	[OutAttribute] unsigned int% docCookie
)

Parameters

moniker
Type: System::String^

[in] Path to the desired document.

docCookie
Type: System::UInt32

[out] Returns the unique value that represents the requested document in the RDT.

Return Value

Type: System::Object^

An object that can be cast to an appropriate interface to access the document (see Remarks for details), or null if the document is not registered with Visual Studio.

The cookie can be used in a call to the GetRunningDocumentContents method.

The object returned can typically be cast to the IVsPersistDocData interface or the IVsDocDataFileChangeControl interface.

Return to top
Show: