Microsoft DirectX 8.1 (C++)

ICAOffer::put_Description

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

The put_Description method specifies a description of the offer.

Syntax

HRESULT put_Description(
  CADescFormat  enFormat,
  BSTR  bstr
);

Parameters

  enFormat

[in]   Member of the CADescFormat Enumeration type, specifying the format of the description.

  bstr

[in]  String containing the description.

Return Values

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

Remarks

After a policy creates a new offer, it should call this method to set the long, HTML, and XML descriptions. An application might be attempting to display one of these formats, so the policy should call this method as soon as possible.

See Also