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]
Public Function CuePointsRemove (
nPlayerIndex as Int16,
strCuePointName as string
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes CuePointsRemove (
Int16 nPlayerIndex,
string strCuePointName
);
|
|
[C++]
public: enumErrorCodes CuePointsRemove (
Int16 nPlayerIndex,
string strCuePointName
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
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.NOERROR (0)
|
The method call was successful.
|
|
