Copyright © 2005-2016 MultiMedia Soft

CuePointsLoadFromFile method

Previous pageReturn to chapter overviewNext page

Remarks

 

Loads a set of cue points from a CUE file.

CUE files are in XML format and contain settings for defining a pool of pre-defined cue points: CUE files can be created through your own code or through a call to the CuePointsSaveToFile 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 CuePointsLoadFromFile (

nPlayerIndex as Int16,

strPathname as string

) as enumErrorCodes


 

[C#]

public enumErrorCodes CuePointsLoadFromFile (

Int16 nPlayerIndex,

string strPathname

);


 

[C++]

public: enumErrorCodes CuePointsLoadFromFile (

Int16 nPlayerIndex,

string strPathname

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

strPathname

String containing the absolute pathname of the source CUE file.

 

 

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.