op_apptrack_instance_complete()
Abstract
Records that an application instance is completed.
Syntax
op_apptrack_instance_complete (apptrack_hndl, instance_id)
| Argument | Type | Description |
|---|---|---|
apptrack_hndl |
Apptrackhandle |
ADT state of interest. |
instance_id |
OpT_uInt32 |
Instance to record as completed. |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the KP completes successfully; OPC_COMPCODE_FAILURE otherwise.
Details
None.
Purpose
This procedure records that an application instance is completed. It timestamps the application instance with its end time, writes the instance to the application instance file, and deletes the instance from memory.
Errors
- Recoverable Error: Argument (
apptrack_hndl) is NIL. - Recoverable Error: Application instance (
<instance_id>) is invalid or has been completed.
Reference
- Use the KP op_apptrack_instance_create() to create an application instance.
- Use the KP op_apptrack_create() to create
apptrack_hndl.