HistHookBatchId

Description:

The HistHookBatchId function is called during the start of the batch. When the function is called, it creates an entry in the BatchIdLog table of the BatchHistory database.

Syntax

char * HistHookBatchId(char* szBatchServerName, char* szBatchKey, H_BatchIdLog* pBatchIdLog)

Parameters:

• szBatchServerName

  • Type: char*

  • Description: Contains the name of the batch server configured in system parameters

• szBatchKey

  • Type: char*

  • Description: Contains the unique identification string for a batch

• pBatchIdLog

  • Type: H_BatchIdLog*

  • Description: Points to the structure of H_BatchIdLog that refers to the BatchIdLog table of the BatchHistory database

Return type: char*

This function returns an insert query for BatchIdLog table of the BatchHistory database. The returned string must remain allocated (that is, it must return a static buffer).