iTunes COM Interface: IITFileOrCDTrack 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

IITFileOrCDTrack Interface Reference

Inheritance diagram for IITFileOrCDTrack:

IITTrack IITObject List of all members.

Detailed Description

Represents a file or CD track.

Public Member Functions

Properties
HRESULT Location ([out, retval] BSTR *location)
 Returns the full path to the file represented by this track.
HRESULT Podcast ([out, retval] VARIANT_BOOL *isPodcast)
 Returns true if this track is a podcast track.
HRESULT RememberBookmark ([out, retval] VARIANT_BOOL *rememberBookmark)
 Returns true if playback position is remembered for this track.
HRESULT RememberBookmark ([in] VARIANT_BOOL shouldRememberBookmark)
 Set whether the playback position is remembered for this track.
HRESULT ExcludeFromShuffle ([out, retval] VARIANT_BOOL *excludeFromShuffle)
 Returns true if this track is skipped when shuffling.
HRESULT ExcludeFromShuffle ([in] VARIANT_BOOL shouldExcludeFromShuffle)
 Set whether this track is skipped when shuffling.
HRESULT Lyrics ([out, retval] BSTR *lyrics)
 Returns the lyrics for the track.
HRESULT Lyrics ([in] BSTR lyrics)
 Sets the lyrics for the track.
HRESULT Category ([out, retval] BSTR *category)
 Returns the category for the track.
HRESULT Category ([in] BSTR category)
 Sets the category for the track.
HRESULT Description ([out, retval] BSTR *description)
 Returns the description for the track.
HRESULT Description ([in] BSTR description)
 Sets the description for the track.
HRESULT LongDescription ([out, retval] BSTR *longDescription)
 Returns the long description for the track.
HRESULT LongDescription ([in] BSTR longDescription)
 Sets the long description for the track.
HRESULT BookmarkTime ([out, retval] long *bookmarkTime)
 Returns the bookmark time of the track (in seconds). This will always be zero if the track is not bookmarkable.
HRESULT BookmarkTime ([in] long bookmarkTime)
 Set the bookmark time of the track (in seconds).
HRESULT VideoKind ([out, retval] ITVideoKind *videoKind)
 Returns the video track kind. This will be ITVideoKindNone if the track is not a video track.
HRESULT VideoKind ([in] ITVideoKind videoKind)
 Set the video track kind. Note that the video kind cannot be changed for purchased content.
HRESULT SkippedCount ([out, retval] long *skippedCount)
 Returns the number of times the track has been skipped.
HRESULT SkippedCount ([in] long skippedCount)
 Set the number of times the track has been skipped. This property cannot be set if the track is not playable (e.g. a PDF file).
HRESULT SkippedDate ([out, retval] DATE *skippedDate)
 Returns the date and time the track was last skipped.
HRESULT SkippedDate ([in] DATE skippedDate)
 Set the date and time the track was last skipped. This property cannot be set if the track is not playable (e.g. a PDF file).
HRESULT PartOfGaplessAlbum ([out, retval] VARIANT_BOOL *partOfGaplessAlbum)
 Returns true if this track is part of a gapless album.
HRESULT PartOfGaplessAlbum ([in] VARIANT_BOOL shouldBePartOfGaplessAlbum)
 Set whether this track is part of a gapless album.
HRESULT AlbumArtist ([out, retval] BSTR *albumArtist)
 Returns the name of the album artist of the track.
HRESULT AlbumArtist ([in] BSTR albumArtist)
 Set the name of the album artist of the track.
HRESULT Show ([out, retval] BSTR *showName)
 Returns the show name of the track.
HRESULT Show ([in] BSTR showName)
 Set the show name of the track.
HRESULT SeasonNumber ([out, retval] long *seasonNumber)
 Returns the season number of the track.
HRESULT SeasonNumber ([in] long seasonNumber)
 Set the season number of the track.
HRESULT EpisodeID ([out, retval] BSTR *episodeID)
 Returns the episode ID of the track.
HRESULT EpisodeID ([in] BSTR episodeID)
 Set the episode ID of the track.
HRESULT EpisodeNumber ([out, retval] long *episodeNumber)
 Returns the episode number of the track.
HRESULT EpisodeNumber ([in] long episodeNumber)
 Set the episode number of the track.
HRESULT Size64High ([out, retval] long *sizeHigh)
 Returns the high 32-bits of the size of the track (in bytes).
