This documentation is archived and is not being maintained.

IVsRunningDocTableEvents.OnBeforeLastDocumentUnlock Method

Called before releasing the last lock of the specified type on the specified document in the Running Document Table (RDT).

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

int OnBeforeLastDocumentUnlock (
	[InAttribute] uint docCookie,
	[InAttribute] uint dwRDTLockType,
	[InAttribute] uint dwReadLocksRemaining,
	[InAttribute] uint dwEditLocksRemaining
)
int OnBeforeLastDocumentUnlock (
	/** @attribute InAttribute() */ UInt32 docCookie, 
	/** @attribute InAttribute() */ UInt32 dwRDTLockType, 
	/** @attribute InAttribute() */ UInt32 dwReadLocksRemaining, 
	/** @attribute InAttribute() */ UInt32 dwEditLocksRemaining
)
function OnBeforeLastDocumentUnlock (
	docCookie : uint, 
	dwRDTLockType : uint, 
	dwReadLocksRemaining : uint, 
	dwEditLocksRemaining : uint
) : int

Parameters

docCookie

[in] Abstract value representing the document whose last lock is about to be removed.

dwRDTLockType

[in] Type of lock being released. Values are taken from the _VSRDTFLAGS enumeration.

dwReadLocksRemaining

[in] The number of read locks remaining.

dwEditLocksRemaining

[in] The number of edit locks remaining.

Return Value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

This method is called just before the last read lock is released on the document and just before the last edit lock is released.

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocTableEvents::OnBeforeLastDocumentUnlock(
   [in] VSCOOKIE docCookie,
   [in] VSRDTFLAGS dwRDTLockType,
   [in] DWORD dwReadLocksRemaining,
   [in] DWORD dwEditLocksRemaining
);
Show: