IVsFontAndColorDefaults.GetItemByName(String, AllColorableItemInfo[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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 an AllColorableItemInfo structure containing font and color information for one of the Display Items listed in the Fonts and Colors properties page.

public:
 int GetItemByName(System::String ^ szItem, cli::array <Microsoft::VisualStudio::Shell::Interop::AllColorableItemInfo> ^ pInfo);

int GetItemByName(std::wstring const & szItem, std::Array <Microsoft::VisualStudio::Shell::Interop::AllColorableItemInfo> const & pInfo);

public int GetItemByName (string szItem, Microsoft.VisualStudio.Shell.Interop.AllColorableItemInfo[] pInfo);

abstract member GetItemByName : string * Microsoft.VisualStudio.Shell.Interop.AllColorableItemInfo[] -> int

Public Function GetItemByName (szItem As String, pInfo As AllColorableItemInfo()) As Integer

Parameters

szItem: String

[in] Null-terminated string containing the name of the item.

pInfo: AllColorableItemInfo[]

[out] An AllColorableItemInfo structure, which contains the default attributes of the named item.

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 IVsFontAndColorDefaults::GetItemByName(  
   [in] LPCOLESTR szItem,  
   [out] AllColorableItemInfo *pInfo  
);

Do not localize the item name. The szItem parameter is the non-localized invariant name for an item contained in the bstrName field of the AllColorableItemInfo structure.

Applies to

Share via