HistHookGetErrorQFieldName

Description:

The HistHookGetErrorQFieldName function is called by the HistQReader to query the name of the field in ErrorQ table. When this function is called, based on the value of the fieldNameKey parameter, it either returns custom column names of the ErrorQ table or NULL. If NULL value is returned, then the default column field name is used.

Syntax

char* HistHookGetErrorQFieldName(short fieldNameKey)

Parameters:

• fieldNameKey

  • Type: Short Integer

  • Description: Contains the number of the field names of the ErrorQ table. The default values of fieldNameKey parameter are 1, 2, and 3: which represent the Message, RetryCount, and ErrorID columns of the ErrorQ table.

Return Type: char*

This function returns the field names from the ErrorQ table of the BatchHistory database. The returned string must remain allocated (that is, it must return a static buffer).