MKS Integrity 2007 Integrations Builder Guide

Chapter 3: Using the MKS API
22
C Example: Retrieving Work Items
response = mksCmdRunnerExecCmd(cr, cmd, NO_INTERIM);
workItem = mksResponseGetFirstWorkItem(response);
/* Do something with the first work item. */
while ((workItem = mksResponseGetNextWorkItem(response)) != NULL) {
/* Do something with the work item. */
}
Each retrieved work item contains an ID, a context (if needed), a display string, a model type
(for example, state, issue), and, optionally, a result.
Retrieving Work Item Results
Each work item optionally contains information about the action taken. For example, if you
run si resync and there is nothing to resynchronize for a particular member, there is no
result for that work item, indicating that no action was taken. If an action was taken, there is a
result. In the case of si resync, the result is the revision that was checked out. The following
examples show how to retrieve result information for a work item.
Java Example: Retrieving Work Item Results
String newRevisionId =
workItem.getResult().getPrimaryValue().getId();
C Example: Retrieving Work Item Results
result = mksWorkItemGetResult(workItem);
item = mksResultGetPrimaryValue(result);
newId = (wchar_t *) malloc(256*sizeof(wchar_t));
rtn = mksItemGetId(item, newId, 256 * sizeof(wchar_t));
View Commands
View commands provide access to the current state of information within an application.
Typically, the command names are either the name of the item type to be viewed (for
example, issues, sandboxes), or they start with the word “view”. The response for a view
command communicates the content of the item being viewed, no matter how complex.
Like action commands, view commands always return work items, command exceptions,
and work item exceptions. Unlike action commands, a view command does not need to
report the results of an action.
Retrieving View Information
Work items can be retrieved from the response for view commands in the same way as they
are for action commands.
Once you have identified the work items, you can access their content. All work item content
is contained in fields. You can access the information in the fields without parsing. The fields
are either the basic data types (for example, string, Boolean) or contain a list of basic data