Share via


PHSetActiveVolume (Windows Embedded CE 6.0)

1/6/2010

This function sets 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

HRESULT  PHSetActiveVolume (
    PHActiveVolumeMode VolumeMode
);

Parameters

  • VolumeMode
    [in] A PHActiveVolumeMode enumeration value that specifies which volume mode to set.

Return Value

The function returns an HRESULT indicating if the call succeeded or failed. The following table shows additional possible return values.

Value Description

S_FALSE

Failure.

S_OK

Success.

E_INVALIDARG

Invalid request. The volume mode requested is not in the range of acceptable 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