IVsTextLayer.MapLocalSpansToTextOriginatingLayer Method

Article
11/19/2013

Maps a set of local spans to the shallowest layer that originates text.

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

Syntax

'Declaration
Function MapLocalSpansToTextOriginatingLayer ( _
    dwFlags As UInteger, _
    pLocalSpanEnum As IVsEnumTextSpans, _
    <OutAttribute> ByRef ppTargetLayer As IVsTextLayer, _
    <OutAttribute> ByRef ppTargetSpanEnum As IVsEnumTextSpans _
) As Integer

int MapLocalSpansToTextOriginatingLayer(
    uint dwFlags,
    IVsEnumTextSpans pLocalSpanEnum,
    out IVsTextLayer ppTargetLayer,
    out IVsEnumTextSpans ppTargetSpanEnum
)

int MapLocalSpansToTextOriginatingLayer(
    [InAttribute] unsigned int dwFlags, 
    [InAttribute] IVsEnumTextSpans^ pLocalSpanEnum, 
    [OutAttribute] IVsTextLayer^% ppTargetLayer, 
    [OutAttribute] IVsEnumTextSpans^% ppTargetSpanEnum
)

abstract MapLocalSpansToTextOriginatingLayer : 
        dwFlags:uint32 * 
        pLocalSpanEnum:IVsEnumTextSpans * 
        ppTargetLayer:IVsTextLayer byref * 
        ppTargetSpanEnum:IVsEnumTextSpans byref -> int

function MapLocalSpansToTextOriginatingLayer(
    dwFlags : uint, 
    pLocalSpanEnum : IVsEnumTextSpans, 
    ppTargetLayer : IVsTextLayer, 
    ppTargetSpanEnum : IVsEnumTextSpans
) : int

Parameters

dwFlags
Type: System.UInt32

[in] One of the MapLocalSpanFlags values.

pLocalSpanEnum
Type: Microsoft.VisualStudio.TextManager.Interop.IVsEnumTextSpans

[in] The local text spans to be mapped.

ppTargetLayer
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer%

[out] The shallowest layer that originates text.

ppTargetSpanEnum
Type: Microsoft.VisualStudio.TextManager.Interop.IVsEnumTextSpans%

[out] The mapped layer set of text spans.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextLayer::MapLocalSpansToTextOriginatingLayer(
   [in] DWORD dwFlags,
   [in] IVsEnumTextSpans *pLocalSpanEnum,
   [out] IVsTextLayer **ppTargetLayer,
   [out] IVsEnumTextSpans **ppTargetSpanEnum
);

MapLocalSpansToTextOriginatingLayer will take a set of local spans and map them down to the shallowest layer that originates text. You are not guaranteed that you will get back the layer that actually originates a given set of text, that is, text which excludes non-text atoms.

.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