IVsRunningDocumentTable2.QueryCloseRunningDocument 方法

,如果它已在不兼容的编辑器,关闭指定的文档,其中可能的确认。

命名空间:  Microsoft.VisualStudio.Shell.Interop
程序集:  Microsoft.VisualStudio.Shell.Interop.8.0(在 Microsoft.VisualStudio.Shell.Interop.8.0.dll 中)

语法

声明
Function QueryCloseRunningDocument ( _
    pszMkDocument As String, _
    <OutAttribute> ByRef pfFoundAndClosed As Integer _
) As Integer
int QueryCloseRunningDocument(
    string pszMkDocument,
    out int pfFoundAndClosed
)

参数

  • pszMkDocument
    类型:System.String
    [in] 关闭文档的路径。
  • pfFoundAndClosed
    类型:System.Int32%
    [out] 返回非零 (TRUE),如果找到文档并关闭;否则,返回零 (0)FALSE)。请参见"备注"。

返回值

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

备注

COM 签名

从 vsshell80.idl:

HRESULT QueryCloseRunningDocument(
   [in] LPCOLESTR pszMkDocument,
   [out] BOOL *pfFoundAndClosed
);

调用此方法,在文档在结果是不符合文档的编辑后已打开。 此方法自动关闭文档,除非某些情况存在,则,在中,提示用户关闭文档情况下。 下面的列表指出发生的情况,因为该方法调用时。

  • 如果文档不在运行文档表 (RDT),则此方法会设置 pfFoundAndClosed 参数设置为零 (FALSE) 并返回 S_OK

  • 如果文档中 RDT 并且只有读锁,则文档将自动结束。

  • 如果文档中 RDT 并具有编辑锁定,则会提示该用户关闭文件。

  • 如果用户选择不关闭文档,则此方法会设置 pfFoundAndClosed 参数设置为零 (FALSE) 并返回 OLE_E_PROMPTSAVECANCELLED

  • 如果文档实际上是关闭的,则此方法会设置 pfFoundAndClosed 参数为非零 (TRUE) 并返回 S_OK

.NET Framework 安全性

请参见

参考

IVsRunningDocumentTable2 接口

Microsoft.VisualStudio.Shell.Interop 命名空间