IVsRunningDocTableEvents2.OnAfterFirstDocumentLock Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Called after applying the first lock of the specified type to the specified document in the Running Document Table (RDT).

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

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

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

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

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

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

Parameters

docCookie: UInt32

[in] Abstract value representing the document whose attributes have been changed.

dwRDTLockType: UInt32

[in] Specifies the type of document lock. Values are taken from the _VSRDTFLAGS enumeration.

dwReadLocksRemaining: UInt32

[in] Specifies the number of read locks remaining.

dwEditLocksRemaining: UInt32

[in] Specifies the number of edit locks remaining.

Returns

Int32

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

Implements

OnAfterFirstDocumentLock(UInt32, UInt32, UInt32, UInt32)

Remarks

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.

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocTableEvents2::OnAfterFirstDocumentLock(  
   [in] VSCOOKIE docCookie,  
   [in] VSRDTFLAGS dwRDTLockType,  
   [in] DWORD dwReadLocksRemaining,  
   [in] DWORD dwEditLocksRemaining  
);

Applies to