HistHookViewDocument

Description:

The HistHookViewDocument function is called whenever the operator views a document from Batch Display. When this function is called, it adds an entry in the DocViewEvent table of the BatchHistory database.

Syntax

char* HistHookViewDocument(char* szBatchServerName, char* szBatchKey, H_CLB* pCLB, char* szPhaseKey, H_ViewDocument* pViewDocument)

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 batch

• pCLB

  • Type: H_CLB*

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

• szPhaseKey

  • Type: char*

  • Description: Contains the unique identification string for phase

• pViewDocument

  • Type: H_ViewDocument*

  • Description: Points to the structure of H_ViewDocument that refers to the DocViewEvent table of the BatchHistory database

Return Type: char*

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