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)

Syntax

'Declaration
Function OnBeforeLastDocumentUnlock ( _
    docCookie As UInteger, _
    dwRDTLockType As UInteger, _
    dwReadLocksRemaining As UInteger, _
    dwEditLocksRemaining As UInteger _
) As Integer
int OnBeforeLastDocumentUnlock(
    uint docCookie,
    uint dwRDTLockType,
    uint dwReadLocksRemaining,
    uint dwEditLocksRemaining
)
int OnBeforeLastDocumentUnlock(
    [InAttribute] unsigned int docCookie, 
    [InAttribute] unsigned int dwRDTLockType, 
    [InAttribute] unsigned int dwReadLocksRemaining, 
    [InAttribute] unsigned int dwEditLocksRemaining
)
abstract OnBeforeLastDocumentUnlock : 
        docCookie:uint32 * 
        dwRDTLockType:uint32 * 
        dwReadLocksRemaining:uint32 * 
        dwEditLocksRemaining:uint32 -> int
function OnBeforeLastDocumentUnlock(
    docCookie : uint, 
    dwRDTLockType : uint, 
    dwReadLocksRemaining : uint, 
    dwEditLocksRemaining : uint
) : int

Parameters

  • docCookie
    Type: System.UInt32

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

  • dwRDTLockType
    Type: System.UInt32

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

  • dwReadLocksRemaining
    Type: System.UInt32

    [in] The number of read locks remaining.

  • dwEditLocksRemaining
    Type: System.UInt32

    [in] The number of edit locks remaining.

Return Value

Type: System.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
);

.NET Framework Security

See Also

Reference

IVsRunningDocTableEvents Interface

Microsoft.VisualStudio.Shell.Interop Namespace