VTI Instruments EX1629 - Vtex1629_Enable_Logging

VTI Instruments Corp.
116 EX1629 Command Set
vtex1629_enable_logging
FUNCTION PROTOTYPE
ViStatus vtex1629_enable_logging (ViChar _VI_FAR filename[], ViBoolean append);
FUNCTION PARAMETERS
filename = an input string that specifies the file to which logging data will be recorded. The format may be simply a
file name (“ex1629_log”) or an absolute path (“C:\vxipnp\vtex1629\ex1629_log.txt”). If a file name (relative path)
is provided, the file will be created in the current working directory of the application.
append = a Boolean input value that specifies if log results will be appended to an existing file. A value of
VI_TRUE will cause logged information to be appended to an existing file. Otherwise, any previous data will be
overwritten.
DATA ITEM RESET VALUE
Not applicable to this function.
EXAMPLE
ViStatus status;
ViString fileName = “myTemporaryFile”;
ViBoolean append = VI_TRUE;
…
status = vtex1629_enable_logging (fileName, append);
if (status < VI_SUCCESS)
{
<inform the user the API call failed>
}