IVsRunningDocTableEvents.OnBeforeLastDocumentUnlock Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public:
 int OnBeforeLastDocumentUnlock(System::UInt32 docCookie, System::UInt32 dwRDTLockType, System::UInt32 dwReadLocksRemaining, System::UInt32 dwEditLocksRemaining);

public:
 int OnBeforeLastDocumentUnlock(unsigned int docCookie, unsigned int dwRDTLockType, unsigned int dwReadLocksRemaining, unsigned int dwEditLocksRemaining);

int OnBeforeLastDocumentUnlock(unsigned int docCookie, unsigned int dwRDTLockType, unsigned int dwReadLocksRemaining, unsigned int dwEditLocksRemaining);

public int OnBeforeLastDocumentUnlock (uint docCookie, uint dwRDTLockType, uint dwReadLocksRemaining, uint dwEditLocksRemaining);

abstract member OnBeforeLastDocumentUnlock : uint32 * uint32 * uint32 * uint32 -> int

Public Function OnBeforeLastDocumentUnlock (docCookie As UInteger, dwRDTLockType As UInteger, dwReadLocksRemaining As UInteger, dwEditLocksRemaining As UInteger) As Integer

Parameters

docCookie

UInt32

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

dwRDTLockType

UInt32

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

dwReadLocksRemaining

UInt32

[in] The number of read locks remaining.

dwEditLocksRemaining

UInt32

[in] The number of edit locks remaining.

Returns

Int32

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

Remarks

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  
);