IVsRunningDocumentTable.GetDocumentInfo 方法
返回有关 RDT 注册的文档的信息将 cookie。
命名空间: Microsoft.VisualStudio.Shell.Interop
程序集: Microsoft.VisualStudio.Shell.Interop(在 Microsoft.VisualStudio.Shell.Interop.dll 中)
语法
声明
Function GetDocumentInfo ( _
docCookie As UInteger, _
<OutAttribute> ByRef pgrfRDTFlags As UInteger, _
<OutAttribute> ByRef pdwReadLocks As UInteger, _
<OutAttribute> ByRef pdwEditLocks As UInteger, _
<OutAttribute> ByRef pbstrMkDocument As String, _
<OutAttribute> ByRef ppHier As IVsHierarchy, _
<OutAttribute> ByRef pitemid As UInteger, _
<OutAttribute> ByRef ppunkDocData As IntPtr _
) As Integer
int GetDocumentInfo(
uint docCookie,
out uint pgrfRDTFlags,
out uint pdwReadLocks,
out uint pdwEditLocks,
out string pbstrMkDocument,
out IVsHierarchy ppHier,
out uint pitemid,
out IntPtr ppunkDocData
)
参数
- docCookie
类型:System.UInt32
[in] 表示信息请求的文档的抽象值。
- pgrfRDTFlags
类型:System.UInt32%
[out] 返回值从 _VSRDTFLAGS 枚举所采用的标志。
- pdwReadLocks
类型:System.UInt32%
[out] 返回读取 lock 数文档中的。
- pdwEditLocks
类型:System.UInt32%
[out] 返回数字编辑文档中的锁。
- pbstrMkDocument
类型:System.String%
[out] 返回文档的路径和文件名。
- ppHier
类型:Microsoft.VisualStudio.Shell.Interop.IVsHierarchy%
[out, optional] 返回 IVsHierarchy 接口。
- pitemid
类型:System.UInt32%
[out, optional] 文档的项 ID。这是唯一标识符或它可以是下列值之一: VSITEMID_NIL、 VSITEMID_ROOT或 VSITEMID_SELECTION。
- ppunkDocData
类型:System.IntPtr%
[out, optional] 返回 IUnknown 接口。
返回值
类型:System.Int32
如果方法成功,则返回 S_OK。如果失败,它会返回一个错误代码。
备注
COM 签名
从 vsshell.idl:
HRESULT IVsRunningDocumentTable::GetDocumentInfo(
[in] VSCOOKIE docCookie,
[out] VSRDTFLAGS *pgrfRDTFlags,
[out] DWORD *pdwReadLocks,
[out] DWORD *pdwEditLocks,
[out] BSTR *pbstrMkDocument,
[out] IVsHierarchy **ppHier,
[out] VSITEMID *pitemid,
[out] IUnknown **ppunkDocData
);
ppunkDocData 参数表示文档数据对象与注册的文档。 通常, IVsPersistDocData 和 IVsDocDataFileChangeControl 接口从此 IUnknown 对象获取。
.NET Framework 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息,请参见通过部分受信任的代码使用库。