SessionAction_Parameters_All
- Updated2025-07-21
- 2 minute(s) read
SessionAction_Parameters_All
Syntax
int SessionAction_Parameters_All (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
Modifies and returns the outer XML value for the <TestResults>/<ResultSet>/<SessionAction>/<Parameters> . The outer XML represents the node and all its child nodes.
Remarks
If the extension mechanism DLL implements and exports this function, the report generator adds to the report the content the bstrStr parameter specifies as a result of calling this function. If the extension mechanism DLL does not implement and export this function, the report generator generates report text 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 the outer XML value the report generator creates depending on the data in TestStand variables when sequence file execution completes. An [Out] value specifies a string that the function returns upon execution and that specifies the modified outer XML value the report generator creates.