Partager via


IVsFontAndColorStorage.GetItem(String, ColorableItemInfo[]) Method

Definition

Returns the user-modifiable information for a named Display Item in the currently open Category.

public:
 int GetItem(System::String ^ szName, cli::array <Microsoft::VisualStudio::Shell::Interop::ColorableItemInfo> ^ pInfo);
public:
 int GetItem(Platform::String ^ szName, Platform::Array <Microsoft::VisualStudio::Shell::Interop::ColorableItemInfo> ^ pInfo);
int GetItem(std::wstring const & szName, std::Array <Microsoft::VisualStudio::Shell::Interop::ColorableItemInfo> const & pInfo);
public int GetItem (string szName, Microsoft.VisualStudio.Shell.Interop.ColorableItemInfo[] pInfo);
abstract member GetItem : string * Microsoft.VisualStudio.Shell.Interop.ColorableItemInfo[] -> int
Public Function GetItem (szName As String, pInfo As ColorableItemInfo()) As Integer

Parameters

szName
String

[in] Null-terminated string containing the non-localized name of the Display Item in the currently open Category.

pInfo
ColorableItemInfo[]

[in, out] Reference to an allocated ColorableItemInfo object to contain information about the Display Item in the currently open Category.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsFontAndColorStorage::GetItem(  
   [in] LPCOLESTR szName,  
   [in, out] ColorableItemInfo *pInfo  
);  

The information returned by this method provides a snap shot of the current state of stored fonts and colors.

It is the responsibility of the applications rendering text to the Visual Studio environment to update their display to match the settings returned by this method.

Applies to