IVsFontAndColorGroup.GetPriority(UInt16) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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 a group's display priority, which determines its position in the Show settings for: drop-down box of the Fonts and Colors property page.

public:
 int GetPriority([Runtime::InteropServices::Out] System::UInt16 % pPriority);

int GetPriority([Runtime::InteropServices::Out] unsigned short & pPriority);

public int GetPriority (out ushort pPriority);

abstract member GetPriority : uint16 -> int

Public Function GetPriority (ByRef pPriority As UShort) As Integer

Parameters

pPriority: UInt16

[out] Reference to a value containing the priority value of the group.

Returns

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.

Applies to