IVsRunningDocumentTable2.FindOrRegisterAndLockDocument 方法

添加一个固定到注册或注销文档。

命名空间：  Microsoft.VisualStudio.Shell.Interop
程序集：  Microsoft.VisualStudio.Shell.Interop.8.0（在 Microsoft.VisualStudio.Shell.Interop.8.0.dll 中）

语法

声明
Function FindOrRegisterAndLockDocument ( _
    grfRDTLockType As UInteger, _
    pszMkDocument As String, _
    pHierPreferred As IVsHierarchy, _
    itemidPreferred As UInteger, _
    punkDocData As IntPtr, _
    <OutAttribute> ByRef ppHierActual As IVsHierarchy, _
    <OutAttribute> ByRef pitemidActual As UInteger, _
    <OutAttribute> ByRef ppunkDocDataActual As IntPtr, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer

int FindOrRegisterAndLockDocument(
    uint grfRDTLockType,
    string pszMkDocument,
    IVsHierarchy pHierPreferred,
    uint itemidPreferred,
    IntPtr punkDocData,
    out IVsHierarchy ppHierActual,
    out uint pitemidActual,
    out IntPtr ppunkDocDataActual,
    out uint pdwCookie
)

参数

• grfRDTLockType
  类型：System.UInt32
  [in] 值从 _VSRDTFLAGS 枚举所采用的标志。

• pszMkDocument
  类型：System.String
  [in] 所在的路径文档。

• pHierPreferred
  类型：Microsoft.VisualStudio.Shell.Interop.IVsHierarchy
  [out, optional] returns 愿意所在的 IVsHierarchy 接口文档。

• itemidPreferred
  类型：System.UInt32
  [out, optional] 返回找到的项 ID 文档。这是唯一标识符或它可以是下列值之一: VSITEMID_NIL、 VSITEMID_ROOT或 VSITEMID_SELECTION。

• punkDocData
  类型：System.IntPtr
  [out, optional] 返回 IUnknown 接口。

• ppHierActual
  类型：Microsoft.VisualStudio.Shell.Interop.IVsHierarchy%
  [out, optional] 返回所在的物理 IVsHierarchy 接口文档。

• pitemidActual
  类型：System.UInt32%
  [out, optional] 返回找到的项 ID 文档。这是唯一标识符或它可以是下列值之一: VSITEMID_NIL、 VSITEMID_ROOT或 VSITEMID_SELECTION。

• ppunkDocDataActual
  类型：System.IntPtr%
  [out, optional] 返回 IUnknown 接口。

• pdwCookie
  类型：System.UInt32%
  [out, optional] 返回文档的抽象值。

返回值

类型：System.Int32
如果方法成功，则返回 S_OK。如果失败，它会返回一个错误代码。

备注

此方法处理添加锁的所有用例添加到文档文档是否已注册。这是将 RegisterAndLockDocument 和 FindAndLockDocumentEx的功能的简便方法。，如果文档已注册，RegisterAndLockDocument 返回 false。，如果未注册，FindAndLockDocumentEx 返回 false。在 RDT_EditLock 需的大小写，而文档中当前仅向 RDT_ReadLock 注册未指派的 pHier/itemid，此功能将该首选 pHier/itemid 到文档中。

COM 签名

从 vsshell80.idl:

HRESULT FindOrRegisterAndLockDocument(
    [in] VSRDTFLAGS grfRDTLockType,
    [in] LPCOLESTR pszMkDocument,
    [in] IVsHierarchy *pHierPreferred,
    [in] VSITEMID itemidPreferred,
    [in] IUnknown *punkDocData,
    [out] IVsHierarchy **ppHierActual,
    [out] VSITEMID *pitemidActual,
    [out] IUnknown **ppunkDocDataActual,
    [out] VSCOOKIE *pdwCookie
);

.NET Framework 安全性

• 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息，请参见通过部分受信任的代码使用库。

请参见

参考

IVsRunningDocumentTable2 接口

Microsoft.VisualStudio.Shell.Interop 命名空间