Share via


IVsTextImage.LockImage(UInt32) Method

Definition

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

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