|
CuePointsGetName method |
  
|
|
CuePointsGetName method |
|
Remarks
Given the position inside the list, obtains the name of the related 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 CuePointsGetName ( nPlayerIndex as Int16, nIndex as Int32 ) as Int32 |
[C#] public Int32 CuePointsGetName ( Int16 nPlayerIndex, Int32 nIndex ); |
[C++] public: Int32 CuePointsGetName ( Int16 nPlayerIndex, Int32 nIndex ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
nIndex |
Number representing the zero-based index of the cue point |
Return value
Value |
Meaning |
|
|
Empty string |
The value of the nIndex parameter was out of range. Use the value returned by the CuePointsGetCount method in order to know how many cue points are currently set. |
Valid string |
The string containing the name of the requested cue point. |
