ResultSet_Description

Syntax

int ResultSet_Description (CAObjHandle UUTHandle, CAObjHandle stationInfo, CAObjHandle context, CAObjHandle optionsHandle, CAObjHandle mainSequenceResults, CAObjHandle startDate, CAObjHandle startTime, 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 <TestResults>/<ResultSet>/<Description> element. The outer XML represents the node and all its child nodes.

Note The report text this function returns when executed does not depend on any report data that the report generator generates.

Remarks

If the report generator 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 does not add any report text for the <Description> element.

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 .
  • mainSequenceResults —References a TestStand PropertyObject of type Result . This reference refers to the result that the MainSequence of the executed sequence file returns.
  • startDate —References a TestStand PropertyObject of type StartDate .
  • startTime —References a TestStand PropertyObject of type StartTime .
  • 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.

See Also

PropertyObject