How to Dump Memory in JDEDEBUG.log for Debugging/tracing Using jdeWriteLog and jdeTraceSz1 APIs

Purpose of Document

Are there any standard APIs available that can be used in debugging a certain business function?

NOTE:

Who this is for: C programmer
Requirement: C programming skill
Disclaimer: Example code in this document is provided as-is without warranty.
Alternative solution: Use existing standard business function B0900102 - Write to JDE log

Overview

Many times the online debugging may not be easy in debugging memory issue where jdedebug.log does not give you the value of variables used in a routine, some of standard JDE APIs can be used,

Available APIs,

jdeWriteLogEntry()
jdeVWriteLogEntry()
jdeWriteLog()
jdeTraceSz1()

jdeWriteLogEntry()

void jdeWriteLogEntry( LOGFILETYPE iLogType,
                       const JCHAR *module, /* Module making the entry, i.e. jdeFatal jdeKrnl etc. */
                       const ZCHAR *srcFile, /* source module name __FILE__ */
                       int srcLine, /* source module line __LINE__ */
                       int errNum, /* Msg text short */
                       const JCHAR *tempText /* Msg text description */
)

Example:

jdeWriteLogEntry(JDELOG, _J("jdeXML"), __FILE__, __LINE__, 0, _J("INITIALIZING XML SERVICE KERNEL"));

__FILE__ is C++ Preprocessor part of the C/C++ standard. Usually the file name is the business function object name (e.g., B4200310)
__LINE__ is C++ Preprocessor part of the C/C++ standard. Is the line number in the source file where jdeWriteLogEntry is (e.g., line number 5356)
Message in the log will be written as b4200310.c5356
Through the use of __FILE__ and __LINE__, it specifies which business function and line number so this API can be used for debugging as well as describing an error.

jdeVWriteLogEntry()

void jdeVWriteLogEntry( const JCHAR *module, /* Module making the entry, i.e. jdeFatal jdeKrnl etc. */
                        const ZCHAR *srcFile, /* source module name __FILE__ */
                        int srcLine, /* source module line __LINE__ */
                        int errNum, /* Msg text short */
                        const JCHAR *msgFormat, /* Msg format specifier */
                        ... /* optional parms for msgFormat */
)

Example:

b0000122 - PostToF0902 (F0902 Update Account Balance)
jdeVWriteLogEntry(_J(""), __FILE__, __LINE__, 0,
_J("F0902 Update Successful. Please Ignore Previous F0902 Insert Failure."));

As we can see, Log Type (whether it is JDELOG or JDEDEBUGLOG) and Module ID are optional. Regardless, it always writes to JDELOG and JDEDEBUGLOG.
Through the use of __FILE__ and __LINE__, it specifies which business function and line number so this API can be used for debugging as well as describing an error.

jdeWriteLog ()

void jdeWriteLog( const JCHAR *module, /* Module making the entry */
int errNum, /* Msg text short */
const JCHAR *msgFormat, /* Msg format specifier */
)

Example:

b0000182 - jdeInitEnvBSFN (jdeInitEnvBSFN)
jdeWriteLog(_J("B0000182"), 0,
_J("B0000182:IB0000182_InitializeQuantumSalesTax: CacheInit Failed for SalesTaxInit cache"));

Second parameter error number can be any value but as this example shows it can be 0 not to specify any
This API does not write the business function object name and line number.

jdeTraceSz1 ()

Prototype:

void jdeTraceSz1( NULL, /* Set this value Null */
const JCHAR *format, /* Error String with Dereferncing Error for next parameter */
,... /* As many as you define de-referencing in * format */
)

Example 1 (De-reference number):

long lNumber = 0 ; /* declare variable - declare this in the code block*/

MathNumericToLong(&lpDS->mnUnallowableAmtTot_EHGOVUNTOT, &lNumber); /* Convert JDE MathNumeric to Long */
jdeTraceSz1(NULL, _J("For Debug:F20111_FetchExpRptHeader : Value from ExpRpt Header is = (%ld)"), lNumber);

Note: in case above code does not write long integer value, try,

char szTempString[42] = {0}; /* declare local variable */

FormatMathNumeric(szTempString, &lpDS->mnForAmtSelectedToMatch); /* in case you want to write mnForAmtSelectedToMatch */
jdeTraceSz1(NULL, "doseo 693 : %s", szTempString); /* this is example of non unicode business function. e.g., B7 releases */

When you need to print out actual value (memory) into jdedebug.log, this implementation can be useful
Refer to printf( const char *format ,…) API in C Programming lanague
For this example, dereferenced pointer value can be written into jdedebug.log (CallObject Kernel log) as below,

For Debug:F20111_FetchExpRptHeader : Value from ExpRpt Header is = (2147483647)

Example 2 (De-reference String):
jdeTraceSz1(NULL, _J("Before fetch %lc"),dsF0911Key1.gldct);
JDBReturn = JDB_FetchKeyed(hRequest1F0911,
        ID_F0911_DOC_TYPE__NUMBER,
        (void *)&dsF0911Key1, (short)7,
        (void *)&dsColF0911, (int)FALSE);
jdeTraceSz1(NULL, _J("After fetch %lc"),dsF0911Key1.gldct);

This is another example to show before/after image for a certain value in data pointer or data structure or pointer
According to ANSI C, the available % specifiers are,
- %c char single character
- %d (%i) int signed integer
- %e (%E) float or double exponential format
- %f float or double signed decimal
- %g (%G) float or double use %f or %e as required
- %o int unsigned octal value
- %p pointer address stored in pointer
- %s array of char sequence of characters
- %u int unsigned decimal
- %x (%X) int unsigned hex value

<Internal_Only> Our API documenation does not have API jdeTraceSz1 () information. But this API is the best one to implement to write/trace actual value in jdedebug.log. If you have prototype for this API, please put some comment in this document. </Internal_Only>