WMFetchProcessInstanceAttributes WMFetchProcessInstanceAttributesThis call returns all the process instance attributes depending upon the filter criterion. This command returns a process instance attribute. This fetch call will return subsequent process instance attributes after every call. The fetch process is complete when the call returns the error WM_NO_MORE_DATA.
The fetch call will return the attribute value as well in a buffer specified in the call. If buffer_size is NULL then the attribute value will not be returned. If buffer_size is not large enough to hold the attribute value then the call will return as much of the attribute value as can be fit in the buffer. The proper length of the attribute value is available in the attribute_length field. The application can compare the attribute_length with the buffer_size to determine if the full value was returned.
You can view the XML input and output parameters which have to be passed for fetching the process instance attribute and displaying it. There is a list of errors and warning that can occur in the process.
* implies for the mandatory parameter.
|
Name |
Parent Tag |
Description |
Valid Value |
|
Option * |
Root |
It refers to the case sensitive call name. |
case sensitive call name. |
|
EngineName * |
Root |
It is the cabinet or database name, which has to be connected. |
NA |
|
SessionID * |
Root |
It is the logged in user session id |
NA |
|
ProcessInstanceID * |
Root |
It is the process instance id whose attributes are to be fetched. |
NA |
|
CountFlag |
Root |
It is the flag which determines whether to fetch the total number of elements or not. |
"Y"- for Yes to fetch the elements. "N"- for not fetching the total count. |
|
Type |
Filter |
It is the type of the attribute |
NA |
|
AttributeName |
Filter |
It is the attribute name for filteration |
NA |
|
Comparision |
Filter |
It is the operator for filter |
NA |
|
FilterString |
Filter |
It is the SQL string. |
NA |
|
NoOfRecordsToFetch |
BatchInfo |
It is the batch size for fetching the attributes. |
NA |
|
LastValue |
BatchInfo |
It is the last value that is fetched. |
NA |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
Name |
Attribute |
It is the name of the attribute |
|
Type |
Attribute |
It is the type of the attribute |
|
Length |
Attribute |
It is the length of the attribute. |
|
Value |
Attribute |
It is the value of the attribute |
|
RetrieveCount |
Root |
It is the total number of attributes retrieved. |
|
Code |
Constant Value |
Message |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session. |
|
12 |
WM_INVALID_QUERY_HANDLE |
WM_INVALID_QUERY_HANDLE |
|
18 |
WM_NO_MORE_DATA |
No more records |