IASProvidePowerListBoxCommandData::GetCaption

This method retrieves the caption associated with a particular command item.

Syntax

HRESULT GetCaption( long lIndex, long lItemId, long lItemData, BSTR *pbstrCaption );

Parameters

lIndex: Long integer that contains the index of the item.
lItemId: Long integer that contains the identifier of the item.
lItemData: Long integer that contains data associated with the item.
pbstrCaption: Pointer to the Unicode string to be displayed as a caption in the power list box.

Return Values

NOERROR indicates success. E_OUTOFMEMORY indicates that the system is out of memory.

Remarks

The IASProvidePowerListBoxCommandData::GetCaption method is called by the power list box control to obtain the display text for items with Null captions. It must be registered by calling IASPowerListBox::put_ProvideCommandDataSink. This method should return a SysAllocString BSTR because the power list box calls SysFreeString on it when drawing is complete.