IVsTextImage.LockImage(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.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.

Notifies that the text image is in use.

public:
 int LockImage(System::UInt32 grfLock);

public:
 int LockImage(unsigned int grfLock);

int LockImage(unsigned int grfLock);

public int LockImage (uint grfLock);

abstract member LockImage : uint32 -> int

Public Function LockImage (grfLock As UInteger) As Integer

Parameters

grfLock: UInt32

[in] Specifies a locking flag. Values are taken from the BufferLockFlags enumeration.

Returns

Int32

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

Remarks

The environment notifies you that it is locking a text image. You must not make modifications while the lock is on. Once a lock is no longer needed, the environment will call UnlockImage to release the lock.

COM Signature

From textmgr.idl:

HRESULT IVsTextImage::LockImage(  
   [in] DWORD grfLock  
);

Applies to