tTestData Structure

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

The tTestData structure contains input and output data, as shown in the following table.

Note Note  Use the sequence context to access all the objects, variables, and properties in the execution.
Field Name Data Type In/Out Description
result int Out Set by test function to indicate whether the test passed. Valid values are PASS or FAIL. The adapter copies this value into the Step.Result.PassFail property when the property exists.
measurement double Out Numeric measurement the test function returns. The adapter copies this value into the Step.Result.Numeric property when the property exists.
inBuffer char * In For passing a string parameter to a test function. The adapter copies the Step.InBuf property value into this field when the property exists.
outBuffer char * Out Output message to include in the report. The adapter copies this message value into the Step.Result.ReportText property when the property exists.
modPath char * const In Directory path of the module that contains the test function. The adapter sets this value before executing the code module.
modFile char * const In Filename of the module that contains the test function. The adapter sets this value before executing the code module.
hook void * In Reserved (no longer used).
hookSize int In Reserved (no longer used).
mallocFuncPtr tMallocPtr const In Contains a function pointer to malloc, which a code module must use to allocate memory for any buffer it assigns to the inBuffer, outBuffer, and errorMessage fields.
freeFuncPtr tFreeptr const In Contains a function pointer to free, which a code module must use to free any buffers to which the inBuffer, outBuffer, and errorMessage fields point.
seqContextDisp struct IDispatch * In Dispatch pointer to the sequence context. This value is NULL when you choose not to pass the sequence context.
seqContextCVI CAObjHandle In LabWindows/CVI ActiveX Automation handle for the sequence context. This value is 0 when you choose not to pass the sequence context.
stringMeasurement char * Out String value the test function returns. The adapter copies this string into the Step.Result.String property when the property exists.
replaceStringFuncPtr tReplaceStringPtr const In Contains a function pointer to ReplaceString, which a code module can use to reassign a value to the inBuffer, outBuffer, and errorMessage fields. The following is the ReplaceString prototype:

int ReplaceString(char **destString, char *srcString);

The function return value is non-zero when successful.
structVersion int In Structure version number. A test module can use this value to detect new versions of the structure.

See Also

Example Code Module

tTestError Structure

Updating Step Properties

WAS THIS ARTICLE HELPFUL?

Not Helpful