Sets or retrieves text to display as the pile's tooltip.

Syntax:

HRESULT get_CommentTooltip(
   BSTR *pbstrText
);

HRESULT put_CommentTooltip(
   BSTR bstrText
);

Parameters:

pbstrText

Address of a string variable to receive the pile's current tooltip text.

bstrText

A string specifying the new tooltip text. If NULL, there will be no comment tooltip.

Return Value:

Returns S_OK if successful, or an error value otherwise.

Remarks:

By default, there is no tooltip displayed. Setting the CommentTooltip property, or setting the ISolpackPile::ShowNumCardsTooltip property to true, will cause the tooltip to be displayed. Setting CommentTooltip to NULL removes any comment associated with the pile; the tooltip will only contain the number of cards, if specified by ISolpackPile::ShowNumCardsTooltip.