IVsTextMarkerTypeProvider.GetTextMarkerType Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

Allows you to return a pointer to your IVsPackageDefinedTextMarkerType implementation for a custom marker type.

public:
 int GetTextMarkerType(Guid % pguidMarker, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsPackageDefinedTextMarkerType ^ % ppMarkerType);

public int GetTextMarkerType (ref Guid pguidMarker, out Microsoft.VisualStudio.TextManager.Interop.IVsPackageDefinedTextMarkerType ppMarkerType);

abstract member GetTextMarkerType : Guid * IVsPackageDefinedTextMarkerType -> int

Public Function GetTextMarkerType (ByRef pguidMarker As Guid, ByRef ppMarkerType As IVsPackageDefinedTextMarkerType) As Integer

Parameters

pguidMarker: Guid

[in] Pointer to a GUID identifying the external marker type.

ppMarkerType: IVsPackageDefinedTextMarkerType

[out] Pointer to the IVsPackageDefinedTextMarkerType implementation for the external marker type.

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 IVsTextMarkerTypeProvider::GetTextMarkerType(  
   [in] GUID *pguidMarker,  
   [out] IVsPackageDefinedTextMarkerType **ppMarkerType  
);

When a package registers an external marker type, this interface is implemented once by the specified service. This method passes you a GUID that matches the GUID of a marker that you have registered under "External Markers." You then need to pass back a pointer to your IVsPackageDefinedTextMarkerType implementation for this marker type.

Note

You do not need to pass back a separate IVsPackageDefinedTextMarkerType instance every time this is called for the same GUID. For a given marker GUID, it can be the same instance each time. The reason for this interface is that you can register any number of marker types.

Applies to

Share via