IVsFontAndColorStorage::GetItem Method (String^, array<ColorableItemInfo>^)

Visual Studio 2015

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

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

Syntax

C++

int GetItem(
	String^ szName,
	array<ColorableItemInfo>^ pInfo
)

Parameters

szName: Type: System::String^
[in] Null-terminated string containing the non-localized name of the Display Item in the currently open Category.

pInfo: Type: array<Microsoft.VisualStudio.Shell.Interop::ColorableItemInfo>^
[in, out] Reference to an allocated ColorableItemInfo object to contain information about the Display Item in the currently open Category.

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:

C++

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.