Share via


phoneGetRing (Compact 2013)

3/26/2014

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

Syntax

LONG WINAPI phoneGetRing(
  HPHONE hPhone, 
  LPDWORD lpdwRingMode, 
  LPDWORD lpdwVolume
);

Parameters

  • hPhone
    Handle to the open phone device.
  • 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 0x00000000 (silence) to 0x0000FFFF (maximum volume). The actual granularity and quantization of volume settings in this range are service provider-specific.

Return Value

Zero indicates success. A negative error number indicates that an error occurred. The following table shows the return values for this function.

Value

Description

PHONEERR_INVALPHONEHANDLE

The phone handle is invalid.

PHONEERR_INVALPHONESTATE

The phone state is invalid.

PHONEERR_INVALPOINTER

The pointer is invalid.

PHONEERR_OPERATIONUNAVAIL

The operation is unavailable.

PHONEERR_NOMEM

Not enough memory is available.

PHONEERR_RESOURCEUNAVAIL

The resource is unavailable.

PHONEERR_OPERATIONFAILED

The operation failed.

PHONEERR_UNINITIALIZED

The parameter is uninitialized.

Remarks

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

Requirements

Header

tapi.h

Library

TAPI32.dll

See Also

Reference

TAPI Phone Device Functions