ZmGetCorrectionEnable


機能

補正の有効/無効を取得します。

書式

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

引数

Id [ VB.NET: Short ] [ C, C++: short ] [ C#: short ] [ Python: ctypes.c_short ]
ZmInitで取得したデバイスIDを指定します。

ChannelNo [ VB.NET: UShort ] [ C, C++: unsigned short ] [ C#: ushort ] [ Python: ctypes.c_ushort ]
チャネル番号を指定します。

Type  [ VB.NET: UShort ] [ C, C++: unsigned short ] [ C#: ushort ] [ Python: ctypes.c_ushort ]
補正タイプを設定します。

定義


[Dec]

意味

ZM_CORRECTION_TYPE_OPEN

0

補正タイプオープン

ZM_CORRECTION_TYPE_SHORT

1

補正タイプショート

Enable  [ VB.NET: UShort ] [ C, C++: unsigned short * ] [ C#: out ushort ] [ Python: ctypes.POINTER(ctypes.c_ushort) ]
有効/無効を格納する変数アドレスを指定します。

戻り値

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

定義

戻り値
[Dec]

内容

ZM_ERR_SUCCESS

0

正常終了

ZM_ERR_SYS_CHANNEL_NO

20100

チャネル番号が設定可能範囲外です。

ZM_ERR_SYS_TYPE

20108

補正タイプが設定可能範囲外です

その他のエラー(参照:エラーコード詳細

初期値

0 : 無効

説明

補正の有効/無効を取得します。
補正の有効/無効はチャネル毎に取得します。

補正の有効/無効は測定条件に関係ありません。
補正値とは異なりますのでご注意ください。

補正についての詳細は用語集「補正」をご参照ください。

使用例

ChannelNo = 1が「0:補正タイプオープン」の時の、補正の有効/無効を取得します。

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) )
 

関連項目

ZmCorrection ZmSetCorrectionEnable ZmSetCorrectionValue ZmGetCorrectionValue