Share via


VibrateGetDeviceCaps

4/8/2010

This function gets the current device vibration capabilities.

Note

This API is not supported by Windows Mobile Professional.

Syntax

int VibrateGetDeviceCaps (
  VIBRATEDEVICECAPS vdc
);

Parameters

  • vdc
    [in] The capability the caller is interested in, determined by the VIBRATEDEVICECAPS enumeration.

Return Value

This function returns the number of vibration steps (a number from 0 to 7) that the device hardware supports for the requested vibration capability.

Value Description

0

The device is incapable of providing the requested vibration functionality.

1

The device is capable of providing one level of vibration functionality (vibration can only be turned on or off).

2-7

Each of these values maps to the vibration functionality that is specific to the device to be vibrated.

Remarks

Each VIBRATENOTEstructure can be constructed with the assumption that the device can support all eight levels of vibration functionality. When the vibration song is played, the Vibrate function will map the level of vibration specified in VIBRATENOTE to one of the supported vibration levels on the device.

Requirements

Header vibrate.h
Library aygshell.lib
Windows Mobile Smartphone 2002 and later

See Also

Reference

Vibrate
VIBRATEDEVICECAPS
VIBRATENOTE
VibrateStop