IVsTextImage.LockImage Method

Article
2013-03-11

Notifies that the text image is in use.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Declaration
Function LockImage ( _
    grfLock As UInteger _
) As Integer

int LockImage(
    uint grfLock
)

int LockImage(
    [InAttribute] unsigned int grfLock
)

abstract LockImage : 
        grfLock:uint32 -> int

function LockImage(
    grfLock : uint
) : int

Parameters

grfLock
Type: System.UInt32
[in] Specifies a locking flag. Values are taken from the BufferLockFlags enumeration.

Return Value

Type: System.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
);

.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