IUIX_Combo::InsertItem Method

Revision as of 06:12, 20 May 2015

Inserts new item into combo box.

Syntax

HRESULT InsertItem([in]                      LONG       nInsertBefore,
                   [in]                      BSTR       pText,
                   [in, defaultvalue("")]    BSTR       pTooltip,
                   [in, defaultvalue(NULL)]  IUnknown*  pImage,
                   [in, defaultvalue(0)]     PARAM_T    nItemParam,
                   [in, defaultvalue(0)]     LONG       nItemStyle);

Parameters

nInsertBefore

[in] specifies the position in a list before which a new item should be inserted. To insert new item at the end of combo box list, set this parameter to -1.

pText

[in] specifies text of the new item.

pTooltip

[in, defaultvalue("")] specifies item tooltip.

pImage

[in, optional] adds item image, displayed to the left of item text. pImage object should implement IUIX_Icon or IUIX_ImageData interface.

nItemParam

[in, defaultvalue(0)] sets optional item parameter.

nItemStyle

[in, defaultvalue(0)] sets item style flags. See UIX_ComboItemStyleFlags enumeration for full list of possible item styles.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IUIX_Combo, UIX_ComboItemStyleFlags.