CuePointsGetPos method

CuePointsGetPos method

Remarks

Obtains the current position for the given cue point.

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

Syntax

[Visual Basic]

Public Function CuePointsGetPos (

nPlayerIndex as Int16,

strCuePointName as string

) as Int32

[C#]

public Int32 CuePointsGetPos (

Int16 nPlayerIndex,

string strCuePointName

);

[C++]

public: Int32 CuePointsGetPos (

Int16 nPlayerIndex,

string 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.

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
Value > 0	The cue point position expressed in milliseconds