ExecutionOutputRecordStream.DefineFields
- Updated2024-10-09
- 2 minute(s) read
ExecutionOutputRecordStream.DefineFields
Syntax
ExecutionOutputRecordStream.DefineFields( fieldDefinitions, mapping = "")
Purpose
Define the field names for records displayed in the Report View.
Remarks
Defining the fields names for the ExecutionOutputRecordStream does not define them for the contained OutputRecordStream objects. It only specifies names for display in the Report View. Field names are not a part of the base OutputRecordStream interface, and may or may not be applicable for a specific OutputRecordStream implementation. To define the field names for a CsvFileOutputRecordStream , call CsvFileOutputRecordStream.WriteFieldHeaders() .
Parameters
fieldDefinitions As PropertyObject
[In] A container or array defining the field names. If the fields parameter is a container, the container is the record, and each subproperty is a field. The names of the subproperties are the field names. If the record parameter is an array, the entire array is the record, and each array element is a field. The values of the array elements coerced to strings are the field names.
mapping As String
[In] Specifies the mapping from elements (either subproperties or array elements) in the fields parameter to fields in the stream.
The mapping is a comma-separated list of index ranges. For example, "0, 3-5, 8-7" specifies that elements 0, 3, 4, 5, 8, and 7 specify the field names. The final range in the list may be open-ended. For example, "2, 3-" indicates that elements 2, 3, and all elements beyond 3 specify the field names. For convenience, you may specify an empty string to specify all elements be used in order. That is, an empty string is equivalent to "0-". The default value is an empty string.
This parameter has a default value of "" .