IVsFontAndColorStorage.GetItem Method

Article
10/26/2012

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

'Declaration
Function GetItem ( _
    szName As String, _
    <OutAttribute> pInfo As ColorableItemInfo() _
) As Integer

'Usage
Dim instance As IVsFontAndColorStorage 
Dim szName As String 
Dim pInfo As ColorableItemInfo()
Dim returnValue As Integer 

returnValue = instance.GetItem(szName, _
    pInfo)

int GetItem(
    string szName,
    ColorableItemInfo[] pInfo
)

int GetItem(
    [InAttribute] String^ szName, 
    [InAttribute] [OutAttribute] array<ColorableItemInfo>^ pInfo
)

function GetItem(
    szName : String, 
    pInfo : ColorableItemInfo[]
) : int

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:

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via