IITWindowCollection Interface Reference

List of all members.

---

Detailed Description

Represents a collection of window objects.

Note that collection indicies are always 1-based.

You can retrieve all the windows using IiTunes::Windows().

Public Member Functions
Properties
HRESULT	Count ([out, retval] long *count)
	Returns the number of windows in the collection.
HRESULT	Item ([in] long index,[out, retval] IITWindow **iWindow)
	Returns an IITWindow object corresponding to the given index (1-based).
HRESULT	ItemByName ([in] BSTR name,[out, retval] IITWindow **iWindow)
	Returns an IITWindow object with the specified name.
HRESULT	_NewEnum ([out, retval] IUnknown **iEnumerator)
	Returns an IEnumVARIANT object which can enumerate the collection.

---

Member Function Documentation

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

Returns the number of windows in the collection. Parameters: count  Returns the number of windows in the collection. Return values: S_OK  The operation was successful. E_POINTER  count is NULL. E_FAIL  An unexpected error occurred.

HRESULT IITWindowCollection::Item (  [in] long  index, [out, retval] IITWindow **  iWindow )

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

HRESULT IITWindowCollection::ItemByName (  [in] BSTR  name, [out, retval] IITWindow **  iWindow )

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

---