IVsFontAndColorGroup.GetPriority Method

Article
03/06/2013

Returns a group's display priority, which determines its position in the Show settings for: drop-down box of the Fonts and Colors property page.

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

Syntax

'Declaration
Function GetPriority ( _
    <OutAttribute> ByRef pPriority As UShort _
) As Integer

int GetPriority(
    out ushort pPriority
)

int GetPriority(
    [OutAttribute] unsigned short% pPriority
)

abstract GetPriority : 
        pPriority:uint16 byref -> int

function GetPriority(
    pPriority : ushort
) : int

Parameters

pPriority
Type: System.UInt16%
[out] Reference to a value containing the priority value of the group.

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 vsshell.idl:

HRESULT IVsFontAndColorGroup::GetPriority(
   [out] FCPRIORITY *pPriority
);

Priority is zero-based, and items with a lower priority number are placed higher in the category list.

The values returned should respect the groupings within that list defined by the __FCPRIORITY enumeration.

For instance the priority returned by GetPriority for a Text Editor and Printer categories should be greater than or equal to FCP_EDITOR but less than FCP_ENVIRONMENT.

.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