IVsTextLines.CreateLineMarker Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Creates a marker of a given type over the specified region.

public:
 int CreateLineMarker(int iMarkerType, int iStartLine, int iStartIndex, int iEndLine, int iEndIndex, Microsoft::VisualStudio::TextManager::Interop::IVsTextMarkerClient ^ pClient, cli::array <Microsoft::VisualStudio::TextManager::Interop::IVsTextLineMarker ^> ^ ppMarker);

public:
 int CreateLineMarker(int iMarkerType, int iStartLine, int iStartIndex, int iEndLine, int iEndIndex, Microsoft::VisualStudio::TextManager::Interop::IVsTextMarkerClient ^ pClient, Platform::Array <Microsoft::VisualStudio::TextManager::Interop::IVsTextLineMarker ^> ^ ppMarker);

int CreateLineMarker(int iMarkerType, int iStartLine, int iStartIndex, int iEndLine, int iEndIndex, Microsoft::VisualStudio::TextManager::Interop::IVsTextMarkerClient const & pClient, std::Array <Microsoft::VisualStudio::TextManager::Interop::IVsTextLineMarker const &> const & ppMarker);

public int CreateLineMarker (int iMarkerType, int iStartLine, int iStartIndex, int iEndLine, int iEndIndex, Microsoft.VisualStudio.TextManager.Interop.IVsTextMarkerClient pClient, Microsoft.VisualStudio.TextManager.Interop.IVsTextLineMarker[] ppMarker);

abstract member CreateLineMarker : int * int * int * int * int * Microsoft.VisualStudio.TextManager.Interop.IVsTextMarkerClient * Microsoft.VisualStudio.TextManager.Interop.IVsTextLineMarker[] -> int

Public Function CreateLineMarker (iMarkerType As Integer, iStartLine As Integer, iStartIndex As Integer, iEndLine As Integer, iEndIndex As Integer, pClient As IVsTextMarkerClient, ppMarker As IVsTextLineMarker()) As Integer

Parameters

iMarkerType: Int32

[in] Type of marker to create.

iStartLine: Int32

[in] Starting line.

iStartIndex: Int32

[in] Starting character index within the line. Must be less than or equal to the length of the line.

iEndLine: Int32

[in] Ending line.

iEndIndex: Int32

[in] Ending character index within the line. Must be less than or equal to the length of the line.

pClient: IVsTextMarkerClient

[in] Pointer to the IVsTextMarkerClient interface. Implement this interface to advise the text buffer that you want to receive notification of marker events.

ppMarker: IVsTextLineMarker[]

[out] Pointer to the IVsTextLineMarker interface (that is, the text marker). If this parameter is null, then the marker is owned by the text buffer. An example of a buffer-owned marker is a temporary bookmark.

Returns

Int32

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

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextLines::CreateLineMarker(  
   [in] long iMarkerType,  
   [in] long iStartLine,  
   [in] CharIndex iStartIndex,  
   [in] long iEndLine,  
   [in] CharIndex iEndIndex,  
   [in] IVsTextMarkerClient * pClient,  
   [out] IVsTextLineMarker ** ppMarker  
);

This method creates a marker over the specified region. If you want to listen to marker events for the buffer, then pass in a pointer to the IVsTextMarkerClient interface in the pClient parameter.

Note

The markers created using IVsTextLines.CreateLineMarker are line-oriented markers. Use CreateStreamMarker to create stream-oriented markers.

Applies to

Share via