ZmSetCorrectionEnable


Function

Enable/disable the correction.

Format

Ret = ZmSetCorrectionEnable ( 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#: ushort ] [ Python: ctypes.c_ushort ]
Specify enable/disable.

Definition

Value
[Dec]

Description

ZM_DISABLE

0

Disable

ZM_ENABLE

1

Enable

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.

ZM_ERR_SYS_ENABLE

20109

Enable is out of the settable range.

The others (See also: Details of Error Code)

Initial Value

0 : Disable

Remarks

Enable/disable the correction.
Correction can be enabled/disabled for each channel.

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

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

Example

When ChannelNo = 1 is "0 : Correction type Open", set correction to "1 : Enable".

VB.NET

Dim Ret As Integer
Ret = ZmSetCorrectionEnable ( Id , 1 , 0 , 1 )
 

C, C++

long Ret;
Ret = ZmSetCorrectionEnable ( Id , 1 , 0 , 1 );
 

C#

int Ret;
Ret = zm.SetCorrectionEnable ( Id , 1 , 0 , 1 );
 

Python

Ret = ctypes.c_long()
Ret.value = czm.ZmSetCorrectionEnable ( Id , 1 , 0 , 1 )
 

See Also

ZmCorrection ZmGetCorrectionEnable ZmSetCorrectionValue ZmGetCorrectionValue