HistHookPhaseInstruction

Description:

The HistHookPhaseInstruction function is called whenever a set of instructions is to be logged in the Batch History database. When this function is called, it creates an entry in the PhaseInstruction table of the BatchHistory database. This can be called multiple times per phase instruction because a phase instruction can have unlimited length.

Syntax

char* HistHookPhaseInstruction(char* szBatchServerName, char* szBatchKey, H_CLB* pCLB, char* szPhaseKey, H_PhaseInstruction* pPhaseInstruction)

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 the batch

• pCLB

  • Type: H_CLB*

  • Description: Points to the structure that contains the information of campaign, lot, and batch

• H_PhaseInstruction

  • Type: H_PhaseInstruction*

  • Description: Points to the structure of H_PhaseInstruction that refers to the PhaseInstruction table of the BatchHistory database

• pPhaseInstruction

  • Type: H_PhaseInstruction*

  • Description: Points to the structure of H_PhaseInstruction that refers to the PhaseInstruction table of the BatchHistory database

Return Type: char*

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