| Syntax | LONG TSPI_phoneGetRing(dwRequestID, hdPhone, lpdwRingMode, lpdwVolume) This function enables an application to query the specified open phone device as to its current ring mode. |
| Parameters | DRV_REQUESTID dwRequestID Specifies the identifier of the asynchronous request. The Service Provider returns this value if the function completes asynchronously. |
| HDRVPHONE hdPhone Specifies the Service Provider's opaque handle to the phone whose ring mode is to be queried. | |
| LPDWORD lpdwRingMode Specifies the ringing pattern with which the phone is ringing. Zero indicates that the phone is not ringing. | |
| LPDWORD lpdwVolume Specifies the volume level with which the phone is ringing. This is a number in the range 0x00000000, which is silence to 0x0000FFFF which is maximum volume. The actual granularity and quantization of volume settings in this range are service provider specific. | |
| Return Value | Returns zero if the function is successful, the (positive) dwRequestID value if the function will be completed asynchronously, or a negative error number if an error has occurred. Possible error returns are: |
| PHONEERR_INVALPHONEHANDLE The specified device handle is invalid. | |
| PHONEERR_INVALPHONESTATE The phone device is not in a valid state for the requested operation. | |
| PHONEERR_INVALPOINTER One or more of the specified pointer parameters are invalid. | |
| PHONEERR_OPERATIONUNAVAIL The specified operation is not available. | |
| PHONEERR_OPERATIONFAILED The specified operation failed for unspecified reasons. | |
| Comments | The service provider defines the actual audible ringing patterns corresponding to each of phone's ring modes. |
| See Also | Functions: TSPI_phoneGetDevCaps, TSPI_phoneSetRing Data Types: PHONECAPS |