CuePointsSaveToFile method

CuePointsSaveToFile method

Remarks

Saves existing cue points into a destination CUE file.

CUE files are in XML format and contain settings for defining a pool of pre-defined cue points: CUE files can be loaded through a call to the CuePointsLoadFromFile method or automatically, when a sound is loaded, if the sound's filename and the CUE file's filename match: if for example the loaded sound file should be named MySong.mp3, the corresponding XML file containing cue points should be named MySong.cue

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

Syntax

[Visual Basic]

Public Function CuePointsSaveToFile (

nPlayerIndex as Int16,

strPathname as string

) as enumErrorCodes

[C#]

public enumErrorCodes CuePointsSaveToFile (

Int16 nPlayerIndex,

string strPathname

);

[C++]

public: enumErrorCodes CuePointsSaveToFile (

Int16 nPlayerIndex,

string strPathname

);

Parameter	Description

nPlayer	Number representing the zero-based index of the involved player
strPathname	String containing the absolute pathname of the destination CUE file. An empty string will force the control to search for a CUE file having the same filename of the loaded sound but with extension .cue: if for example the loaded sound file should be named MySong.mp3, the corresponding searched CUE file would be named MySong.cue

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.

Return to Table of contents