IVsHiddenTextClient.GetMarkerCommandInfo Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Returns marker command information.

public:
 int GetMarkerCommandInfo(Microsoft::VisualStudio::TextManager::Interop::IVsHiddenRegion ^ pHidReg, int iItem, cli::array <System::String ^> ^ pbstrText, cli::array <System::UInt32> ^ pcmdf);

public:
 int GetMarkerCommandInfo(Microsoft::VisualStudio::TextManager::Interop::IVsHiddenRegion ^ pHidReg, int iItem, Platform::Array <Platform::String ^> ^ pbstrText, Platform::Array <unsigned int> ^ pcmdf);

int GetMarkerCommandInfo(Microsoft::VisualStudio::TextManager::Interop::IVsHiddenRegion const & pHidReg, int iItem, std::Array <std::wstring const &> const & pbstrText, std::Array <unsigned int> const & pcmdf);

public int GetMarkerCommandInfo (Microsoft.VisualStudio.TextManager.Interop.IVsHiddenRegion pHidReg, int iItem, string[] pbstrText, uint[] pcmdf);

abstract member GetMarkerCommandInfo : Microsoft.VisualStudio.TextManager.Interop.IVsHiddenRegion * int * string[] * uint32[] -> int

Public Function GetMarkerCommandInfo (pHidReg As IVsHiddenRegion, iItem As Integer, pbstrText As String(), pcmdf As UInteger()) As Integer

Parameters

pHidReg

IVsHiddenRegion

[in] Pointer to a hidden region object, IVsHiddenRegion

iItem

Int32

[in] Integer identifying the item number for a marker type's context menu command. Values typically range from 0 to 9, but the marker type may also support command values 101 through 103. For more information about these command values, see MarkerCommandValues.

pbstrText

String[]

[out] Pointer to a string identifying the marker type command text for the context menu.

pcmdf

UInt32[]

[out] Specifies command flags. Values for pcmdf are taken from the OLECMDF enumeration in the Platform SDK.

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 IVsHiddenTextClient::GetMarkerCommandInfo(  
   [in] IVsHiddenRegion *pHidReg,   
   [in] long iItem,   
   [out, custom(uuid_IVsHiddenTextClient, "optional")] BSTR * pbstrText,   
   [out] DWORD* pcmdf  
);  

Use this method to return command information associated with a given marker type. Use ExecMarkerCommand to execute the command against the marker type.