HRESULT Size64Low ([out, retval] long *sizeLow)
 Returns the low 32-bits of the size of the track (in bytes).
HRESULT Unplayed ([out, retval] VARIANT_BOOL *isUnplayed)
 Returns false if this track has been played.
HRESULT Unplayed ([in] VARIANT_BOOL shouldBeUnplayed)
 Set whether this track has been played.
HRESULT SortAlbum ([out, retval] BSTR *album)
 Returns the name of the album used for sorting. If a sort album is specified, iTunes will use this string instead of the real album name when sorting.
HRESULT SortAlbum ([in] BSTR album)
 Set the name of the album used for sorting. If a sort album is specified, iTunes will use this string instead of the real album name when sorting.
HRESULT SortAlbumArtist ([out, retval] BSTR *albumArtist)
 Returns the name of the album artist used for sorting. If a sort album artist is specified, iTunes will use this string instead of the real album artist when sorting.
HRESULT SortAlbumArtist ([in] BSTR albumArtist)
 Set the name of the album artist used for sorting. If a sort album artist is specified, iTunes will use this string instead of the real album artist when sorting.
HRESULT SortArtist ([out, retval] BSTR *artist)
 Returns the name of the artist used for sorting. If a sort artist is specified, iTunes will use this string instead of the real artist when sorting.
HRESULT SortArtist ([in] BSTR artist)
 Set the name of the artist used for sorting. If a sort artist is specified, iTunes will use this string instead of the real artist when sorting.
HRESULT SortComposer ([out, retval] BSTR *composer)
 Returns the composer used for sorting. If a sort composer is specified, iTunes will use this string instead of the real composer when sorting.
HRESULT SortComposer ([in] BSTR composer)
 Set the composer used for sorting. If a sort composer is specified, iTunes will use this string instead of the real composer when sorting.
HRESULT SortName ([out, retval] BSTR *name)
 Returns the name of the track used for sorting. If a sort name is specified, iTunes will use this string instead of the real track name when sorting.
HRESULT SortName ([in] BSTR name)
 Set the name of the track used for sorting. If a sort name is specified, iTunes will use this string instead of the real track name when sorting.
HRESULT SortShow ([out, retval] BSTR *showName)
 Returns the show name used for sorting. If a sort show is specified, iTunes will use this string instead of the real show name when sorting.
HRESULT SortShow ([in] BSTR showName)
 Set the show name used for sorting. If a sort show is specified, iTunes will use this string instead of the real show name when sorting.
HRESULT AlbumRating ([out, retval] long *rating)
 Returns the user or computed rating of the album that this track belongs to (0 to 100). If the album rating has never been set, or has been set to 0, it will be computed based on the ratings of tracks in the album.
HRESULT AlbumRating ([in] long rating)
 Set the album rating of the album that this track belongs to (0 to 100). If the album rating is set to 0, it will be computed based on the ratings of tracks in the album.
HRESULT AlbumRatingKind ([out, retval] ITRatingKind *ratingKind)
 Returns the album rating kind. If the album rating has never been set, or has been set to 0, the kind is ITRatingKindComputed. Otherwise, the kind is ITRatingKindUser.
HRESULT RatingKind ([out, retval] ITRatingKind *ratingKind)
 Returns the track rating kind. If the track rating has never been set, or has been set to 0, the kind is ITRatingKindComputed. Otherwise, the kind is ITRatingKindUser.
HRESULT Playlists ([out, retval] IITPlaylistCollection **iPlaylistCollection)
 Returns a collection of playlists that contain the song that this track represents.
HRESULT Location ([in] BSTR location)
 Set the full path to the file represented by this track. iTunes will not move or copy any existing file from the track's current location to the new location, the full path must point to an existing file that is playable by iTunes. Attempting to set the location of a track on CD will always fail with E_INVALIDARG.
HRESULT ReleaseDate ([out, retval] DATE *releaseDate)
 Returns release date of the track. This property is read-only.
Methods
HRESULT UpdateInfoFromFile ()
 Update this track's information with the information stored in its file.
HRESULT UpdatePodcastFeed ()
 Update the podcast feed for this track. This is equivalent to the user choosing Update Podcast from the contextual menu for the podcast feed that contains this track.
HRESULT Reveal ()
 Reveals the track in the main browser window.

Member Function Documentation

HRESULT IITFileOrCDTrack::AlbumArtist (  [in] BSTR  albumArtist  ) 
 

Set the name of the album artist of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
albumArtist The new name of the album artist of the track.
Return values:
S_OK The operation was successful.
E_POINTER albumArtist is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::AlbumArtist (  [out, retval] BSTR *  albumArtist  ) 
 

Returns the name of the album artist of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
albumArtist Returns the name of the album artist of the track.
Return values:
S_OK The operation was successful.
E_POINTER albumArtist is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::AlbumRating (  [in] long  rating  ) 
 

Set the album rating of the album that this track belongs to (0 to 100). If the album rating is set to 0, it will be computed based on the ratings of tracks in the album.

Note:
This property is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Parameters:
rating The new album rating of the album that this track belongs to (0 to 100). If rating is outside this range, it will be pinned.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::AlbumRating (  [out, retval] long *  rating  ) 
 

Returns the user or computed rating of the album that this track belongs to (0 to 100). If the album rating has never been set, or has been set to 0, it will be computed based on the ratings of tracks in the album.

Note:
This property is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Parameters:
rating Returns the album rating of the album that this track belongs to (0 to 100).
Return values:
S_OK The operation was successful.
E_POINTER rating is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::AlbumRatingKind (  [out, retval] ITRatingKind *  ratingKind  ) 
 

Returns the album rating kind. If the album rating has never been set, or has been set to 0, the kind is ITRatingKindComputed. Otherwise, the kind is ITRatingKindUser.

Note:
This property is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Parameters:
ratingKind Returns the album rating kind.
Return values:
S_OK The operation was successful.
E_POINTER ratingKind is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::BookmarkTime (  [in] long  bookmarkTime  ) 
 

Set the bookmark time of the track (in seconds).

Note:
This property is available in iTunes 6.0.2 and later (iTunes type library 1.7 and later).
Parameters:
bookmarkTime The new bookmark time of the track (in seconds).
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable or is not bookmarkable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::BookmarkTime (  [out, retval] long *  bookmarkTime  ) 
 

Returns the bookmark time of the track (in seconds). This will always be zero if the track is not bookmarkable.

Note:
This property is available in iTunes 6.0.2 and later (iTunes type library 1.7 and later).
Parameters:
bookmarkTime Returns the bookmark time of the track (in seconds).
Return values:
S_OK The operation was successful.
E_POINTER bookmarkTime is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Category (  [in] BSTR  category  ) 
 

Sets the category for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
category The new category for the track.
Return values:
S_OK The operation was successful.
E_POINTER category is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Category (  [out, retval] BSTR *  category  ) 
 

Returns the category for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
category Returns the category for the track.
Return values:
S_OK The operation was successful.
E_POINTER category is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Description (  [in] BSTR  description  ) 
 

Sets the description for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
description The new description for the track.
Return values:
S_OK The operation was successful.
E_POINTER description is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Description (  [out, retval] BSTR *  description  ) 
 

Returns the description for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
description Returns the description for the track.
Return values:
S_OK The operation was successful.
E_POINTER description is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::EpisodeID (  [in] BSTR  episodeID  ) 
 

Set the episode ID of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
episodeID The new episode ID of the track.
Return values:
S_OK The operation was successful.
E_POINTER episodeID is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::EpisodeID (  [out, retval] BSTR *  episodeID  ) 
 

Returns the episode ID of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
episodeID Returns the episode ID of the track.
Return values:
S_OK The operation was successful.
E_POINTER episodeID is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::EpisodeNumber (  [in] long  episodeNumber  ) 
 

Set the episode number of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
episodeNumber The new episode number of the track.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::EpisodeNumber (  [out, retval] long *  episodeNumber  ) 
 

Returns the episode number of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
episodeNumber Returns the episode number of the track.
Return values:
S_OK The operation was successful.
E_POINTER episodeNumber is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::ExcludeFromShuffle (  [in] VARIANT_BOOL  shouldExcludeFromShuffle  ) 
 

Set whether this track is skipped when shuffling.

Audio books are always skipped when shuffling.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
shouldExcludeFromShuffle True if this track should be skipped when shuffling.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable, or this track is an audio book.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::ExcludeFromShuffle (  [out, retval] VARIANT_BOOL *  excludeFromShuffle  ) 
 

Returns true if this track is skipped when shuffling.

Audio books are always skipped when shuffling.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
excludeFromShuffle Returns true if this track is skipped when shuffling.
Return values:
S_OK The operation was successful.
E_POINTER excludeFromShuffle is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Location (  [in] BSTR  location  ) 
 

