SessionAction_Attributes

Syntax

int SessionAction_Attributes (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 XML attributes for the <TestResults>/<ResultSet>/<SessionAction> element.

The ATML TR report generator calls this function before the generator attempts to generate and add report text for the attributes of the <SessionAction> element depending on the data in TestStand variables when sequence file execution completes.

Remarks

If the concatenated string of XML attribute-value pairs 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 concatenated string of XML attribute-value pairs the bstrStr parameter specifies is empty, the report generator generates report text for the attributes of the <SessionAction> 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 attributes of the <SessionAction> 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 specifies the report text that contains all the attribute-value pairs concatenated for the <SessionAction> element.

See Also

PropertyObject