Copyright © 2005-2018 MultiMedia Soft

TriggersRemove method

Previous pageReturn to chapter overviewNext page

Remarks

 

Removes an existing trigger from the given player.

 

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

 

 

Syntax

 

[Visual Basic]

Public Function TriggersRemove (

nPlayerIndex as Int16,

nTriggerID as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes TriggersRemove (

Int16 nPlayerIndex,

Int16 nTriggerID

);


 

[C++]

public: enumErrorCodes TriggersRemove (

Int16 nPlayerIndex,

Int16 nTriggerID

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

nTriggerID

Number representing the identifier of the trigger to remove. If this parameter is set to -1 all the existing triggers will be removed.

 

 

Return value

 

Value

Meaning

 

 

Negative value

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

enumErrorCodes.NOERROR (0)

The method call was successful.