IVsFontAndColorStorage.GetItem(String, ColorableItemInfo[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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 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

Int32

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

Partager via