VTI Instruments EX1629, User Manual

Page: 136 / 346

VTI Instruments Corp.
136 EX1629 Command Set
vtex1629_get_cal_file_size
F
UNCTION
P
ROTOTYPE
ViStatus vtex1629_get_cal_file_size (ViSession vi , ViInt32 fileType , ViPInt32 fileSize );
F
UNCTION
P
ARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
fileType = deinfes the file type that will be acquired. Valid input values: 0 through 3. See the Description section
below for more information.
fileSize = returned file size for the specified calibration file type.
D
ATA
I
TEM
R
ESET
V
ALUE
Not applicable to this function.
D
ESCRIPTION
This function returns the total buffer size required to read the cal data, including terminating nulls, etc. The client
application should use this size to allocate a sufficiently large buffer.
The
fileType parameter has the following valid input values:
Decimal
Value
Hex
Value
#define Symbol Description
0 0x00 VTEX1629_CAL_DATA_COMBINED Both self and factory calibration data
1 0x01 VTEX1629_CAL_DATA_SELF Self-calibration data
2 0x02 VTEX1629_CAL_DATA_FACTORY Factory calibration data
3 0x03 VTEX1629_CAL_DATA_COMBINED_XML Both self and factory calibration data in XML format.
E
XAMPLE
ViSession instrumentHandle;
ViStatus status = VI_SUCCESS;
ViInt32 bufferSize = 0;
fileType = VTEX1629_CAL_DATA_COMBINED;
…
status = vtex1629_get_cal_file_size(instrumentHandle, fileType, &bufferSize);