Edit

Share via

Retrieving Work Item Property Examples

  • Article

To retrieve the properties of a work item, call ITaskScheduler::Activate to retrieve the interface of the work item object, then call the appropriate method to retrieve the task property you are interested in. Currently, the only valid work items are tasks.

The code examples listed at the bottom of this page show how to retrieve the properties that apply to all work items. For other properties that are unique to tasks, see Setting Task Property Examples.

Note

In the following code example, all interfaces are released after they are no longer needed.

 

Note that if you are retrieving a string property (such as comment for a work item), you must call CoTaskMemFree to free the memory allocated for the returned string.

The following procedure describes how to retrieve a task property.

To retrieve a task property

  1. Call CoInitialize to initialize the COM library and CoCreateInstance to get a Task Scheduler object. (These examples assume that the Task Scheduler service is running.)
  2. Call ITaskScheduler::Activate to get the ITask interface of the task object. (Note that tasks are currently the only valid type of work item.)
  3. Call the appropriate method to retrieve the property you are interested in.
  4. Process the property as needed. (These examples simply print the property to the screen.)
  5. If the returned property is a string, call CoTaskMemFree to free the memory allocated for the returned string.
For a code example of See
Retrieving the account information of a known task C/C++ Code Example: Retrieving Task Account Information
Retrieving the comment string of a known task C/C++ Code Example: Retrieving a Task Comment
Retrieving the name of the creator of the task and displaying it on the screen C/C++ Code Example: Retrieving the Task Creator
Retrieving the last exit code returned by a known task C/C++ Code Example: Retrieving Task Exit Code
Retrieving the idle-wait time of the task and displaying it on the screen C/C++ Code Example: Retrieving Task Idle-wait Time
Retrieving the time the task was last run and displaying it on the screen C/C++ Code Example: Retrieving the Task MostRecentRun Time
Retrieving the next time the task is scheduled to run and displaying that time on the screen C/C++ Code Example: Retrieving the Task NextRun Time
Retrieving the run times of the task and displaying them on the screen C/C++ Code Example: Retrieving Task Run Times
Retrieving the current status of the task and displaying it on the screen C/C++ Code Example: Retrieving Task Status

 

Task Scheduler 1.0 Examples