ICAToll::get_Description

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

The get_Description method retrieves a description of the toll.

Syntax

HRESULT get_Description(
  CADescFormat  enFormat,
  BSTR*  pbstr
);

Parameters

  enFormat

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

  pbstr

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

Return Values

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

Remarks

Tolls must support the short description format. The other formats are optional; if the format is not supported, the method returns a NULL string.

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

See Also

• ICAToll Interface