ICAOffer::get_Description

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The get_Description method retrieves a description of the offer.

Syntax

HRESULT get_Description(
  CADescFormat  enFormat,
  BSTR*  pbstr
);

Parameters

  enFormat

[in]  Member of the CADescFormat enumeration, specifying the format to retrieve.

  pbstr

[out]  Pointer to a string that receives the description.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The caller must free the returned string, using the SysFreeString function.

See Also

• ICAOffer Interface
• ICAOffer::put_Description