IVsRunningDocumentTable.LockDocument(UInt32, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Obtains a read or edit lock on a document when it is opened.

public:
 int LockDocument(System::UInt32 grfRDTLockType, System::UInt32 dwCookie);

public:
 int LockDocument(unsigned int grfRDTLockType, unsigned int dwCookie);

int LockDocument(unsigned int grfRDTLockType, unsigned int dwCookie);

public int LockDocument (uint grfRDTLockType, uint dwCookie);

abstract member LockDocument : uint32 * uint32 -> int

Public Function LockDocument (grfRDTLockType As UInteger, dwCookie As UInteger) As Integer

Parameters

grfRDTLockType: UInt32

[in] Flag whose value is taken from the _VSRDTFLAGS enumeration.

dwCookie: UInt32

[in] Abstract value representing the open document for which a read or an edit lock is to be obtained.

Returns

Int32

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

Remarks

This method must be accessed on the main thread.

Applies to

Share via