GetChannelSetting


Function

Get the channel settings except for sweep and waveform settings.

Format

Ret = GetChannelSetting (AoChannel, Amplitude, Offset, AmplitudeType, AmplitudeUnit, Duty, Phase, Arg1)

Parameters

AoChannel [ VB.NET : Short ] [ C++ : short ] [ C# : short ]

Specify the channel number.

Amplitude [ VB.NET : Single ] [ C++ : float * ] [ C# : ref float ]

Return the amplitude.

Offset [ VB.NET : Single ] [ C++ : float * ] [ C# : ref float ]

Return the offset.

AmplitudeType [ VB.NET : Short ] [ C++ : short * ] [ C# : ref short ]

Return the type.

0

Amplitude

1

Vp-p

AmplitudeUni [ VB.NET : Short ] [ C++ : short * ] [ C# : out short ]

Return the unit.

0

If the device is voltage, it will be "V".

If the device is current, it will be "mA".

1

LSB

Duty [ VB.NET : Single ] [ C++ : float * ] [ C# : out float ]

Return the duty ratio.

Phase [ VB.NET : Single ] [ C++ : float * ] [ C# : out float ]

Return the phase.

 

Arg1 [ VB.NET : Short ] [ C++ : short * ] [ C# : out short ]

Specify the address of the reserved area. 0 is fixed (reserved)

Return Value

Ret [ VB.NET : Integer ] [ C++ : long ] [ C# : int ]

Return Value

Description

0

Normal completed

22000

Channel number is outside the settable range.

The others (See also: Error Code List)

Remarks

Set the amplitude, duty ratio, offset, and phase.
Some parameters may not be used depending on the selected waveform type.
If there are multiple errors in the settings, the error with the earliest parameter number will be displayed preferentially as the return value.
This function can be executed even if the device is in operation.

Example

Get the amplitude, offset, amplitude type, amplitude unit, duty ratio, and phase of channel 0.

VB.NET

Dim Ret As Long

Dim Amplitude As Single

Dim Offset As Single

Dim AmplitudeType As Short

Dim AmplitudeUnit  As Short

Dim Duty As Single

Dim Phase As Single

Dim Arg  As Short

Ret = c_fgen.GetChannelSetting(0, Amplitude, Offset, AmplitudeType, AmplitudeUnit, Duty, Phase, Arg)

 

C++

long Ret;

ICWaveformGeneratorPtr c_fgen;

float Amplitude;

float Offset;

short AmplitudeType;

short AmplitudeUnit;

float Duty;

float Phase;

short Arg;

Ret = c_fgen->GetChannelSetting(0, &Amplitude, &Offset, &AmplitudeType, &AmplitudeUnit, &Duty, &Phase, &Arg);

 

C#

int Ret;

float Amplitude = 0;

float Offset = 0;

short AmplitudeType = 0;

short AmplitudeUnit =0;

float Duty = 0;

float Phase = 0;

short  Arg = 0;

Ret = c_fgen.GetChannelSetting(0, ref Amplitude, ref Offset, ref AmplitudeType, ref AmplitudeUnit, ref Duty, ref Phase, ref Arg);

 

See Also

SetChannelSetting