The following table lists the properties you can set to control the behavior of the TEXTFILE emitter.
Property | Description | Default | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DELIMCHAR | The character used in the output file to delimit trace data parts for a trace event. | Space. | ||||||||||||||||||||||||
FILE | The name of the trace file to be written. You can use
the following pseudo-variables for the construction of the trace file name:
|
$(APPNAME).$(EMITTER).$(PID).log,
or $(APPNAME).$(EMITTER).$(PID).log_$(GEN) if the
MAXGENERATION property has been specified. For example:
|
||||||||||||||||||||||||
FLUSHEVERY | The number of trace records that will be output before the file is flushed. 0 indicates that the file will never be explicitly flushed. | 1 | ||||||||||||||||||||||||
FORMAT | The format to be used for each trace data record written
to the file. You can use the following pseudo-variables in the format
specification:
|
$(TIME) $(COMPONENT) $(EVENT) $(LEVEL)$(DATA) | ||||||||||||||||||||||||
HEXBLOCKSIZE | The number of hexadecimal bytes to be output in each
block when outputting binary trace data. Each block of hexadecimal characters
will be separated by a '-' character. For example, if HEXBLOCKSIZE is set to 4,
and some binary trace data with the value 3132333435363738393A3B3C3D3E3F is
specified for output, it would be formatted as follows:
31323334-35363738-393A3B3C-3D3E3F |
8 | ||||||||||||||||||||||||
LOCATION | The folder where the trace files are to be written. |
The folder specified by the MFTRACE_LOGS environment variable. If MFTRACE_LOGS is not set, the current folder is used. If the folder specified by the LOCATION property does not exist, the Consolidated Tracing Facility tries to create it. If this fails, the Consolidated Tracing Facility uses the default location (as specified by the MFTRACE_LOGS environment variable). If this fails, the current folder is used. |
||||||||||||||||||||||||
MAXFILESIZE | The maximum amount of data (in Kb) that will be written to the trace file before the file is closed and the next trace file in the generation sequence is opened. The first trace file in a generation sequence results in the $(GEN) pseudo-variable (see the description of the FILE property, above) being set to 1, the second in the sequence results in it being set to 2, and so on until MAXGENERATION is exceeded. Once the MAXGENERATION number of files has been reached, the generation number reverts to 1 and the first trace file in the generation is overwritten. This is only used if MAXGENERATION > 1. | 0x00002800, indicating a maximum file size of 10 Mb. | ||||||||||||||||||||||||
MAXGENERATION | The maximum number of trace files that will be written to while tracing is enabled. Use this property in conjunction with the MAXFILESIZE property. | 1, indicating that only a single trace file will be created. | ||||||||||||||||||||||||
QUOTESTRING | Whether or not string trace data is to be output enclosed in double-quote characters. | TRUE |