IVsTextStream.LockBuffer Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

Locks the text buffer for the purpose of access control.

public:
 int LockBuffer();

public:
 int LockBuffer();

int LockBuffer();

public int LockBuffer ();

abstract member LockBuffer : unit -> int

Public Function LockBuffer () As Integer

Returns

Int32

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

Implements

LockBuffer()

Remarks

Starting in Visual Studio 2010, you should access the text buffer on the UI thread, not on background threads. The text buffer no longer gets locked when you call LockBuffer or LockBufferEx. Similarly, the UnlockBuffer and UnlockBufferEx methods no longer have any effect.

COM Signature

From textmgr.idl:

HRESULT IVsTextStream::LockBuffer();

When the LockBuffer method is called by one thread, no other thread can perform write operations on the buffer. To unlock the buffer, call UnlockBuffer.

Applies to

Compartilhar via