#include <qtrc.h> int QtrcWriteHexDump (unsigned int Coded_Level, const char *Component, const char *Subcomponent, const char *Function, const char *Label, const void *Data, size_t Data_Length);Service Program Name: QTRCMGR
The QtrcWriteHexDump() function writes a component trace record as hexadecimal dump data to an active trace collection if certain trace conditions are met.
Each call to the QtrcWriteHexDump() 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:
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:
QTRC_LEVEL_ERROR (1) | ERROR-level trace point. A component trace record is written if the Component has an active trace level of either *ERROR, *INFO, or *VERBOSE. |
QTRC_LEVEL_INFO (2) | INFO-level trace point. A component trace record is written if the Component has an active trace level of either *INFO or *VERBOSE. |
QTRC_LEVEL_VERBOSE (3) | VERBOSE-level trace point. A component trace record is written if the Component has an active trace level of *VERBOSE. |
The trace level of the trace point.
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.
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.
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.
A pointer to the null-terminated label that will precede the hexadecimal dump data. The label should be 128 characters in length or less. If more than 128 characters are specified, only the first 128 characters are used. This parameter can be set to NULL if no label is to be defined.
A pointer to the data to be written as a hexadecimal dump.
The length in bytes of the data to be written.
None.
If QtrcWriteHexDump() 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 condition | Additional information |
---|---|
[EINVAL] |
The specified Coded_Level is not one of the supported trace levels. The specified Component is not a valid component name. |
[EFAULT] | |
[EUNKNOWN] |
None.
The following example uses INFO-level trace points to write hexadecimal dump trace data for a component named MYCOMP. The QtrcGetActiveLevel function is used, since there are more than one trace points, as described in the Performance section of QTRC Trace Tips. The component trace records will be written to the active trace collection if the STRTRC CL command was used before calling the example, specifying either 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> #define BUFFERELEMENTS 256 int main(int argc, char *argv[]) { const char *myComp = "MYCOMP"; unsigned int myCompActLvl; char myBuffer[BUFFERELEMENTS]; int myBuffer2[BUFFERELEMENTS]; int i, rc; rc = QtrcGetActiveLevel(myComp, &myCompActLvl); if (rc != 0) { printf("QtrcGetActiveLevel() failed with error %d\n", rc); return -1; } for (i=0; i<BUFFERELEMENTS; ++i) { myBuffer[i] = i; } if (myCompActLvl >= QTRC_LEVEL_INFO) { rc = QtrcWriteHexDump(QTRC_LEVEL_INFO, myComp, "SUBCOMP", argv[0], "Contents of myBuffer after initialization", (void *)myBuffer, sizeof(myBuffer) ); if (rc != 0) { printf("QtrcWriteHexDump() myBuffer failed with error %d\n", rc); return -1; } } for (i=0; i<BUFFERELEMENTS; ++i) { myBuffer2[i] = i; } if (myCompActLvl >= QTRC_LEVEL_INFO) { rc = QtrcWriteHexDump(QTRC_LEVEL_INFO, myComp, "SUBCOMP", argv[0], "Contents of myBuffer2 after initialization", (void *)myBuffer2, sizeof(myBuffer2) ); if (rc != 0) { printf("QtrcWriteHexDump() myBuffer2 failed with error %d\n", rc); return -1; } } 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 0; }Example Output:
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 ]