Copyright © 2001-2018 MultiMedia Soft

TriggersEnable method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enables/disable the given trigger.

 

See the How to add Triggers and Cue Points to a player section for further details about triggers.

 

 

Syntax

 

[Visual Basic]

control.TriggersEnable (

nPlayer as Integer,

nTriggerID as Integer,

bEnable as enumBoolean

) as enumErrorCodes


 

[C++]

short control.TriggersEnable (

short nPlayer,

short nTriggerID,

short bEnable

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

nTriggerID

Number representing the identifier of the new trigger. If this identifier should be already assigned to another trigger, an error code would be returned.

bEnable

Boolean value that specifies if the trigger must be enabled or disabled.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Disable trigger

BOOL_TRUE (default)

1

Enable trigger

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.