Newport XPS - Eventextendedremove

XPS Unified Programmer’s Manual
7.2.1.27 EventExtendedRemove
Name
EventExtendedRemove – Removes an “event and action” combination in the
scheduler defined by an identifier.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Actor event: (-8)
- Event identifier [0:49]: (-17), (-83)
Description
Deletes the “event(s) and action(s)” combination in the scheduler defined by an event
identifier. This identifier is defined in the “EventExtendedStart” function.
The identifier must be defined between 0 and 49, or -1. If the identifier is equal to “–1”,
the EventExtendedRemove function removes all current “event and action”
combinations.
If the configured event is already deleted, (-83) is returned.
Prototype
int EventExtendedRemove(
int SocketID,
int EventID
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
EventID int “Event and action” identifier.
Output parameters
None.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -17: Parameter out of range or incorrect.
• -83: Event ID not defined.
71 EDH0373En1023 — 01/18