Newport XPS Programmer's Manual

XPS Unified Programmer’s Manual
7.2.1.338 TZMappingModeSet
Name
TZMappingModeSet – Sets TZ mapping mode.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the group type (must be a TZ group): (-8)
- Checks the group name: (-19)
- Checks if TZMapping feature is enabled in system.ini: (-121)
- Group state must be "NOTINIT”: (-140)
Description
This function configures the mode of TZ mapping.
The values for Mode to set : 1 (Enabled) or 0 (Disabled).
This API is reserved to TZ group only.
Prototype
int TZMappingModeSet(
int SocketID,
char * GroupName,
int Mode
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
GroupName char * TZ group name.
Mode int TZ mapping mode.
Output parameters
None.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -19: GroupName doesn't exist or unknown command.
• -121: Function is not allowed due to configuration disabled.
• -140: Function is only allowed in NOTINIT state.
489 EDH0373En1023 — 01/18

Newport XPS Specifications

General

Controller Type	Multi-axis motion controller
Power Supply	24 VDC
Communication Interface	Ethernet
Programming Language	C, C++, .NET, LabVIEW
Supported Motor Types	Stepper
Operating System Compatibility	Windows
Axes	Up to 8 axes