RunningDocumentTable.GetDocumentInfo Method

Gets information about a document registered in the Running Document Table, given the identifier of the document.

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 GetDocumentInfo ( _
    docCookie As UInteger _
) As RunningDocumentInfo
'Usage
Dim instance As RunningDocumentTable
Dim docCookie As UInteger
Dim returnValue As RunningDocumentInfo

returnValue = instance.GetDocumentInfo(docCookie)

[CLSCompliantAttribute(false)]
public RunningDocumentInfo GetDocumentInfo(
    uint docCookie
)

[CLSCompliantAttribute(false)]
public:
RunningDocumentInfo GetDocumentInfo(
    unsigned int docCookie
)

[<CLSCompliantAttribute(false)>]
member GetDocumentInfo : 
        docCookie:uint32 -> RunningDocumentInfo 

public function GetDocumentInfo(
    docCookie : uint
) : RunningDocumentInfo

Parameters

  • docCookie
    Type: System.UInt32
    The identifier of the document data object in the Running Document Table.

Return Value

Type: Microsoft.VisualStudio.Shell.RunningDocumentInfo
The RunningDocumentInfo for the specified document.

.NET Framework Security

See Also

Reference

RunningDocumentTable Class

RunningDocumentTable Members

Microsoft.VisualStudio.Shell Namespace

  • Last updated on