iTunes COM Interface: IITSource Interface Reference

iTunes COM

previous page next page
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

IITSource Interface Reference

Inheritance diagram for IITSource:

IITObject IITIPodSource List of all members.

Detailed Description

Represents an entry in the Source list (music library, CD, device, etc.).

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

Public Member Functions

Properties
HRESULT Kind ([out, retval] ITSourceKind *kind)
 Returns the kind of the source.
HRESULT Capacity ([out, retval] double *capacity)
 Returns the total size of the source, if it has a fixed size.
HRESULT FreeSpace ([out, retval] double *freespace)
 Returns the free space on the source, if it has a fixed size.
HRESULT Playlists ([out, retval] IITPlaylistCollection **iPlaylistCollection)
 Returns a collection containing the playlists in this source.

Member Function Documentation

HRESULT IITSource::Capacity (  [out, retval] double *  capacity  ) 
 

Returns the total size of the source, if it has a fixed size.

Parameters:
capacity Returns the total size of the source, if it has a fixed size. Will be set to 0 if the source does not have a fixed size.
Return values:
S_OK The operation was successful.
E_POINTER capacity is NULL.
ITUNES_E_OBJECTDELETED This source is no longer available.
E_FAIL An unexpected error occurred.

HRESULT IITSource::FreeSpace (  [out, retval] double *  freespace  ) 
 

Returns the free space on the source, if it has a fixed size.

Parameters:
freespace Returns the free space on the source, if it has a fixed size. Will be set to 0 if the source does not have a fixed size.
Return values:
S_OK The operation was successful.
E_POINTER freespace is NULL.
ITUNES_E_OBJECTDELETED This source is no longer available.
E_FAIL An unexpected error occurred.

HRESULT IITSource::Kind (  [out, retval] ITSourceKind *  kind  ) 
 

Returns the kind of the source.

Parameters:
kind Returns the kind of the source.
Return values:
S_OK The operation was successful.
E_POINTER kind is NULL.
ITUNES_E_OBJECTDELETED This source is no longer available.
E_FAIL An unexpected error occurred.

HRESULT IITSource::Playlists (  [out, retval] IITPlaylistCollection **  iPlaylistCollection  ) 
 

Returns a collection containing the playlists in this source.

The source's primary playlist is always the first playlist in the collection.

Parameters:
iPlaylistCollection Collection of IITPlaylist objects.
Return values:
S_OK The operation was successful.
E_POINTER iPlaylistCollection is NULL.
ITUNES_E_OBJECTDELETED This source is no longer available.
E_FAIL An unexpected error occurred.

Generated on Fri Mar 13 12:50:54 2009 for iTunes 8.1.0.52
©2004-2007 Apple Computer, Inc.

previous page start next page