RunningDocumentTable.FindDocument Method (String)

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

This API is not CLS-compliant. 

Namespace:  Microsoft.VisualStudio.Shell
Assemblies:   Microsoft.VisualStudio.Shell (in Microsoft.VisualStudio.Shell.dll)
  Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)
  Microsoft.VisualStudio.Shell.9.0 (in Microsoft.VisualStudio.Shell.9.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Function FindDocument ( _
    moniker As String _
) As Object
'Usage
Dim instance As RunningDocumentTable
Dim moniker As String
Dim returnValue As Object

returnValue = instance.FindDocument(moniker)

[CLSCompliantAttribute(false)]
public Object FindDocument(
    string moniker
)

[CLSCompliantAttribute(false)]
public:
Object^ FindDocument(
    String^ moniker
)

[<CLSCompliantAttribute(false)>]
member FindDocument : 
        moniker:string -> Object 

public function FindDocument(
    moniker : String
) : Object

Parameters

• moniker
  Type: System.String
  [in] Path to the desired document.

Return Value

Type: System.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 object returned can typically be cast to the IVsPersistDocData interface or the IVsDocDataFileChangeControl interface.

.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.

See Also

Reference

RunningDocumentTable Class

RunningDocumentTable Members

FindDocument Overload

Microsoft.VisualStudio.Shell Namespace