Share via


TSPI_phoneGetRing (Windows Embedded CE 6.0)

1/6/2010

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

Syntax

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

Parameters

  • hdPhone
    Handle to the phone whose ring mode is to be queried.
  • lpdwRingMode
    Ringing pattern with which the phone is ringing. Zero indicates that the phone is not ringing.
  • lpdwVolume
    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 Value

Returns zero if the function succeeds, or an error number if an error occurs. The following table shows the return values for this method.

Value Description

PHONEERR_INVALPHONEHANDLE

The handle to the phone is invalid.

PHONEERR_RESOURCEUNAVAIL

The resource is unavailable.

PHONEERR_INVALPHONESTATE

The phone state is invalid.

PHONEERR_OPERATIONFAILED

The operation failed.

PHONEERR_NOMEM

Not enough memory is available.

PHONEERR_OPERATIONUNAVAIL

The operation is unavailable.

Remarks

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

Requirements

Header tapicomn.h
Library coredll.lib
Windows Embedded CE Windows CE 3.0 and later

See Also

Reference

TSPI Phone Device Functions
TSPI_phoneGetDevCaps
TSPI_phoneSetRing