Description |
| Adds annotations to provided combined state item. |
Synopsis |
#include <ProCombstate.h> |
ProError | ProCombstateAnnotationsAdd | ( |
| ProCombstate* cs_item | |
| /*
(In) |
| The handle to a combined state item. |
| */ |
| ProAnnotation* annotations | |
| /*
(In) |
| ProArray of annotations. |
| */ |
| int* status_flags | |
| /*
(In) |
| ProArray of integers. Each annotation can be included, or excluded in the combined state. 0 value means that annotation is included in the combined state, 1 excluded. |
| */ |
) |
Returns |
|
PRO_TK_NO_ERROR | | The function successfully added annotations. |
PRO_TK_BAD_INPUTS | | One or more of the input arguments are invalid. |
PRO_TK_INVALID_ITEM | | size of status_flags' array differs from the size of annotations' array. |
PRO_TK_E_NOT_FOUND | | This legacy combined state doesn't have annotation state. Annotations cannot be added. |
PRO_TK_NO_CHANGE | | Status of some annotations wasn't changed. Some annotations existed in the combined state already and their status was same as the one in the input. |
Other | | Another error occurred and the function failed. |
|