ZmCorrection


Function

Perform the correction.

Format

Ret = ZmCorrection ( Id , ChannelNo , Type )

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

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

None

Remarks

Perform the correction.
The conditions for the correction are the current settings.

After this function completes successfully, correction will be enabled automatically.

Correction is performed under the current conditions for the correction.
If the measurement conditions are changed, please perform the correction again.

The correction value is retained, so once the conditions for the correction have been corrected, there is no need to correct again.

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

Example

Perform the correction with "0 : Correction type Open" for ChannelNo = 1.

VB.NET

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

C, C++

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

C#

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

Python

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

See Also

ZmSetCorrectionEnable ZmGetCorrectionEnable ZmSetCorrectionValue ZmGetCorrectionValue