CuePointsEnable method

CuePointsEnable method

Remarks

Enables/disables the given cue point. You can know the status of a cue point by calling the CuePointsIsEnabled method.

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

Syntax

[Visual Basic]

Public Function CuePointsEnable (

nPlayerIndex as Int16,

strCuePointName as string,

bEnable as Boolean

[C#]

public enumErrorCodes CuePointsEnable (

Int16 nPlayerIndex,

string strCuePointName,

bool bEnable

);

[C++]

public: enumErrorCodes CuePointsEnable (

Int16 nPlayerIndex,

string strCuePointName,

bool bEnable

);

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.

bEnable

Boolean value that tells if the cue point must be enabled or disabled.

Supported values are the following:

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.