EMBR gate, INQUIRE_TIMER function
The INQUIRE_TIMER function returns information about the named timer.
Input Parameters
- TIMER_NAME
- is the name of the timer.
- ACTIVITY_ID
- Optional Parameter
- is an optional activity id for the activity whose event pool is to be browsed.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- FILE_NOT_AUTH
- FILE_UNAVAILABLE
- INVALID_ACTIVITY_ID
- NO_CURRENT_ACTIVITY
- READ_FAILURE
- TIMER_NOT_FOUND
- ABSTIME
- returns the timer's expiry time in ABSTIME format.
- EVENT
- is the name of the retrieved reattach event.
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- TIMER_STATUS
- returns the status of the timer.
- Values for the parameter are:
- EXPIRED
- FORCED
- UNEXPIRED