CuePointsRemove method

CuePointsRemove method

Remarks

Removes an existing cue point from the given player.

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

Syntax

[Visual Basic]

control.CuePointsRemove (

nPlayer as Integer,

strCuePointName as String

[C++]

short control.CuePointsRemove (

short nPlayer,

LPCTSTR strCuePointName

);

Parameter	Description

nPlayer	Number representing the zero-based index of the involved player
strCuePointName	String containing the unique name of the cue point as defined when the cue point was added through the CuePointsAdd method. An empty string would cause deleting all of the existing cue points.

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.