DesignerDocDataService.IVsRunningDocTableEvents.OnAfterFirstDocumentLock Method

Article
2013-02-04

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

Namespace: Microsoft.VisualStudio.Shell.Design.Serialization
Assembly: Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

Syntax

'Declaration
Private Function OnAfterFirstDocumentLock ( _
    docCookie As UInteger, _
    lockType As UInteger, _
    readLocksRemaining As UInteger, _
    editLocksRemaining As UInteger _
) As Integer Implements IVsRunningDocTableEvents.OnAfterFirstDocumentLock

int IVsRunningDocTableEvents.OnAfterFirstDocumentLock(
    uint docCookie,
    uint lockType,
    uint readLocksRemaining,
    uint editLocksRemaining
)

private:
virtual int OnAfterFirstDocumentLock(
    unsigned int docCookie, 
    unsigned int lockType, 
    unsigned int readLocksRemaining, 
    unsigned int editLocksRemaining
) sealed = IVsRunningDocTableEvents::OnAfterFirstDocumentLock

private abstract OnAfterFirstDocumentLock : 
        docCookie:uint32 * 
        lockType:uint32 * 
        readLocksRemaining:uint32 * 
        editLocksRemaining:uint32 -> int 
private override OnAfterFirstDocumentLock : 
        docCookie:uint32 * 
        lockType:uint32 * 
        readLocksRemaining:uint32 * 
        editLocksRemaining:uint32 -> int

JScript does not support explicit interface implementations.

Parameters

docCookie
Type: System.UInt32
The identifier of the document data object in the Running Document Table.

lockType
Type: System.UInt32
A __VSRDTFLAGS value specifying the lock type.

readLocksRemaining
Type: System.UInt32
The number of read locks remaining.

editLocksRemaining
Type: System.UInt32
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.

Implements

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

Remarks

This method registers a lock holder on the primary document data object once the lock has been acquired.

.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