IVsPackageDefinedTextMarkerType.GetPriorityIndex(Int32) Method
Definition
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.
Returns the priority index for the custom marker type, with the highest priority value receiving the topmost placement.
public:
int GetPriorityIndex([Runtime::InteropServices::Out] int % piPriorityIndex);
int GetPriorityIndex([Runtime::InteropServices::Out] int & piPriorityIndex);
public int GetPriorityIndex (out int piPriorityIndex);
abstract member GetPriorityIndex : int -> int
Public Function GetPriorityIndex (ByRef piPriorityIndex As Integer) As Integer
Parameters
- piPriorityIndex
- Int32
[out] Pointer to the priority index for the type of text marker. For a list of piPriorityIndex
values, see MARKERTYPE.
Returns
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.