QtrcWriteText()--Write Text Trace Data

 #include <qtrc.h>

 int QtrcWriteText
         (unsigned int    Coded_Level,
          const char     *Component,
          const char     *Subcomponent,
          const char     *Function,
          const char     *Text);

The QtrcWriteText() function writes a component trace record as text string data to an active trace collection if certain trace conditions are met.

Each call to the QtrcWriteText() function is considered a trace point. A component trace record is written to the trace collection when all the trace conditions are met for a given trace point. The trace conditions include:

• A trace collection must be active for the current thread.
• The specified Component must be part of the trace collection.
• The active trace level that was used for the specified Component when the trace collection was started must allow the Coded_Level of the trace point.

Each trace point must indicate the desired trace level using the Coded_Level parameter. This trace level is compared against the active trace level that was used for the specified Component when the trace collection was started. Components are defined to the trace collection using the Start Trace (STRTRC) CL command. The Coded_Level must be one of the following values:

Parameters

Coded_Level

(Input)

The trace level of the trace point.

Component

(Input)

A pointer to the null-terminated component name. The component name should be 10 characters in length or less. If more than 10 characters are specified, only the first 10 characters are used.

Subcomponent

(Input)

A pointer to the null-terminated subcomponent name. The subcomponent name should be 10 characters in length or less. If more than 10 characters are specified, only the first 10 characters are used. This parameter can be set to NULL if no subcomponent is to be defined.

Function

(Input)

A pointer to the null-terminated function name. The function name should be 512 characters in length or less. If more than 512 characters are specified, only the first 512 characters are used. This parameter can be set to NULL if no function is to be defined.

Text

(Input)

A pointer to the null-terminated text to be written as trace data. The text should be 2048 characters in length or less. If more than 2048 characters are specified, only the first 2048 characters are used.

Authorities and Locks

None.

Return Value

0

QtrcWriteText() was successful. However, the component trace record will only be written if the trace conditions are met.

value

QtrcWriteText() was not successful. An error condition was detected which would prevent the component trace record from ever being written.

Error Conditions

If QtrcWriteText() was not successful, the error condition returned usually indicates one of the following errors. Under some conditions, the value returned could indicate an error other than those listed here.

Error Messages

None.

Usage Notes

1. If the QtrcWriteText() function is called multiple times, there may be a noticeable performance impact. The QtrcGetActiveLevel() API can be used, and the results saved into a variable for later, multiple uses. The variable can be used to quickly check if the specified Component is currently active at the appropriate trace level, prior to calling the QtrcWriteText() function. The variable should be periodically updated, to ensure a current view of the component's active trace level. Refer to the QTRC Trace APIs for additional information concerning the use of trace levels.
2. Refer to the QTRC Trace APIs for additional information concerning the Coded_Level, Component, Subcomponent, and Function parameters.
3. The Text parameter is used to write a string of characters as trace data. This provides a simple way to write out trace data that describes a state or action. For example, the Text could be something like "Exit: rc=0" or "Entry was removed from linked list."
4. The Text parameter should only contain characters in the invariant character set.
5. The total amount of text data that can be written as trace data is limited to 2048 characters. In order to trace more than 2048 characters of text data, the QtrcWriteHexDumpF function could be used to write the text data as hexadecimal trace data with a formatting option that includes the appropriate text representation. An alternative would be to split up the text data into multiple sections and call the QtrcWriteText() function for each section.

Related Information

• QtrcGetActiveLevel()--Get Active Trace Level
• QtrcWriteHexDump()--Write Hexadecimal Dump Trace Data
• QtrcWriteHexDumpF()--Write Hexadecimal Dump Formatted Trace Data
• QtrcWriteStack()--Write Call Stack Trace Data
• QtrcWriteTextPrintF()--Write Text Trace Data using Print Formatted
• QtrcWriteTextPPrintF()--Write Text Trace Data using Pointer-based Print Formatted
• QtrcWriteTextVPrintF()--Write Text Trace Data using Variable Argument List Print Formatted
• Start Trace (STRTRC) CL command
• For additional information about the QTRC Trace environment, see QTRC Trace APIs.

Example

The following example uses an ERROR-level trace point to write text trace data for a component named MYCOMP. The component trace record will be written to the active trace collection if the program is called with no parameters and the STRTRC CL command was used before calling the example, specifying either TRCTYPE((MYCOMP *ERROR)), TRCTYPE((MYCOMP *INFO)), or TRCTYPE((MYCOMP *VERBOSE)).

Note: By using the code examples, you agree to the terms of the Code license and disclaimer information.

#include <qtrc.h>
#include <stdio.h>
#include <errno.h>

int main(int argc, char *argv[])
{
  const char *myComp = "MYCOMP";
  int rc;

  if (argc <= 1) {
    rc = QtrcWriteText(QTRC_LEVEL_ERROR,
             myComp,
             "SUBCOMP",
             argv[0],
             "At least one parm required - return EINVAL." );
    if (rc != 0) {
      printf("QtrcWriteText() failed with error %d\n", rc);
    }
    printf("Use the ENDTRC CL command with PRTTRC(*YES) in order to\n");
    printf("see the component trace records that were written to the\n");
    printf("trace collection.\n");
    return EINVAL;
  }

  return 0;
}

Use the ENDTRC CL command with PRTTRC(*YES) in order to
see the component trace records that were written to the
trace collection.

[ Back to top | Problem Management APIs | APIs by category ]