IITPlaylistCollection Interface Reference

List of all members.

---

Detailed Description

Represents a collection of playlist objects.

Note that collection indices are always 1-based.

You can retrieve all the playlists defined for a source using IITSource::Playlists().

Public Member Functions
Properties
HRESULT	Count ([out, retval] long *count)
	Returns the number of playlists in the collection.
HRESULT	Item ([in] long index,[out, retval] IITPlaylist **iPlaylist)
	Returns an IITPlaylist object corresponding to the given index (1-based).
HRESULT	ItemByName ([in] BSTR name,[out, retval] IITPlaylist **iPlaylist)
	Returns an IITPlaylist object with the specified name.
HRESULT	_NewEnum ([out, retval] IUnknown **iEnumerator)
	Returns an IEnumVARIANT object which can enumerate the collection.
HRESULT	ItemByPersistentID ([in] long highID,[in] long lowID,[out, retval] IITPlaylist **iPlaylist)
	Returns an IITPlaylist object with the specified persistent ID. See the documentation on IITObject for more information on persistent IDs.

---

Member Function Documentation

HRESULT IITPlaylistCollection::_NewEnum (  [out, retval] IUnknown **  iEnumerator  )

Returns an IEnumVARIANT object which can enumerate the collection. Note: This property is available in iTunes 4.7 and later (iTunes type library 1.2 and later). Parameters: iEnumerator  Returns an IEnumVARIANT object which can enumerate the collection. Return values: S_OK  The operation was successful. E_POINTER  iEnumerator is NULL. E_FAIL  An unexpected error occurred.

HRESULT IITPlaylistCollection::Count (  [out, retval] long *  count  )

Returns the number of playlists in the collection. Parameters: count  Returns the number of playlists in the collection. Return values: S_OK  The operation was successful. E_POINTER  count is NULL. ITUNES_E_OBJECTDELETED  The source containing the playlists has been deleted. E_FAIL  An unexpected error occurred.

HRESULT IITPlaylistCollection::Item (  [in] long  index, [out, retval] IITPlaylist **  iPlaylist )

Returns an IITPlaylist object corresponding to the given index (1-based). Parameters: index  Index of the playlist to retrieve, must be less than or equal to IITPlaylistCollection::Count(). iPlaylist  Returns an IITPlaylist object corresponding to the given index. Will be set to NULL if no playlist could be retrieved. Return values: S_OK  The operation was successful. S_FALSE  index is too high. E_INVALIDARG  index is less than one. E_POINTER  iPlaylist is NULL. ITUNES_E_OBJECTDELETED  The source containing the playlists has been deleted. E_FAIL  An unexpected error occurred.

HRESULT IITPlaylistCollection::ItemByName (  [in] BSTR  name, [out, retval] IITPlaylist **  iPlaylist )

Returns an IITPlaylist object with the specified name. This property will return the first playlist with the specified name, but there can be additional playlists with the same name, since playlist names are not unique. To determine all the playlists with the same name, you should use the IITPlaylistCollection::Item() property to enumerate the entire collection. Parameters: name  The name of the playlist to retrieve. iPlaylist  Returns an IITPlaylist object with the specified name. Will be set to NULL if no playlist could be retrieved. Return values: S_OK  The operation was successful. S_FALSE  A playlist with the specified name could not be found. E_INVALIDARG  name is empty. E_POINTER  name or iPlaylist is NULL. ITUNES_E_OBJECTDELETED  The source containing the playlists has been deleted. E_FAIL  An unexpected error occurred.

HRESULT IITPlaylistCollection::ItemByPersistentID (  [in] long  highID, [in] long  lowID, [out, retval] IITPlaylist **  iPlaylist )

Returns an IITPlaylist object with the specified persistent ID. See the documentation on IITObject for more information on persistent IDs. Note: This property is available in iTunes 7.7 and later (iTunes type library 1.11 and later). Parameters: highID  The high 32 bits of the 64-bit persistent ID. lowID  The low 32 bits of the 64-bit persistent ID. iPlaylist  Returns an IITPlaylist object with the specified persistent ID. Will be set to NULL if no playlist could be retrieved. Return values: S_OK  The operation was successful. S_FALSE  A playlist with the specified persistent ID could not be found. E_POINTER  iPlaylist is NULL. ITUNES_E_OBJECTDELETED  The source containing the playlists has been deleted. E_FAIL  An unexpected error occurred.

---