Microsoft DirectX 8.1 (C++)

ICAToll.Description

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

The Description property retrieves a description of the toll.

Syntax

objCAToll.Description(
    enFormat As CADescFormat) As String

Parameters

  enFormat

CADescFormat constant, specifying the format to return.

Error Codes

If the property fails, an error is raised and Err.Number is set to a value other than zero.

Return Values

Returns a string containing the description.

Remarks

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

This property is read-only.

See Also