Share via


RunningDocumentTable.FindDocument Method (String, UInt32%)

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

Syntax

'Declaration
Public Function FindDocument ( _
    moniker As String, _
    <OutAttribute> ByRef docCookie As UInteger _
) As Object
public Object FindDocument(
    string moniker,
    out uint docCookie
)
public:
Object^ FindDocument(
    String^ moniker, 
    [OutAttribute] unsigned int% docCookie
)
member FindDocument : 
        moniker:string * 
        docCookie:uint32 byref -> Object
public function FindDocument(
    moniker : String, 
    docCookie : uint
) : Object

Parameters

  • moniker
    Type: String

    [in] Path to the desired document.

  • docCookie
    Type: UInt32%

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

Return Value

Type: Object
An object that can be cast to an appropriate interface to access the document (see Remarks for details), or nulla null reference (Nothing in Visual Basic) if the document is not registered with Visual Studio.

Remarks

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.

.NET Framework Security

See Also

Reference

RunningDocumentTable Class

FindDocument Overload

Microsoft.VisualStudio.Shell Namespace