Function
Retrieves the data of hold-off signal.
Format
Ret = SmcWGetHoldOff( Id, AxisNo, HoldOff )
Parameters
Id [ C, C++: short ] [ Python: ctypes.c_short ]
Specify the device ID retrieved by SmcWInit function.
AxisNo [ C, C++: short ] [ Python: ctypes.c_short ]
Specify the axis number.
HoldOff [ C, C++: short *] [ Python: ctypes.POINTER(ctypes.c_short) ]
Specify the address of a variable to store the data of hold-off signal.
0 |
Hold the axis |
1 |
Release the holding of axis |
Return Value
Ret [ C, C++: long ] [ Python: ctypes.c_long ]
0 |
Terminated normally |
Non-zero |
Terminated abnormally |
See also: Error code details
Remarks
This function can be executed even if the device is in operation.
Example
Holding the off signal data of axis number 1 is acquired.
C, C++
long Ret;
short HoldOff ;
HoldOff = 1;
Ret = SmcWGetHoldOff( Id , 1, &HoldOff );
Python
Ret = ctypes.c_long()
HoldOff = ctypes.c_short()
HoldOff.value = 1
Ret.value = csmc.SmcWGetHoldOff( Id , 1, ctypes.byref(HoldOff) )
See Also