TSPI_phoneGetRing

The TSPI_phoneGetRing function enables an application to query the specified open phone device as to its current ring mode.

LONG TSPIAPI TSPI_phoneGetRing(
HDRVPHONE hdPhone,     
LPDWORD lpdwRingMode,  
LPDWORD lpdwVolume );

Parameters

  • hdPhone
    The handle to the phone whose ring mode is to be queried.
  • lpdwRingMode
    The ringing pattern with which the phone is ringing. Zero indicates that the phone is not ringing.
  • lpdwVolume
    The volume level with which the phone is ringing. This is a number in the range from 0x00000000 (silence) through 0x0000FFFF (maximum volume). The actual granularity and quantization of volume settings in this range are service-provider specific.

Return Values

Returns zero if the function succeeds, or an error number if an error occurs. Possible return values are as follows:

PHONEERR_INVALPHONEHANDLE, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED, PHONEERR_NOMEM, PHONEERR_OPERATIONUNAVAIL.

Remarks

The service provider defines the actual audible ringing patterns corresponding to each of phone's ring modes.

Requirements

Runs On Versions Defined in Include Link to
Windows CE OS 3.0 and later Tapicomn.h   Coredll.lib

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.

See Also

TSPI_phoneGetDevCaps, TSPI_phoneSetRing

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.