Share via


PHGetActiveVolume (Windows Embedded CE 6.0)

1/6/2010

This function retrieves the active volume mode. The active volume mode represents the system speaker which is currently in use. Whenever the active volume mode changes, the system volume will be reset to reflect the desired value as it was last set by PHSetVolume for that particular mode.

Syntax

PHActiveVolumeMode  PHGetActiveVolume ( void );

Parameters

None.

Return Value

The function returns either the current active volume mode or zero, depending on whether the call succeeded or failed. The call may have failed in opening the registry key for the requested setting or the retrieved value was invalid and outside the range of acceptable PHActiveVolumeMode enumeration values.

Remarks

Note

This documentation applies to functionality implemented in sample code for PhCommon. For more information, see PhCommon Reference.

Requirements

Header settingsapi.hpp
Library PhCommon.dll
Windows Embedded CE Windows Embedded CE 6.0 and later

See Also

Reference

PhCommon Settings APIs
PhCommon Reference
PHActiveVolumeMode