VsShellUtilities.GetRDTDocumentInfo Method

Gets an IVsPersistDocData interface and a document cookie from the running document table for the specified document.

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

Syntax

'Declaration
Public Shared Sub GetRDTDocumentInfo ( _
    site As IServiceProvider, _
    documentName As String, _
    <OutAttribute> ByRef hierarchy As IVsHierarchy, _
    <OutAttribute> ByRef itemid As UInteger, _
    <OutAttribute> ByRef persistDocData As IVsPersistDocData, _
    <OutAttribute> ByRef docCookie As UInteger _
)

public static void GetRDTDocumentInfo(
    IServiceProvider site,
    string documentName,
    out IVsHierarchy hierarchy,
    out uint itemid,
    out IVsPersistDocData persistDocData,
    out uint docCookie
)

public:
static void GetRDTDocumentInfo(
    IServiceProvider^ site, 
    String^ documentName, 
    [OutAttribute] IVsHierarchy^% hierarchy, 
    [OutAttribute] unsigned int% itemid, 
    [OutAttribute] IVsPersistDocData^% persistDocData, 
    [OutAttribute] unsigned int% docCookie
)

static member GetRDTDocumentInfo : 
        site:IServiceProvider * 
        documentName:string * 
        hierarchy:IVsHierarchy byref * 
        itemid:uint32 byref * 
        persistDocData:IVsPersistDocData byref * 
        docCookie:uint32 byref -> unit

public static function GetRDTDocumentInfo(
    site : IServiceProvider, 
    documentName : String, 
    hierarchy : IVsHierarchy, 
    itemid : uint, 
    persistDocData : IVsPersistDocData, 
    docCookie : uint
)

Parameters

• site
  Type: IServiceProvider

  IServiceProvider.

• documentName
  Type: String

  The moniker of the file.

• hierarchy
  Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy%

  [out] The IVsHierarchy interface of the project that containa the document.

• itemid
  Type: UInt32%

  [out] The item ID of the document.

• persistDocData
  Type: Microsoft.VisualStudio.Shell.Interop.IVsPersistDocData%

  [out] The IVsPersistDocData interface for the document.

• docCookie
  Type: UInt32%

  [out] The identifier of the document that is held by the running document table.

Remarks

The docCookie parameter can be used in calls to other IVsRunningDocumentTable methods on this document.

.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

VsShellUtilities Class

Microsoft.VisualStudio.Shell Namespace