Parameter_Description
- Updated2025-07-21
- 2 minute(s) read
Parameter_Description
Syntax
int Parameter_Description (CAObjHandle UUTHandle, CAObjHandle stationInfo, CAObjHandle context, CAObjHandle optionsHandle, CAObjHandle stepResult, BSTR *bstrStr)
Return Value
Indicates whether an error occurred in the exported function. A value of 0 indicates that no error occurred. Any negative value indicates that an error has occurred.
Purpose
Returns the outer XML value for the following elements. The outer XML represents the node and all its child nodes.
- <TestResults>/<ResultSet>/<Test>/<Parameters>/<Parameter>/<Description>
- <TestResults>/<ResultSet>/<SessionAction>/<Parameters>/<Parameter>/<Description>
- <TestResults>/<ResultSet>/<TestGroup>/<Parameters>/<Parameter>/<Description>
The ATML TR report generator calls this function before the generator attempts to generate and add report text for the <Description> element depending on the data in TestStand variables when sequence file execution completes.
The report generator calls this function for a particular TR report element only when the report generator extension mechanism DLL does not implement and export one or more of the following functions or when the extension mechanism DLL implements and exports one or more of the following functions but the function or functions return an empty string:
| Function | Element for Which the Report Generator Calls the Parameter_Description Function |
|---|---|
| Test_Parameters | <Test>/<Parameters>/<Parameter>/<Description> |
| SessionAction_Parameters | <SessionAction>/<Parameters>/<Parameter>/<Description> |
| TestGroup_Parameters | <TestGroup>/<Parameters>/<Parameter>/<Description> |
Remarks
If the outer XML value the bstrStr parameter specifies is not empty, the report generator adds to the report the content the bstrStr parameter specifies as a result of calling this function. If the outer XML value the bstrStr parameter specifies is empty, the report generator generates report text for the <Description> element depending on the data in TestStand variables when sequence file execution completes.
If the report generator extension mechanism DLL does not implement and export this function, the report generator generates report text for the <Description> element depending on the data in TestStand variables when sequence file execution completes.
Parameters
- UUTHandle —References a TestStand PropertyObject of type UUT .
- stationInfo —References a TestStand PropertyObject of type NI_StationInfo .
- context —References a TestStand PropertyObject of type Sequence Context .
- optionsHandle —References a TestStand PropertyObject of type ReportOptions .
- stepResult —References a TestStand PropertyObject of type Result . This reference refers to a result that a step in the executed sequence file returns.
- bstrStr —An [In] value specifies an empty string. An [Out] value specifies a string that the function returns upon execution and that contains the outer XML value of the report text.