_IDVBCMClientEvents::oncampaignmgrerrormessage

Method Signatures

 

C\C++

void OnCampaignMgrErrorMessage(

BSTR bstrErrorMessage,

long lErrorCode)

VB

Private Sub DVBCMClient1_OnCampaignMgrErrorMessage(

ByVal bstrErrorMessage As String,

ByVal lErrorCode As Long)

This event is fired whenever an automatically running campaign (that is, one in auto-release, auto-start, or auto-remove) encounters a run-time problem. For instance, if the equipment information for the plant is changed and a download is performed during the execution of a campaign, this may lead to an inconsistency in the campaign's base recipe. This could cause a run-time error, and thus, cause this event to fire.

Return Values

none

Memory Allocation

none

Visual Basic Usage Example

Private Sub DVBCMClient1_OnCampaignMgrErrorMessage(ByVal _
        bstrErrorMessage As String, ByVal lErrorCode As Long)
    Call TellUserAboutError(bstrErrorMessage, lErrorCode)
End Sub

Parameter Name

Purpose

bstrErroMessage

Error string describing the problem that occurred. Includes both the campaign and batch information for the error.

lErrorCode

The accompanying error number for the error that occurred.