BINFILE Emitter Properties

You can view the trace files output by the BINFILE emitter using the CTFViewer utility that is supplied with your develoment system. The format of the trace files is platform independent.

To enable the BINFILE emitter, specify the following statement in the Consolidated Tracing Facility configuration file:

mftrace.dest = BINFILE

The following table lists the properties you can set to control the behavior of the BINFILE emitter:

Property Description Default
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).ctb, or $(APPNAME).$(EMITTER).$(PID).ctb_$(GEN) if the MAXGENERATION property has been specified. For example:
  • If the BINFILE emitter is being used to output trace events for executing as process-id 3456 and the MAXGENERATION property has not been specified, the trace file created will be called .
  • If the binfile emitter is being used to output trace events for executing as process-id 1975 and the MAXGENERATION property has been set to 3, the trace files created will be called myapp.binfile.1975.ctb_1, myapp.binfile.1975.ctb_2, and myapp.binfile.1975.ctb_3.
$(APPNAME) The basename of the executable invoked to start the current process. For example, if .
$(EMITTER) Always "BINFILE" for this emitter.
$(GEN) The generation of the file, starting from 1.
$(PID) The operating system identifier for the current process
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
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.