IVsFontAndColorDefaults.GetItemByName Method

Article
2013-02-04

Returns an AllColorableItemInfo structure containing font and color information for one of the Display Items listed in the Fonts and Colors properties page.

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

Syntax

'Declaration
Function GetItemByName ( _
    szItem As String, _
    <OutAttribute> pInfo As AllColorableItemInfo() _
) As Integer

int GetItemByName(
    string szItem,
    AllColorableItemInfo[] pInfo
)

int GetItemByName(
    [InAttribute] String^ szItem, 
    [OutAttribute] array<AllColorableItemInfo>^ pInfo
)

abstract GetItemByName : 
        szItem:string * 
        pInfo:AllColorableItemInfo[] byref -> int

function GetItemByName(
    szItem : String, 
    pInfo : AllColorableItemInfo[]
) : int

Parameters

szItem
Type: System.String
[in] Null-terminated string containing the name of the item.

pInfo
Type: array<Microsoft.VisualStudio.Shell.Interop.AllColorableItemInfo[]
[out] An AllColorableItemInfo structure, which contains the default attributes of the named item.

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

.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