This subroutine deletes a Shopping List from the application. If any responses are outstanding for requests on the Shopping List, PTMAP returns an error. If no responses are outstanding, PTMAP deletes each request that was added to the Shopping List and returns the number of requests that were deleted in the "err_ref" field of the status structure.
Syntax
int PTMAP_remove_sl (sl_addr, retstat)
PTMAP_ADDR *sl_addr;
COR_STATUS *retstat;
Input Arguments
sl_addr |
Pointer to Shopping List. |
Output Arguments
Retstat |
Pointer to status structure. The following errors may be returned (see Appendix A for an explanation of this code): |
|
PTM_REM_OUTST_REQ |
|
PTMAP_ADDR_PTR_NULL |
|
PTMAP_SL_ADR_NULL |
|
PTMAP_SL_ADDR_NOTF |
|
PTMAP_SEQ_NUM_MISMATCH |
|
The following warning may be returned: |
|
PTMAP_RSP_DELETED |
Return Value
The contents of retstat.status.
Point Management API subroutines. |