This subroutine cancels a request that has been sent to Point Management. For example, if an "On-Change" request has been sent to Point Management, this function can be used to cancel that request. When this request is made, a message is sent to Point Management, and the application waits until a response is received from Point Management. The request is still part of the Shopping List, but it is no longer active. The request can be made active by sending the Shopping List a second time.
An error is returned if no outstanding response exists for the specified request.
Syntax
int PTMAP_cancel_req (can_req_adr, retstat)
PTMAP_ADDR *can_req_adr;
COR_STATUS *retstat;
Input Arguments
|
can_req_adr |
The identifier that was returned when the request was made. |
Output Arguments
|
Retstat |
Pointer to status structure. The following errors may be returned (see Appendix A for an explanation of this code): |
|
|
PTMAP_ADDR_PTR_NULL |
|
|
PTMAP_REQ_ADR_NULL |
|
|
PTMAP_REQ_ADDR_NOTF |
|
|
PTMAP_SEQ_NUM_MISMATCH |
|
|
PTMAP_REQ_NOT_OUT |
Return Value
The contents of retstat.status.
|
|
Point Management API subroutines. |
