IITLibraryPlaylist Interface Reference

Inheritance diagram for IITLibraryPlaylist:

List of all members.

---

Detailed Description

Represents a library playlist.

A library playlist consists of all the tracks in a user's library.

For convenience, you can retrieve the main library playlist using IiTunes::LibraryPlaylist().

Public Member Functions
Methods
HRESULT	AddFile ([in] BSTR filePath,[out, retval] IITOperationStatus **iStatus)
	Add a file or files inside a folder to the playlist.
HRESULT	AddFiles ([in] VARIANT *filePaths,[out, retval] IITOperationStatus **iStatus)
	Add an array of files and/or folders to the playlist.
HRESULT	AddURL ([in] BSTR url,[out, retval] IITURLTrack **iURLTrack)
	Add a streaming audio URL to the playlist.
HRESULT	AddTrack ([in] VARIANT *iTrackToAdd,[out, retval] IITTrack **iAddedTrack)
	Add an existing track to the playlist.

---

Member Function Documentation

HRESULT IITLibraryPlaylist::AddFile (  [in] BSTR  filePath, [out, retval] IITOperationStatus **  iStatus )

Add a file or files inside a folder to the playlist. You cannot use this method to add a file that requires conversion to be added (e.g. a CD track), use IiTunes::ConvertFile() or IiTunes::ConvertFile2() instead. If you add a folder that contains files that require conversion, they will be skipped. Parameters: filePath  The full path to the file or folder to add. iStatus  Returns an IITOperationStatus object corresponding to the asynchronous operation. If an error occurs, or no files were added, this will be set to NULL. Return values: S_OK  The operation was successful. E_POINTER  filePath or iStatus is NULL. E_INVALIDARG  filePath is empty or too long, or refers to a file that would require conversion. ITUNES_E_OBJECTLOCKED  This playlist is read-only. ITUNES_E_OBJECTDELETED  This playlist has been deleted. E_FAIL  An unexpected error occurred.

HRESULT IITLibraryPlaylist::AddFiles (  [in] VARIANT *  filePaths, [out, retval] IITOperationStatus **  iStatus )

Add an array of files and/or folders to the playlist. You cannot use this method to add a file that requires conversion to be added (e.g. a CD track), use IiTunes::ConvertFile() or IiTunes::ConvertFile2() instead. If you add a folder that contains files that require conversion, they will be skipped. Parameters: filePaths  The single-dimensioned array of full paths to each file or folder. filePaths can be of type VT_ARRAY|VT_VARIANT, where each entry is a VT_BSTR, or VT_ARRAY|VT_BSTR. You can also pass a JScript Array object. iStatus  Returns an IITOperationStatus object corresponding to the asynchronous operation. If an error occurs, or no files were added, this will be set to NULL. Return values: S_OK  The operation was successful. E_POINTER  filePaths or iStatus is NULL. E_INVALIDARG  filePaths is the wrong VARIANT type, or includes a file that would require conversion. ITUNES_E_OBJECTLOCKED  This playlist is read-only. ITUNES_E_OBJECTDELETED  This playlist has been deleted. E_FAIL  An unexpected error occurred.

HRESULT IITLibraryPlaylist::AddTrack (  [in] VARIANT *  iTrackToAdd, [out, retval] IITTrack **  iAddedTrack )

Add an existing track to the playlist. You cannot use this method to add a CD track (ITTrackKindCD) to another playlist, use IiTunes::ConvertTrack() instead. or IiTunes::ConvertTrack2() instead. You cannot add a shared library track (ITTrackKindSharedLibrary) to another playlist. Parameters: iTrackToAdd  The track to add. This is a VARIANT of type VT_DISPATCH that points to an IITTrack. iAddedTrack  Returns an IITTrack object corresponding to the new track. Return values: S_OK  The operation was successful. E_POINTER  iTrackToAdd or iAddedTrack is NULL. E_INVALIDARG  iTrackToAdd is the wrong VARIANT type, or is a CD or shared track. ITUNES_E_OBJECTLOCKED  This playlist is read-only. ITUNES_E_OBJECTDELETED  This playlist has been deleted. E_FAIL  An unexpected error occurred.

HRESULT IITLibraryPlaylist::AddURL (  [in] BSTR  url, [out, retval] IITURLTrack **  iURLTrack )

Add a streaming audio URL to the playlist. Parameters: url  The URL to add. The length of the URL can be 255 characters or less. iURLTrack  Returns an IITURLTrack object corresponding to the new track. Return values: S_OK  The operation was successful. E_POINTER  url or iURLTrack is NULL. E_INVALIDARG  url is empty or too long. ITUNES_E_OBJECTLOCKED  This playlist is read-only. ITUNES_E_OBJECTDELETED  This playlist has been deleted. E_FAIL  An unexpected error occurred.

---