HistHookFoxAlarmComment

Description:

The HistHookFoxAlarmComment function is called when the operator adds a comment to an alarm. When this function is called, it creates an entry in the AlarmComment table of the BatchHistory database.

Syntax

char* HistHookFoxAlarmComment(char* szBatchServerName, H_FoxAlarmComment* pFoxAlarmComment)

Parameters:

• szBatchServerName

  • Type: char*

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

• pCLB

  • Type: H_CLB*

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

• pEvent

  • Type: H_Event*

  • Description: Points to the structure of the H_FoxAlarmComment that refers to the AlarmComment table of the BatchHistory database

Return Type: char*

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

Note: HistHookFoxAlarmComment is applicable only when Foxboro DCS Components were installed.