IVsTextLines.CreateLineMarker Method (Int32, Int32, Int32, Int32, Int32, IVsTextMarkerClient, IVsTextLineMarker[])

 

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

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

int CreateLineMarker(
	int iMarkerType,
	int iStartLine,
	int iStartIndex,
	int iEndLine,
	int iEndIndex,
	IVsTextMarkerClient pClient,
	IVsTextLineMarker[] ppMarker
)

Parameters

iMarkerType
Type: System.Int32

[in] Type of marker to create.

iStartLine
Type: System.Int32

[in] Starting line.

iStartIndex
Type: System.Int32

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

iEndLine
Type: System.Int32

[in] Ending line.

iEndIndex
Type: System.Int32

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

pClient
Type: Microsoft.VisualStudio.TextManager.Interop.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
Type: Microsoft.VisualStudio.TextManager.Interop.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.

Return Value

Type: System.Int32

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

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.

System_CAPS_noteNote

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

Return to top
Show: