IITSourceCollection Interface Reference

List of all members.

---

Detailed Description

Represents a collection of source objects.

Note that collection indices are always 1-based.

You can retrieve all the sources using IiTunes::Sources().

Public Member Functions
Properties
HRESULT	Count ([out, retval] long *count)
	Returns the number of sources in the collection.
HRESULT	Item ([in] long index,[out, retval] IITSource **iSource)
	Returns an IITSource object corresponding to the given index (1-based).
HRESULT	ItemByName ([in] BSTR name,[out, retval] IITSource **iSource)
	Returns an IITSource 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] IITSource **iSource)
	Returns an IITSource object with the specified persistent ID. See the documentation on IITObject for more information on persistent IDs.

---

Member Function Documentation

HRESULT IITSourceCollection::_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 IITSourceCollection::Count (  [out, retval] long *  count  )

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

HRESULT IITSourceCollection::Item (  [in] long  index, [out, retval] IITSource **  iSource )

Returns an IITSource object corresponding to the given index (1-based). Parameters: index  Index of the source to retrieve, must be less than or equal to IITSourceCollection::Count(). iSource  Returns an IITSource object corresponding to the given index. Will be set to NULL if no source 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  iSource is NULL. E_FAIL  An unexpected error occurred.

HRESULT IITSourceCollection::ItemByName (  [in] BSTR  name, [out, retval] IITSource **  iSource )

Returns an IITSource object with the specified name. Parameters: name  The name of the source to retrieve. iSource  Returns an IITSource object with the specified name. Will be set to NULL if no source could be retrieved. Return values: S_OK  The operation was successful. S_FALSE  A source with the specified name could not be found. E_INVALIDARG  name is empty. E_POINTER  name or iSource is NULL. E_FAIL  An unexpected error occurred.

HRESULT IITSourceCollection::ItemByPersistentID (  [in] long  highID, [in] long  lowID, [out, retval] IITSource **  iSource )

Returns an IITSource 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. iSource  Returns an IITSource object with the specified persistent ID. Will be set to NULL if no source could be retrieved. Return values: S_OK  The operation was successful. S_FALSE  A source with the specified persistent ID could not be found. E_POINTER  iSource is NULL. E_FAIL  An unexpected error occurred.

---