Closeallothersockets - Newport XPS Programmer's Manual

XPS Unified
7.2.1.3

CloseAllOtherSockets

Name
CloseAllOtherSockets – Closes all sockets beside the one used.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks "Administrator" rights: (-107)
Description
This function allows an administrator to close all user sockets except the socket used to
call this function.
All other user sockets are closed. So, ERR_SOCKET_CLOSED_BY_ADMIN error is
sent to each running (on an user socket) process before the socket is really closed.
Prototype
int CloseAllOtherSockets()
Input parameters
None.
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -107: This function requires Administrator rights.
Call the "Login" function to identify the user as "Administrator".
If some TCL scripts are in progress (after a "TCLScriptExecute"
function or a "TCLScriptExecuteAndWait" function), do not use
CloseAllOtherSockets to function to kill these TCL scripts. Use the
"TCLScriptKill" function to stop the TCL execution and only after
can you use the "CloseAllOtherSockets" function to close sockets.
NOTE
CAUTION
45
Programmer's Manual
EDH0373En1023 — 01/18