__VSREGDOCLOCKHOLDER Enum

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Specifies a weak lock in calls to the RegisterDocumentLockHolder(UInt32, UInt32, IVsDocumentLockHolder, UInt32) method.

public enum class __VSREGDOCLOCKHOLDER

public enum class __VSREGDOCLOCKHOLDER

enum __VSREGDOCLOCKHOLDER

public enum __VSREGDOCLOCKHOLDER

type __VSREGDOCLOCKHOLDER =

Public Enum __VSREGDOCLOCKHOLDER

Inheritance: Enum
__VSREGDOCLOCKHOLDER

Fields

RDLH_WeakLockHolder

Specifies a weak document lock holder.

Remarks

COM Signature

From vsshell.idl:

enum __VSREGDOCLOCKHOLDER {  
    RDLH_WeakLockHolder = 0x00000001  
};  
typedef DWORD VSREGDOCLOCKHOLDER;

The RDLH_WeakLockHolder flag identifies the document lock holder that is passed to the RegisterDocumentLockHolder method as a weak lock holder. A weak lock holder can obtain an EditLock (a lock on a document that can be changed) only if there are no other edit locks. A weak lock holder must first check the existing lock count, and take its EditLock, only if there are no other EditLocks. It should take its EditLock before calling the RegisterDocumentLockHolder method.

When another document holder requests an EditLock on a document and the current lock holder is a weak lock holder, the CloseDocumentHolder method on the current lock holder is called when the EditLock is given to the new document holder.

Applies to