ZmGetCorrectionEnable

Function

Get the enable/disable of correction.

Format

Ret = ZmGetCorrectionEnable ( Id , ChannelNo , Type , Enable )

Parameters

Id [ VB.NET： Short ] [ C, C++： short ] [ C#： short ] [ Python： ctypes.c_short ]
Specify the device ID retrieved from ZmInit.

ChannelNo [ VB.NET： UShort ] [ C, C++： unsigned short ] [ C#： ushort ] [ Python： ctypes.c_ushort ]
Specify the channel number.

Type [ VB.NET： UShort ] [ C, C++： unsigned short ] [ C#： ushort ] [ Python： ctypes.c_ushort ]
Specify the correction type.

Definition	Value [Dec]	Description
ZM_CORRECTION_TYPE_OPEN	0	Correction type Open
ZM_CORRECTION_TYPE_SHORT	1	Correction type Short

Enable [ VB.NET： UShort ] [ C, C++： unsigned short * ] [ C#： out ushort ] [ Python： ctypes.POINTER(ctypes.c_ushort) ]
Specify the address of the variable for storing enable/disable.

Return Value

Ret [ VB.NET： Integer ] [ C, C++： long ] [ C#： int ] [ Python： ctypes.c_long ]

Definition	Value [Dec]	Description
ZM_ERR_SUCCESS	0	Normality completion
ZM_ERR_SYS_CHANNEL_NO	20100	Channel No is out of the settable range.
ZM_ERR_SYS_TYPE	20108	Type is out of the settable range.

The others (See also: Details of Error Code)

Initial Value

0 : Disable

Remarks

Get the enable/disable of correction.
Enable/disable of correction is gotten for each channel.

Enable/disable of correction is not related to the conditions for the correction.
Please note that this is different from the correction value.

For details about correction, please refer to the glossary "Correction".

Example

Get the enable/disable of correction when ChannelNo = 1 is "0 : Correction type Open".

VB.NET	Dim Ret As Integer Dim Enable As UShort Ret = ZmGetCorrectionEnable ( Id , 1 , 0 , Enable )
C, C++	long Ret; unsigned short Enable; Ret = ZmGetCorrectionEnable ( Id , 1 , 0 , &Enable );
C#	int Ret; ushort Enable; Ret = zm.GetCorrectionEnable ( Id , 1 , 0 , out Enable );
Python	Ret = ctypes.c_long() Enable = ctypes.c_ushort() Ret.value = czm.ZmGetCorrectionEnable ( Id , 1 , 0 , ctypes.byref(Enable) )