IVsRunningDocTableEvents4.OnBeforeFirstDocumentLock 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
在文档在运行的文档表中锁定之前调用 (第一次使用 RDT) 。
public:
int OnBeforeFirstDocumentLock(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHier, System::UInt32 itemid, System::String ^ pszMkDocument);
public:
int OnBeforeFirstDocumentLock(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHier, unsigned int itemid, Platform::String ^ pszMkDocument);
int OnBeforeFirstDocumentLock(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy const & pHier, unsigned int itemid, std::wstring const & pszMkDocument);
public int OnBeforeFirstDocumentLock (Microsoft.VisualStudio.Shell.Interop.IVsHierarchy pHier, uint itemid, string pszMkDocument);
abstract member OnBeforeFirstDocumentLock : Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * string -> int
Public Function OnBeforeFirstDocumentLock (pHier As IVsHierarchy, itemid As UInteger, pszMkDocument As String) As Integer
参数
- pHier
- IVsHierarchy
中 IVsHierarchy 要锁定的文档所属的对象。
- itemid
- UInt32
中层次结构中的项 ID。 这是一个唯一标识符,也可以是以下值之一: VSITEMID_NIL 、 VSITEMID_ROOT 或 VSITEMID_SELECTION 。
- pszMkDocument
- String
中要锁定的文档的路径。
返回
如果该方法成功,则它会返回 S_OK。 如果该方法失败,则会返回错误代码。
注解
COM 签名
从 vsshell80:
[C++]
HRESULT IVsRunningDocTableEvents4::OnBeforeFirstDocumentLock(
[in] IVsHierarchy* pHier,
[in] VSITEMID itemid
);
此事件可用于确保要锁定的文档实际存在于磁盘上。 例如,此事件可以使源代码管理有机会在文件被锁定并打开之前从源代码管理数据库中下载指定的文件。