IVsRunningDocTableEvents.OnAfterFirstDocumentLock Method

Article
02/04/2013

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)

Syntax

'Declaration
Function OnAfterFirstDocumentLock ( _
    docCookie As UInteger, _
    dwRDTLockType As UInteger, _
    dwReadLocksRemaining As UInteger, _
    dwEditLocksRemaining As UInteger _
) As Integer

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

int OnAfterFirstDocumentLock(
    [InAttribute] unsigned int docCookie, 
    [InAttribute] unsigned int dwRDTLockType, 
    [InAttribute] unsigned int dwReadLocksRemaining, 
    [InAttribute] unsigned int dwEditLocksRemaining
)

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

function OnAfterFirstDocumentLock(
    docCookie : uint, 
    dwRDTLockType : uint, 
    dwReadLocksRemaining : uint, 
    dwEditLocksRemaining : uint
) : 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.

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via