Set the full path to the file represented by this track. iTunes will not move or copy any existing file from the track's current location to the new location, the full path must point to an existing file that is playable by iTunes. Attempting to set the location of a track on CD will always fail with E_INVALIDARG.

Note:
This property is available in iTunes 8.1 and later (iTunes type library 1.12 and later).
Parameters:
location The full path to the file represented by this track.
Return values:
S_OK The operation was successful.
E_INVALIDARG location is not a valid file (e.g. no file at this location, the file can't be played by iTunes, the location is a directory, or the track is on CD)
E_POINTER location is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Location (  [out, retval] BSTR *  location  ) 
 

Returns the full path to the file represented by this track.

Parameters:
location Returns the full path to the file represented by this track.
Return values:
S_OK The operation was successful.
S_FALSE The location could not be retrieved (e.g. no file exists at the expected location).
E_POINTER location is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::LongDescription (  [in] BSTR  longDescription  ) 
 

Sets the long description for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
longDescription The new long description for the track.
Return values:
S_OK The operation was successful.
E_POINTER longDescription is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::LongDescription (  [out, retval] BSTR *  longDescription  ) 
 

Returns the long description for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
longDescription Returns the long description for the track.
Return values:
S_OK The operation was successful.
E_POINTER longDescription is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Lyrics (  [in] BSTR  lyrics  ) 
 

Sets the lyrics for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
lyrics The new lyrics for the track.
Return values:
S_OK The operation was successful.
E_POINTER lyrics is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Lyrics (  [out, retval] BSTR *  lyrics  ) 
 

Returns the lyrics for the track.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
lyrics Returns the lyrics for the track.
Return values:
S_OK The operation was successful.
E_POINTER lyrics is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::PartOfGaplessAlbum (  [in] VARIANT_BOOL  shouldBePartOfGaplessAlbum  ) 
 

Set whether this track is part of a gapless album.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
shouldBePartOfGaplessAlbum True if this track should be part of a gapless album.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::PartOfGaplessAlbum (  [out, retval] VARIANT_BOOL *  partOfGaplessAlbum  ) 
 

Returns true if this track is part of a gapless album.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
partOfGaplessAlbum Returns true if this track is part of a gapless album.
Return values:
S_OK The operation was successful.
E_POINTER partOfGaplessAlbum is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

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

Returns a collection of playlists that contain the song that this track represents.

This is the same collection of playlists that are shown in the "Show in Playlist" contextual menu for a track, plus the specific playlist that contains this track.

A track represents a song in a single playlist, use IITTrack::Playlist() to get the specific playlist that contains this track.

Note:
This property is available in iTunes 7.7 and later (iTunes type library 1.11 and later).
Parameters:
iPlaylistCollection Collection of IITPlaylist objects.
Return values:
S_OK The operation was successful.
E_POINTER iPlaylistCollection is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Podcast (  [out, retval] VARIANT_BOOL *  isPodcast  ) 
 

Returns true if this track is a podcast track.

Note:
This property is available in iTunes 4.9 and later (iTunes type library 1.4 and later).
Parameters:
isPodcast Returns true if this track is a podcast track.
Return values:
S_OK The operation was successful.
E_POINTER isPodcast is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::RatingKind (  [out, retval] ITRatingKind *  ratingKind  ) 
 

Returns the track rating kind. If the track rating has never been set, or has been set to 0, the kind is ITRatingKindComputed. Otherwise, the kind is ITRatingKindUser.

Note:
This property is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Parameters:
ratingKind Returns the track rating kind.
Return values:
S_OK The operation was successful.
E_POINTER ratingKind is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::ReleaseDate (  [out, retval] DATE *  releaseDate  ) 
 

Returns release date of the track. This property is read-only.

A value of zero means no release date.

Note:
This property is available in iTunes 8.1 and later (iTunes type library 1.12 and later).
Parameters:
releaseDate Returns the release date of the track.
Return values:
S_OK The operation was successful.
E_POINTER releaseDate is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::RememberBookmark (  [in] VARIANT_BOOL  shouldRememberBookmark  ) 
 

Set whether the playback position is remembered for this track.

The playback position is always remembered for audio books.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
shouldRememberBookmark True if playback position should be remembered for this track.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable, or this track is an audio book.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::RememberBookmark (  [out, retval] VARIANT_BOOL *  rememberBookmark  ) 
 

Returns true if playback position is remembered for this track.

The playback position is always remembered for audio books.

Note:
This property is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Parameters:
rememberBookmark Returns true if playback position is remembered for this track.
Return values:
S_OK The operation was successful.
E_POINTER rememberBookmark is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Reveal (   ) 
 

Reveals the track in the main browser window.

Note:
This method is available in iTunes 7.4 and later (iTunes type library 1.10 and later).
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SeasonNumber (  [in] long  seasonNumber  ) 
 

Set the season number of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
seasonNumber The new season number of the track.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SeasonNumber (  [out, retval] long *  seasonNumber  ) 
 

Returns the season number of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
seasonNumber Returns the season number of the track.
Return values:
S_OK The operation was successful.
E_POINTER seasonNumber is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Show (  [in] BSTR  showName  ) 
 

Set the show name of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
showName The new show name of the track.
Return values:
S_OK The operation was successful.
E_POINTER showName is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Show (  [out, retval] BSTR *  showName  ) 
 

Returns the show name of the track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
showName Returns the show name of the track.
Return values:
S_OK The operation was successful.
E_POINTER showName is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Size64High (  [out, retval] long *  sizeHigh  ) 
 

Returns the high 32-bits of the size of the track (in bytes).

You can use IITTrack::Size() if you know the size of the track is less than 4GB. Otherwise, use IITFileOrCDTrack::Size64High() and IITFileOrCDTrack::Size64Low() to determine the full 64-bit size.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
sizeHigh Returns the high 32-bits of the size of the track (in bytes).
Return values:
S_OK The operation was successful.
E_POINTER sizeHigh is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Size64Low (  [out, retval] long *  sizeLow  ) 
 

Returns the low 32-bits of the size of the track (in bytes).

You can use IITTrack::Size() if you know the size of the track is less than 4GB. Otherwise, use IITFileOrCDTrack::Size64High() and IITFileOrCDTrack::Size64Low() to determine the full 64-bit size.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
sizeLow Returns the low 32-bits of the size of the track (in bytes).
Return values:
S_OK The operation was successful.
E_POINTER sizeLow is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SkippedCount (  [in] long  skippedCount  ) 
 

Set the number of times the track has been skipped. This property cannot be set if the track is not playable (e.g. a PDF file).

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
skippedCount The new number of times the track has been skipped.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SkippedCount (  [out, retval] long *  skippedCount  ) 
 

Returns the number of times the track has been skipped.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
skippedCount Returns the number of times the track has been skipped.
Return values:
S_OK The operation was successful.
E_POINTER skippedCount is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SkippedDate (  [in] DATE  skippedDate  ) 
 

Set the date and time the track was last skipped. This property cannot be set if the track is not playable (e.g. a PDF file).

A value of zero means no skipped date.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
skippedDate The new date and time the track was last skipped.
Return values:
S_OK The operation was successful.
E_INVALIDARG skippedDate is invalid.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SkippedDate (  [out, retval] DATE *  skippedDate  ) 
 

Returns the date and time the track was last skipped.

A value of zero means no skipped date.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
skippedDate Returns the date and time the track was last skipped.
Return values:
S_OK The operation was successful.
E_POINTER skippedDate is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortAlbum (  [in] BSTR  album  ) 
 

Set the name of the album used for sorting. If a sort album is specified, iTunes will use this string instead of the real album name when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
album The new sort name of the album.
Return values:
S_OK The operation was successful.
E_POINTER album is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortAlbum (  [out, retval] BSTR *  album  ) 
 

Returns the name of the album used for sorting. If a sort album is specified, iTunes will use this string instead of the real album name when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
album Returns the name of the album used for sorting.
Return values:
S_OK The operation was successful.
E_POINTER album is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortAlbumArtist (  [in] BSTR  albumArtist  ) 
 

Set the name of the album artist used for sorting. If a sort album artist is specified, iTunes will use this string instead of the real album artist when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
albumArtist The new name of the album artist used for sorting.
Return values:
S_OK The operation was successful.
E_POINTER albumArtist is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortAlbumArtist (  [out, retval] BSTR *  albumArtist  ) 
 

Returns the name of the album artist used for sorting. If a sort album artist is specified, iTunes will use this string instead of the real album artist when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
albumArtist Returns the name of the album artist used for sorting.
Return values:
S_OK The operation was successful.
E_POINTER albumArtist is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortArtist (  [in] BSTR  artist  ) 
 

Set the name of the artist used for sorting. If a sort artist is specified, iTunes will use this string instead of the real artist when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
artist The new sort artist for the track.
Return values:
S_OK The operation was successful.
E_POINTER artist is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortArtist (  [out, retval] BSTR *  artist  ) 
 

Returns the name of the artist used for sorting. If a sort artist is specified, iTunes will use this string instead of the real artist when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
artist Returns the name of the artist used for sorting.
Return values:
S_OK The operation was successful.
E_POINTER artist is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortComposer (  [in] BSTR  composer  ) 
 

Set the composer used for sorting. If a sort composer is specified, iTunes will use this string instead of the real composer when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
composer The new sort composer for the track.
Return values:
S_OK The operation was successful.
E_POINTER composer is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortComposer (  [out, retval] BSTR *  composer  ) 
 

Returns the composer used for sorting. If a sort composer is specified, iTunes will use this string instead of the real composer when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
composer Returns the composer used for sorting.
Return values:
S_OK The operation was successful.
E_POINTER composer is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortName (  [in] BSTR  name  ) 
 

Set the name of the track used for sorting. If a sort name is specified, iTunes will use this string instead of the real track name when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
name The new sort name for the track.
Return values:
S_OK The operation was successful.
E_POINTER name is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortName (  [out, retval] BSTR *  name  ) 
 

Returns the name of the track used for sorting. If a sort name is specified, iTunes will use this string instead of the real track name when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
name Returns the name of the track used for sorting.
Return values:
S_OK The operation was successful.
E_POINTER name is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortShow (  [in] BSTR  showName  ) 
 

Set the show name used for sorting. If a sort show is specified, iTunes will use this string instead of the real show name when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
showName The new sort show name of the track.
Return values:
S_OK The operation was successful.
E_POINTER showName is NULL.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::SortShow (  [out, retval] BSTR *  showName  ) 
 

Returns the show name used for sorting. If a sort show is specified, iTunes will use this string instead of the real show name when sorting.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
showName Returns the sort show name of the track.
Return values:
S_OK The operation was successful.
E_POINTER showName is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Unplayed (  [in] VARIANT_BOOL  shouldBeUnplayed  ) 
 

Set whether this track has been played.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
shouldBeUnplayed True if this track should marked as unplayed.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED This track is not modifiable.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::Unplayed (  [out, retval] VARIANT_BOOL *  isUnplayed  ) 
 

Returns false if this track has been played.

Note:
This property is available in iTunes 7.1 and later (iTunes type library 1.9 and later).
Parameters:
isUnplayed Returns false if this track has been played.
Return values:
S_OK The operation was successful.
E_POINTER isUnplayed is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::UpdateInfoFromFile (   ) 
 

Update this track's information with the information stored in its file.

If you have edited this track's metadata (such as song name, album, artist, etc.) with another program outside of iTunes, you can call this method to force iTunes to update its internal information with the current information stored in the track's file.

Note:
This method is available in iTunes 4.7 and later (iTunes type library 1.2 and later).
Return values:
S_OK The operation was successful.
S_FALSE The file could not be found (e.g. no file exists at the expected location).
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::UpdatePodcastFeed (   ) 
 

Update the podcast feed for this track. This is equivalent to the user choosing Update Podcast from the contextual menu for the podcast feed that contains this track.

Note:
This method is available in iTunes 5.0 and later (iTunes type library 1.5 and later).
Return values:
S_OK The operation was successful.
E_INVALIDARG This track is not a podcast.
ITUNES_E_PODCASTSDISABLED Access to podcasts is disabled in the preferences.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::VideoKind (  [in] ITVideoKind  videoKind  ) 
 

Set the video track kind. Note that the video kind cannot be changed for purchased content.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
videoKind The new video kind of the track.
Return values:
S_OK The operation was successful.
E_INVALIDARG Invalid video kind specified, or the track is not a video track.
ITUNES_E_OBJECTLOCKED This track is not modifiable or is purchased content.
ITUNES_E_OBJECTDELETED This track has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITFileOrCDTrack::VideoKind (  [out, retval] ITVideoKind *  videoKind  ) 
 

Returns the video track kind. This will be ITVideoKindNone if the track is not a video track.

Note:
This property is available in iTunes 7.0 and later (iTunes type library 1.8 and later).
Parameters:
videoKind Returns the video kind of the track.
Return values:
S_OK The operation was successful.
E_POINTER videoKind is NULL.
ITUNES_E_OBJECTDELETED This track has been deleted.
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