SmcWGetAlarmCode


Function

Retrieves alarm code.

 

Format

Ret = SmcWGetAlarmCode( Id, AxisNo, AlarmCode )

 

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 axis number.

 

AlarmCode [ C, C++: short *] [ Python: ctypes.POINTER(ctypes.c_short) ]

Specify the address of the variable that stores the alarm code.

 

Return Value

Ret [ C, C++: long ] [ Python: ctypes.c_long ]

0

Terminated normally

Non-zero

Terminated abnormally

See also: Error code details

 

Remarks

Please refer to specifications of every driver unit for details of alarm code.

This function can be executed even if the device is in operation.

 

Example

The alarm code of axis number 1 is acquired.

 

C, C++

long Ret;

short AlarmCode ;

Ret = SmcWGetAlarmCode( Id , 1, &AlarmCode );

 

Python

Ret = ctypes.c_long()

AlarmCode = ctypes.c_short()

Ret.value = csmc.SmcWGetAlarmCode( Id , 1, ctypes.byref(AlarmCode) )

 

See Also