PlayListAddItemEx method

PlayListAddItemEx method

Remarks

Adds a song or another playlist or the full content of a directory to the loaded playlist.

For further details about playlists management see the How to create and manage a playlist tutorial.

Syntax

[Visual Basic]

control.PlayListAddItemEx (

nPlayer as Integer,

strPathname as String,

nIndex as Integer,

nItemType as enumPlayListItemType

) as enumErrorCodes

[C++]

short control.PlayListAddItemEx (

short nPlayer,

LPCTSTR strPathname,

short nIndex,

short nItemType

);

Parameter

Description

nPlayer

Number representing the zero-based index of the player that owns the playlist

strPathname

String containing the absolute pathname of the element to add

nIndex

Number representing the zero-based insertion position: if the nIndex parameter value exceed the playlist length, the song will be placed at the bottom of the playlist

nItemType

Type of item to add

Supported values are the following:

Mnemonic constant	Value	Meaning
PLAYLIST_ITEM_SOUND_FILE	0	Adds a single sound file whose pathname is found inside the strPathname parameter
PLAYLIST_ITEM_PLAYLIST_FILE	1	Adds full contents of an existing playlist file whose pathname is specified inside the strPathname parameter
PLAYLIST_ITEM_DIRECTORY	2	Adds sound related contents of an existing directory whose path is specified inside the strPathname parameter

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The call was successful.