IVsRunningDocTableEvents.OnAfterFirstDocumentLock Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Called after application of 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 that has had its first lock applied. See Remarks.

dwRDTLockType

UInt32

[in] Specifies the type of document lock. 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 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 IVsRunningDocTableEvents::OnAfterFirstDocumentLock(  
   [in] VSCOOKIE docCookie,  
   [in] VSRDTFLAGS dwRDTLockType,  
   [in] DWORD dwReadLocksRemaining,  
   [in] DWORD dwEditLocksRemaining  
);