IVsUIShellOpenDocument.IsDocumentOpen 方法
确定文档是否当前打开。
命名空间: Microsoft.VisualStudio.Shell.Interop
程序集: Microsoft.VisualStudio.Shell.Interop(在 Microsoft.VisualStudio.Shell.Interop.dll 中)
语法
声明
Function IsDocumentOpen ( _
pHierCaller As IVsUIHierarchy, _
itemidCaller As UInteger, _
pszMkDocument As String, _
ByRef rguidLogicalView As Guid, _
grfIDO As UInteger, _
<OutAttribute> ByRef ppHierOpen As IVsUIHierarchy, _
<OutAttribute> pitemidOpen As UInteger(), _
<OutAttribute> ByRef ppWindowFrame As IVsWindowFrame, _
<OutAttribute> ByRef pfOpen As Integer _
) As Integer
int IsDocumentOpen(
IVsUIHierarchy pHierCaller,
uint itemidCaller,
string pszMkDocument,
ref Guid rguidLogicalView,
uint grfIDO,
out IVsUIHierarchy ppHierOpen,
uint[] pitemidOpen,
out IVsWindowFrame ppWindowFrame,
out int pfOpen
)
参数
- pHierCaller
类型:Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy
[in] 如果文档处于打开状态,这是指向包含文档项目的 IVsUIHierarchy 接口实现。如果文档尚未打开,这是 nullnull 引用(在 Visual Basic 中为 Nothing)。您可以从 IVsUIHierarchy 的 Query Interface 获取指向该项的 IVsHierarchy 接口。与 IDO_ActivateIfOpen 一起使用。
- itemidCaller
类型:System.UInt32
[in] 层次结构文档的项 ID 在项目中。与 IDO_ActivateIfOpen 一起使用。有关更多信息,请参见 VSITEMID。
- pszMkDocument
类型:System.String
[in] 字符串文档的唯一标记标识符形式对项目系统,例如,完整路径到文件。在 URL 的形式,在非文件种情况下,此标识符常常是。
- rguidLogicalView
类型:System.Guid%
[in] 标识逻辑视图的 GUID。有关逻辑上 GUIDS 列表,请参见逻辑视图和物理视图。
- grfIDO
类型:System.UInt32
[in] 控件的标志的操作在执行打开文档。有关更多信息,请参见 __VSIDOFLAGS。
- ppHierOpen
类型:Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy%
[out] 对包含了项目的 IVsUIHierarchy 接口的指针打开文档。如果 pfOpen 是 false,则此参数是 nullnull 引用(在 Visual Basic 中为 Nothing)。
- pitemidOpen
类型:array<System.UInt32[]
[out] 对层次结构项 ID 的指针在项目系统打开文档。有关更多信息,请参见VSITEMID。
- ppWindowFrame
类型:Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame%
[out] 对包含编辑文档编辑器窗架的 IVsWindowFrame 接口的指针。如果 pfOpen 是 false,则此参数是 nullnull 引用(在 Visual Basic 中为 Nothing)。
- pfOpen
类型:System.Int32%
[out, retval] true ,如果文档中当前打开; false ,如果文档不是打开的。
返回值
类型:System.Int32
如果方法成功,则返回 S_OK。如果失败,它会返回一个错误代码。
备注
COM 签名
从 vsshell.idl:
HRESULT IVsUIShellOpenDocument::IsDocumentOpen(
[in] IVsUIHierarchy *pHierCaller,
[in] VSITEMID itemidCaller,
[in] LPCOLESTR pszMkDocument,
[in] REFGUID rguidLogicalView,
[in] VSIDOFLAGS grfIDO,
[out] IVsUIHierarchy **ppHierOpen,
[out] VSITEMID *pitemidOpen,
[out] IVsWindowFrame **ppWindowFrame,
[out, retval] BOOL *pfOpen
);
.NET Framework 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息,请参见通过部分受信任的代码使用库。