VTI Instruments EX1629 - Vtex1629_Get_Strain_Units

VTI Instruments Corp.
188 EX1629 Command Set
vtex1629_get_strain_units
FUNCTION PROTOTYPE
ViStatus vtex1629_get_strain_units (ViSession vi, ViInt32 channel, ViPBoolean microStrain);
FUNCTION PARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
channel = an integer input value that specifies the channel for which the strain units will be returned. Valid input
values: 0 to 47.
microStrain = a Boolean return value that indicates whether the EX1629 will return strain measurements in units of
strain (ε) or microstrain (µε). A value of “1” indicates that the EX1629 is configured to return microstrain units for
the given channel, whereas a value of “0” indicates the EX1629 is configured to return strain units for the given
channel.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function queries and returns the configured strain units for a given channel. Each channel can be configured to
return strain measurements in strain or microstrain (1 strain (ε) = 1x10
6
microstrain (µε)). This setting has no effect
for non-strain EU conversions.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViBoolean units_are_microstrain;
…
…
status = vtex1629_get_strain_units(instrumentHandle, 0, &units_are_microstrain);