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

IITBrowserWindow Interface Reference

Inheritance diagram for IITBrowserWindow:

IITWindow List of all members.

Detailed Description

Represents the main browser window.

You can retrieve the main browser window using the IiTunes::BrowserWindow property.

Public Member Functions

Properties
HRESULT MiniPlayer ([out, retval] VARIANT_BOOL *isMiniPlayer)
 Returns true if browser window is in Mini Player mode.
HRESULT MiniPlayer ([in] VARIANT_BOOL shouldBeMiniPlayer)
 Switch into or out of Mini Player mode.
HRESULT SelectedTracks ([out, retval] IITTrackCollection **iTrackCollection)
 Returns a collection containing the currently selected track or tracks.
HRESULT SelectedPlaylist ([out, retval] IITPlaylist **iPlaylist)
 Returns the currently selected playlist in the Source list.
HRESULT SelectedPlaylist ([in] VARIANT *iPlaylist)
 Sets the currently selected playlist in the Source list.

Member Function Documentation

HRESULT IITBrowserWindow::MiniPlayer (  [in] VARIANT_BOOL  shouldBeMiniPlayer  ) 
 

Switch into or out of Mini Player mode.

Parameters:
shouldBeMiniPlayer If true, switch to Mini Player mode.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED The window is maximized.
ITUNES_E_OBJECTDELETED The window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITBrowserWindow::MiniPlayer (  [out, retval] VARIANT_BOOL *  isMiniPlayer  ) 
 

Returns true if browser window is in Mini Player mode.

Parameters:
isMiniPlayer Returns true if browser window is in Mini Player mode.
Return values:
S_OK The operation was successful.
E_POINTER isMiniPlayer is NULL.
ITUNES_E_OBJECTDELETED The window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITBrowserWindow::SelectedPlaylist (  [in] VARIANT *  iPlaylist  ) 
 

Sets the currently selected playlist in the Source list.

Parameters:
iPlaylist The playlist to select. This must be a VARIANT of type VT_DISPATCH that points to an IITPlaylist.
Return values:
S_OK The operation was successful.
E_POINTER iPlaylist is NULL.
E_INVALIDARG iPlaylist is not the correct VARIANT type.
ITUNES_E_OBJECTDELETED The playlist has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITBrowserWindow::SelectedPlaylist (  [out, retval] IITPlaylist **  iPlaylist  ) 
 

Returns the currently selected playlist in the Source list.

Parameters:
iPlaylist Returns the currently selected playlist in the Source list.
Return values:
S_OK The operation was successful.
E_POINTER iPlaylist is NULL.
ITUNES_E_OBJECTDELETED The window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITBrowserWindow::SelectedTracks (  [out, retval] IITTrackCollection **  iTrackCollection  ) 
 

Returns a collection containing the currently selected track or tracks.

Parameters:
iTrackCollection Collection of IITTrack objects. Will be set to NULL if there is no current selection.
Return values:
S_OK The operation was successful.
S_FALSE There is no current selection.
E_POINTER iTrackCollection is NULL.
ITUNES_E_OBJECTDELETED The window 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