phoneGetStatus (Compact 2013)
3/26/2014
This function enables an application to query the specified open phone device for its overall status.
Syntax
LONG WINAPI phoneGetStatus(
HPHONE hPhone,
LPPHONESTATUS lpPhoneStatus
);
Parameters
- hPhone
Handle to the open phone device to be queried.
- lpPhoneStatus
Pointer to a variably sized data structure of type PHONESTATUS, which is loaded with the returned information about the phone's status.
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_INVALPOINTER |
The pointer is invalid. |
PHONEERR_OPERATIONFAILED |
The operation failed. |
PHONEERR_OPERATIONUNAVAIL |
The operation is unavailable. |
PHONEERR_NOMEM |
Not enough memory is available. |
PHONEERR_RESOURCEUNAVAIL |
The resource is unavailable. |
PHONEERR_STRUCTURETOOSMALL |
The structure is too small. |
PHONEERR_UNINITIALIZED |
The parameter is uninitialized. |
Remarks
An application can use this function to determine the current state of an open phone device. The status information describes information about the phone device's hookswitch devices, ringer, volume, display, and lamps.
Requirements
Header |
tapi.h |
Library |
TAPI32.dll |