iTunes COM Interface: IITArtworkCollection Interface Reference

IITArtworkCollection Interface Reference

Represents a collection of iTunes artwork objects.

An artwork collection is always associated with an individual track.

The IITTrack::Artwork property returns the collection of artwork for the track.


Public Member Functions
Properties
HRESULT	Count ([out, retval] long *count)
	Returns the number of pieces of artwork in the collection.
HRESULT	Item ([in] long index,[out, retval] IITArtwork **iArtwork)
	Returns an IITArtwork object corresponding to the given index (1-based).
HRESULT	_NewEnum ([out, retval] IUnknown **iEnumerator)
	Returns an IEnumVARIANT object which can enumerate the collection.

HRESULT IITArtworkCollection::_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 IITArtworkCollection::Count

(

[out, retval] long *

count

)

Returns the number of pieces of artwork in the collection.

Parameters:

count

Returns the number of pieces of artwork in the collection.

Return values:

	S_OK	The operation was successful.
	E_POINTER	count is NULL.
	ITUNES_E_OBJECTDELETED	The track containing this artwork has been deleted.
	E_FAIL	An unexpected error occurred.

HRESULT IITArtworkCollection::Item	(	[in] long	index,
		[out, retval] IITArtwork **	iArtwork
	)

Returns an IITArtwork object corresponding to the given index (1-based).

Parameters:

	index	1-based index of IITArtwork to retrieve.
	iArtwork	Returns an IITArtwork object corresponding to the specified index.

Return values:

	S_OK	The operation was successful.
	S_FALSE	index is too high.
	E_INVALIDARG	index is less than one.
	E_POINTER	iArtwork is NULL.
	ITUNES_E_OBJECTDELETED	The track containing this artwork has been deleted.
	E_FAIL	An unexpected error occurred.