Newport XPS - Eventextendedget

XPS Unified Programmer’s Manual
7.2.1.26 EventExtendedGet
Name
EventExtendedGet – Gets the details of “event and action” combinations in scheduler
defined by an identifier.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Event identifier [0:49]: (-83)
Description
Returns the composition of events and actions in progress defined by an identifier. This
identifier is defined in the “EventExtendedStart” function.
The identifier must be defined between 0 and 49, if its value is “–1” then it’s not
defined.
If the configured event is already deleted, (-83) error is returned.
Prototype
int EventExtendedGet(
int SocketID,
int EventID,
char * EventConfiguration,
char * ActionConfiguration
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
EventID int “Event and action” identifier from
“ExtendedEventStart”.
Output parameters
EventConfiguration char * Event combination defined in scheduler.
ActionConfiguration char * Action combination defined in scheduler.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -83: Event ID not defined.
EDH0373En1023 — 01/18 70