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

IITEQPresetCollection Interface Reference

List of all members.

Detailed Description

Represents a collection of EQ preset objects.

The IiTunes::EQPresets property returns the collection of EQ presets.

Public Member Functions

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

Member Function Documentation

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

Returns the number of EQ presets in the collection.

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

HRESULT IITEQPresetCollection::Item (  [in] long  index,
[out, retval] IITEQPreset **  iEQPreset
) 
 

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

Parameters:
index 1-based index of IITEQPreset to retrieve.
iEQPreset Returns an IITEQPreset object corresponding to the specified index.
Return values:
S_OK The operation was successful.
S_FALSE index is too big.
E_INVALIDARG index is less than one.
E_POINTER iEQPreset is NULL.
E_FAIL An unexpected error occurred.

HRESULT IITEQPresetCollection::ItemByName (  [in] BSTR  name,
[out, retval] IITEQPreset **  iEQPreset
) 
 

Returns an IITEQPreset object with the specified name.

Parameters:
name 1-based index of IITEQPreset to retrieve.
iEQPreset Returns an IITEQPreset object with the specified name.
Return values:
S_OK The operation was successful.
S_FALSE An EQ preset with the specified name could not be found.
E_POINTER name or iEQPreset is NULL.
E_INVALIDARG name is empty.
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