IPerformanceTestResultCollectionDumpResults Method

Dumps the results by the specified textWriter by using predefined localizable resources.

Definition

Namespace: KGySoft.Diagnostics
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 8.1.0
C#
void DumpResults(
	TextWriter textWriter,
	bool dumpConfig = true,
	bool dumpReturnValue = false,
	bool forceShowReturnSizes = false
)

Parameters

textWriter  TextWriter
The text writer to use for dumping the results.
dumpConfig  Boolean  (Optional)
to dump the test configuration; otherwise, . This parameter is optional.
Default value: .
dumpReturnValue  Boolean  (Optional)
to dump also the return value (or the call stack of the thrown exception) of the test cases. Ignored, when the delegate type of the test has a void return value and the test case did not throw an exception. This parameter is optional.
Default value: .
forceShowReturnSizes  Boolean  (Optional)
to show the size of non-void test cases even if dumpReturnValue is and results are not sorted by size; to show result size only when return values are dumped or results are sorted by size. This parameter is optional.
Default value: .

Remarks

If dumpConfig is , then please note that the configuration properties are taken from the PerformanceTestBase instance at the moment the results are dumped. If you change the configuration after retrieving a result the new values will be reflected in the dumped values.

If dumpReturnValue is , then the lastly returned value will also be dumped. Can be useful for tests, which measure size instead of execution time. In this case it can make sense to set SortBySize to . If the test case has thrown an exception, then the call stack of the exception will be dumped.

See Also