API for Trace Step Templates¶
Part of the Object based program API.
- class TraceStepTemplateApi¶
API to access trace step template files
Returned by
- OpenTraceStepTemplate(filename)¶
Opens a trace step template file.
- Parameters:
- filename : str¶
Absolute or relative path of the trace step template file. If relative the file must be located in the user defined trace step template directory.
- Returns:
Trace step template
- Return type:
-
SearchTraceStepTemplates(searchCriteria, useExtendedMode=
False)¶ Searches the current workspace and library workspaces for trace step templates matching the given search criteria.
- Parameters:
- searchCriteria : str¶
The search criteria expressed in the ecu.test filter syntax. See section “Handling” => “Filter” of the ecu.test User Documentation.
- useExtendedMode : boolean¶
If True, extended search strings are enabled. The default is False, meaning each word in the searchCriteria will be enclosed by wildcards and mapped to the filename. (e.g. “hello world” => “Name = ‘*hello*’ and Name = ‘*world*’”)
- Returns:
All matching trace step templates. If no template matches, an empty list is returned.
- Return type:
list[
TraceStepTemplate]- Raises:
ApiError – If the searchCriteria has an illegal syntax.