class CancellationDetails

  • Article

Contains detailed information about why a result was canceled.

Members

Reason

Syntax: public const CancellationReason & Reason;

The reason the result was canceled.

ErrorCode

Syntax: public const CancellationErrorCode & ErrorCode;

The error code in case of an unsuccessful recognition (Reason is set to Error). If Reason is not Error, ErrorCode is set to NoError. Added in version 1.1.0.

ErrorDetails

Syntax: public const std::string ErrorDetails;

The error message in case of an unsuccessful recognition (Reason is set to Error).

FromResult

Syntax: public inline static std::shared_ptr< CancellationDetails > FromResult ( std::shared_ptr< RecognitionResult > result );

Creates an instance of CancellationDetails object for the canceled RecognitionResult.

Parameters

  • result The result that was canceled.

Returns

A shared pointer to CancellationDetails.