IVsPackageDefinedTextMarkerType.GetPriorityIndex Method

Article
03/11/2013

Returns the priority index for the custom marker type, with the highest priority value receiving the topmost placement.

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

Syntax

'Declaration
Function GetPriorityIndex ( _
    <OutAttribute> ByRef piPriorityIndex As Integer _
) As Integer

int GetPriorityIndex(
    out int piPriorityIndex
)

int GetPriorityIndex(
    [OutAttribute] int% piPriorityIndex
)

abstract GetPriorityIndex : 
        piPriorityIndex:int byref -> int

function GetPriorityIndex(
    piPriorityIndex : int
) : int

Parameters

piPriorityIndex
Type: System.Int32%
[out] Pointer to the priority index for the type of text marker. For a list of piPriorityIndex values, see MARKERTYPE.

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 IVsPackageDefinedTextMarkerType::GetPriorityIndex(
   [out] long *piPriorityIndex
);

The marker with the highest priority value receives topmost placement during command handling, and each subsequent marker is placed in descending order according to its priority value. Use priority values of 10,000 and higher if your marker should override built-in items like bookmarks and shortcut markers. Use values of 90 to 100 if your marker should not override other markers.

Note

If priority conflicts arise, the environment might assign external markers a uniform, low priority.

.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