IITConvertOperationStatus Interface Reference

Inheritance diagram for IITConvertOperationStatus:

List of all members.

---

Detailed Description

Represents the status of an asynchronous convert operation.

Note:

This interface is available in iTunes 4.6 and later (iTunes type library 1.1 and later).

When converting or importing a track using IiTunes::ConvertFile2(), IiTunes::ConvertFiles2(), IiTunes::ConvertTrack2() or IiTunes::ConvertTracks2(), the conversion will never complete immediately. These methods return an IITConvertOperationStatus object, which can be polled to determine when the operation is done. You can also register an _IITConvertOperationStatusEvents interface to be notified of conversion progress.

Public Member Functions
Methods
HRESULT	GetConversionStatus ([out] BSTR *trackName,[out] long *progressValue,[out] long *maxProgressValue)
	Returns status about the track currently being converted.
HRESULT	StopConversion ()
	Stops the current conversion operation.
Properties
HRESULT	TrackName ([out, retval] BSTR *trackName)
	Returns the name of the track currently being converted.
HRESULT	ProgressValue ([out, retval] long *progressValue)
	Returns the conversion progress value for the track currently being converted.
HRESULT	MaxProgressValue ([out, retval] long *maxProgressValue)
	Returns the maximum conversion progress value for the track currently being converted.

---

Member Function Documentation

HRESULT IITConvertOperationStatus::GetConversionStatus (  [out] BSTR *  trackName, [out] long *  progressValue, [out] long *  maxProgressValue )

Returns status about the track currently being converted. This method is not usable from scripting clients, since it returns multiple output parameters. Scripting clients must use the IITConvertOperationStatus::TrackName(), IITConvertOperationStatus::ProgressValue(), and IITConvertOperationStatus::MaxProgressValue() properties instead. Parameters: trackName  Returns the name of the track currently being converted. May return NULL if no track is currently being converted. progressValue  Returns the conversion progress value for the track currently being converted. This number will always be in the range 0 through maxProgressValue. maxProgressValue  Returns the maximum conversion progress value for the track currently being converted. The conversion of the current track is complete when progressValue reaches maxProgressValue. Note that maxProgressValue will be different for each track being converted. Return values: S_OK  The operation was successful. E_POINTER  trackName, progressValue, or maxProgressValue is NULL. E_FAIL  An unexpected error occurred.

HRESULT IITConvertOperationStatus::MaxProgressValue (  [out, retval] long *  maxProgressValue  )

Returns the maximum conversion progress value for the track currently being converted. Parameters: maxProgressValue  Returns the maximum conversion progress value for the track currently being converted. The conversion of the current track is complete when IITConvertOperationStatus::ProgressValue() reaches maxProgressValue. Note that maxProgressValue will be different for each track being converted. Return values: S_OK  The operation was successful. E_POINTER  maxProgressValue is NULL. E_FAIL  An unexpected error occurred.

HRESULT IITConvertOperationStatus::ProgressValue (  [out, retval] long *  progressValue  )

Returns the conversion progress value for the track currently being converted. Parameters: progressValue  Returns the conversion progress value for the track currently being converted. This number will always be in the range 0 through IITConvertOperationStatus::MaxProgressValue(). Return values: S_OK  The operation was successful. E_POINTER  progressValue is NULL. E_FAIL  An unexpected error occurred.

HRESULT IITConvertOperationStatus::StopConversion (   )

Stops the current conversion operation. Return values: S_OK  The operation was successful. E_FAIL  The conversion could not be stopped, or an unexpected error occurred.

HRESULT IITConvertOperationStatus::TrackName (  [out, retval] BSTR *  trackName  )

Returns the name of the track currently being converted. Parameters: trackName  Returns the name of the track currently being converted. May return NULL if no track is currently being converted. Return values: S_OK  The operation was successful. E_POINTER  trackName is NULL. E_FAIL  An unexpected error occurred.

---