GetRunningTaskProgress

Returns a given running task’s percentage complete, status, last update time, and description.

Syntax

<HFMwSystemInfo>.GetRunningTaskProgress (lTaskID, pvlStatus, pvdLastUpdateTime, pvbstrDesc)

Argument

Description

lTaskID

The ID of the task.

Tip:

You can obtain the IDs of all running tasks with EnumRunningTasks.

Input argument. Long subtype.

pvlStatus

Returns the status of the task. Valid values are represented by the HFMConstants type library constants listed in Task Status Constants.

Input/output argument.

pvdLastUpdateTime

Returns the timestamp of the last time the task was updated. The timestamp is formatted as a Double that can be cast to the Date format.

Input/output argument.

pvbstrDesc

Returns the task’s description.

Input/output argument.

Return Value

Returns the progress complete percentage of the task.