Important: |
---|
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This function retrieves details about a single control associated with an audio line.
Syntax
MMRESULT mixerGetControlDetails( HMIXEROBJ hmxobj, LPMIXERCONTROLDETAILS pmxcd, DWORD fdwDetails ); |
Parameters
- hmxobj
-
Handle to the mixer device object being queried.
- pmxcd
-
Pointer to a MIXERCONTROLDETAILSstructure, which is filled with state information about the control.
- fdwDetails
-
Flags for retrieving control details.
The following table shows the possible flags.
Flag Description MIXER_GETCONTROLDETAILSF_LISTTEXT
The paDetailsmember of the MIXERCONTROLDETAILSstructure points to one or more MIXERCONTROLDETAILS_LISTTEXTstructures to receive text labels for multiple-item controls.
An application must get all list text items for a multiple-item control at once.
This flag cannot be used with MIXERCONTROL_CONTROLTYPE_CUSTOM controls.
MIXER_GETCONTROLDETAILSF_VALUE
Current values for a control are retrieved.
The paDetailsmember of the MIXERCONTROLDETAILSstructure points to one or more details structures appropriate for the control class.
MIXER_OBJECTF_HMIXER
The hmxobjparameter is a mixer device handle returned by the mixerOpenfunction.
This flag is optional.
MIXER_OBJECTF_MIXER
The hmxobjparameter is the identifier of a mixer device in the range of zero to one less than the number of devices returned by the mixerGetNumDevsfunction.
This flag is optional.
The following flags are supported in other versions of Windows, but not in Windows Embedded CE.
Flags not supported in Windows Embedded CE MIXER_OBJECTF_AUX
MIXER_OBJECTF_HMIDIN
MIXER_OBJECTF_HMIDIOUT
MIXER_OBJECTF_HWAVEIN
MIXER_OBJECTF_HWAVEOUT
MIXER_OBJECTF_MIDIIN
MIXER_OBJECTF_MIDIOUT
MIXER_OBJECTF_WAVEHOUT
MIXER_OBJECTF_WAVEIN
Return Value
Returns MMSYSERR_NOERROR if successful or an error otherwise.
The following table shows the possible error values.
Value | Description |
---|---|
MIXERR_INVALCONTROL |
The control reference is invalid. |
MIXERR_INVALLINE |
The audio line reference is invalid. |
MMSYSERR_BADDEVICEID |
The hmxobjparameter specifies an invalid device identifier. |
MMSYSERR_INVALFLAG |
One or more flags are invalid. |
MMSYSERR_INVALHANDLE |
The hmxobjparameter specifies an invalid handle. |
MMSYSERR_INVALPARAM |
One or more parameters are invalid. |
MMSYSERR_NODRIVER |
No mixer device is available for the object specified by hmxobj. |
Remarks
All members of the MIXERCONTROLDETAILSstructure must be initialized before calling this function.
Requirements
Header | mmsystem.h |
Library | coredll.lib |
Windows Embedded CE | Windows CE 2.12 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |
Note | Version 2.12 requires DXPAK 1.0 or later |