IVsHiddenTextClient.GetMarkerCommandInfo Method

Article
11/19/2013

Returns marker command information.

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

Syntax

'Declaration
Function GetMarkerCommandInfo ( _
    pHidReg As IVsHiddenRegion, _
    iItem As Integer, _
    <OutAttribute> pbstrText As String(), _
    <OutAttribute> pcmdf As UInteger() _
) As Integer

int GetMarkerCommandInfo(
    IVsHiddenRegion pHidReg,
    int iItem,
    string[] pbstrText,
    uint[] pcmdf
)

int GetMarkerCommandInfo(
    [InAttribute] IVsHiddenRegion^ pHidReg, 
    [InAttribute] int iItem, 
    [OutAttribute] array<String^>^ pbstrText, 
    [OutAttribute] array<unsigned int>^ pcmdf
)

abstract GetMarkerCommandInfo : 
        pHidReg:IVsHiddenRegion * 
        iItem:int * 
        pbstrText:string[] byref * 
        pcmdf:uint32[] byref -> int

function GetMarkerCommandInfo(
    pHidReg : IVsHiddenRegion, 
    iItem : int, 
    pbstrText : String[], 
    pcmdf : uint[]
) : int

Parameters

pHidReg
Type: Microsoft.VisualStudio.TextManager.Interop.IVsHiddenRegion

[in] Pointer to a hidden region object, IVsHiddenRegion

iItem
Type: System.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
Type: array<System.String[]

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

pcmdf
Type: array<System.UInt32[]

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

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 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.

.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