IVsRunningDocTableEvents.OnAfterFirstDocumentLock Method (UInt32, UInt32, UInt32, UInt32)

 

Called after application of the first lock of the specified type to 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)

abstract OnAfterFirstDocumentLock : 
        docCookie:uint32 *
        dwRDTLockType:uint32 *
        dwReadLocksRemaining:uint32 *
        dwEditLocksRemaining:uint32 -> int

Parameters

docCookie
Type: System.UInt32

[in] Abstract value representing the document that has had its first lock applied. See Remarks.

dwRDTLockType
Type: System.UInt32

[in] Specifies the type of document lock. 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.

This method is called after the first read lock is applied to the document and after the first edit lock is applied to the document.

From vsshell.idl:

HRESULT IVsRunningDocTableEvents::OnAfterFirstDocumentLock(
   [in] VSCOOKIE docCookie,
   [in] VSRDTFLAGS dwRDTLockType,
   [in] DWORD dwReadLocksRemaining,
   [in] DWORD dwEditLocksRemaining
);
Return to top
Show: