IVsTextImage::Replace Method (UInt32, array<TextSpan>^, Int32, String^, array<TextSpan>^)

Visual Studio 2015

Notification of a text span replacement.

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

Syntax

C++

int Replace(
	unsigned int dwFlags,
	array<TextSpan>^ pts,
	int cch,
	String^ pchText,
	array<TextSpan>^ ptsChanged
)

Parameters

dwFlags: Type: System::UInt32
[in] Double word containing flags. For future use. Set to zero.

pts: Type: array<Microsoft.VisualStudio.TextManager.Interop::TextSpan>^
[in] Pointer to a TextSpan structure.

cch: Type: System::Int32
[in] Count of characters in pchText.

pchText: Type: System::String^
[in] Pointer to a text string.

ptsChanged: Type: array<Microsoft.VisualStudio.TextManager.Interop::TextSpan>^
[out] Specifies the modified TextSpan structure.

Return Value

Type: System::Int32

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

Remarks

The environment will call IVsTextImage.Replace to notify you of a replace operation done on a text span. Return the new text span to the environment.

COM Signature

From textmgr.idl:

C++

HRESULT IVsTextImage::Replace(
   [in] DWORD dwFlags,
   [in] const TextSpan * pts,
   [in] LONG cch,
   [in, size_is(cch)] LPCOLESTR pchText,
   [out, retval] TextSpan * ptsChanged
);