IVsTextBufferCoordinator::SetSpanMappings Method (Int32, array<NewSpanMapping>^)

Visual Studio 2015

Establishes the list of mappings between the primary and secondary buffers.

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

Syntax

C++

int SetSpanMappings(
	int cSpans,
	array<NewSpanMapping>^ rgSpans
)

Parameters

cSpans: Type: System::Int32
[in] The number of mappings specified in the rgSpans array.

rgSpans: Type: array<Microsoft.VisualStudio.TextManager.Interop::NewSpanMapping>^
[in] An array of NewSpanMapping structures each of which specify a single mapping between the primary and secondary buffers.

Return Value

Type: System::Int32

If successful, returns S_OK; otherwise, returns an error code.

Remarks

COM Signature

From singlefileeditor.idl:

C++

HRESULT SetSpanMappings(
   [in]                  long            cSpans,
   [in, size_is(cSpans)] NewSpanMapping *rgSpans
);

This method replaces any existing mappings.

This method returns an E_INVALIDARG error code if the buffer mapping mode (as set in a call to the SetBufferMappingModes method) for the primary buffer is set to BCMM_ENTIREBUFFER and the number of spans specified by the cSpans parameter is greater than 1.