Microsoft Windows CE 3.0  

WODM_GETVOLUME

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 message is used in an MMDRV_MESSAGE_PARAMSstructure passed to the WAV_IOControlfunction to request a waveform output driver to return the current volume level setting for the specified device.

Parameters

uDeviceId
Device identifier — 0, 1, 2, and so on — for the target device.
uMsg
Specifies this structure.
dwUser
Specifies a device instance identifier.
dwParam1
Pointer to a DWORDlocation to receive the volume setting.
dwParam2
Not used.

Return Values

MMSYSERR_NOERROR indicates success. Otherwise, the driver returns one of the MMSYSERR or WAVERR error values declared in the Mmsystem.h header file.

Remarks

The ACM sends this message by calling the audio driver's WAV_IOControlentry point through the DeviceIoControlfunction. Support for this message by drivers is optional. However, if the driver supports WODM_SETVOLUME, it must support this message. The following table shows which bytes in dwParam1indicate the volume settings for both stereo and monaural audio channels.

Channel Portion of dwParam1used
Left channel Low WORD
Right channel High WORD
Single channel Low WORD

A value of 0 is silence, and a value of 0xFFFF is full volume.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later      
Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.


 Last updated on Tuesday, July 13, 2004

© 2004 Microsoft Corporation. All rights reserved.