TaskProgress Class

TaskProgress Class

Raised by:  SALT application, Speech Controls
Base Class:   ApplicationTaskEvent
Derived Classes:  None

TaskProgress defines a way for SALT application developers to send an event to the Trace log that records the progress of a defined application task.

TaskProgress has the following properties:

Property

Type

Description

TaskName

String

The name of the application task.

Message

String

A message provided by the developer that gives information about the task in progress.

EventData

String

A text string provided by the developer that gives additional data associated with the message.
For example, for the message "updating balance," EventData might be populated with information describing the computer running SQL Server, where the data lives, the actual query returning results, and other similar information.

Example

import Microsoft.SpeechServer.Messages;

if ( TaskProgress.IsEnabled() )
{
    // Raise a task progress event
    TaskProgress.Raise( "Account update", "querying balance", "account/server/database details here");
}

Remarks

In the normal sequence of events, for a given TaskName, an associated TaskStart, TaskProgress, and TaskComplete event would appear in the logs.

See Also

Event Logging Class Hierarchy | Logging and Analyzing Events | CommonEvent | Event Filters | Filtering Logged Events