Newport XPS-D Programmer's Manual

XPS Unified Programmer’s Manual
7.2.1.32 ExternalModuleSocketFree
Name
ExternalModuleSocketFree – Free the socket previously reserved for an
ExternalModule.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the module number (must >=1 and <= NbExternalModules): (-17)
Here: NbExternalModules is the number of modules declared in the line
SharedLibraryModuleNames of system.ref
Description
This function frees the socket previously reserved for an ExternalModule. If the
function is executed successfully via this socket all the controller functions (like
FirmwareVersionGet(), ElapsedTimeGet( , ErrorStringGet(), …) become active, while
ExternalModule functions (like ExternalModuleTZPositionCurrentGet(),
ExternalModuleGPIODigitalInputGet(), …) become inactive.
(return error -18: Positioner Name doesn't exist or unknown command).
Prototype
int ExternalModuleSocketFree(
int SocketID,
int ModuleNumber
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
ModuleNumber int External module number
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.
EDH0373En1023 — 01/18 78

Newport XPS-D Specifications

General

Brand	Newport
Model	XPS-D
Category	Controller
Language	English