| Syntax | LONG TSPI_phoneGetStatus(dwRequestID, hdPhone, lpPhoneStatus) This operation enables the TAPI DLL to query the specified open phone device for its overall status. |
| 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 to be queried. | |
| LPPHONESTATUS lpPhoneStatus Specifies a far pointer to a variable sized data structure of type PHONESTATUS, which is loaded with the returned information about the phone's status. | |
| 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_INVALPOINTER The specified pointer parameter is invalid. | |
| PHONEERR_OPERATIONFAILED The specified operation failed for unspecified reasons. | |
| Comments | The TAPI DLL can use this function to determine the current state of an open phone device. The status information describes information about the phone device's hook switch devices, ringer, volume, display, and lamps of the open phone. |
| See Also | Messages: PHONE_STATE |
| Data Types: PHONESTATUS | |
| Fields: | The following table indicates which fields of the PHONESTATUS data structure are filled in by the Service Provider and which fields are filled in by the TAPI DLL. The Service Provider must preserve (i.e., must not overwrite) the values filled in by the TAPI DLL. |
| Field Name | TAPI DLL | Service Provider |
| dwTotalSize; | X | |
| dwNeededSize; | X | |
| dwUsedSize; | X | |
| dwStatusFlags; | X | |
| dwNumOwners; | X | |
| dwNumMonitors; | X | |
| dwRingMode; | X | |
| dwRingVolume; | X | |
| dwHandsetHookSwitchMode; | X | |
| dwHandsetVolume; | X | |
| dwHandsetGain; | X | |
| dwSpeakerHookSwitchMode; | X | |
| dwSpeakerVolume; | X | |
| dwSpeakerGain; | X | |
| dwHeadsetHookSwitchMode; | X | |
| dwHeadsetVolume; | X | |
| dwHeadsetGain; | X | |
| dwDisplaySize; | X | |
| dwDisplayOffset; | X | |
| dwLampModesSize; | X | |
| dwLampModesOffset; | X | |
| dwOwnerNameSize; | X | |
| dwOwnerNameOffset; | X | |
| dwDevSpecificSize; | X | |
| dwDevSpecificOffset; | X |