TSPI_phoneConfigDialog (Compact 2013)
3/26/2014
This function is obsolete. TAPI 1.4 or earlier service providers can implement this TSPI function.
The TSPI_phoneConfigDialog function causes the provider of the specified phone device to display a modal dialog box as a child window of hwndOwner to allow the user to configure parameters related to the phone device.
Syntax
LONG TSPIAPI TSPI_phoneConfigDialog(
DWORD dwDeviceID,
HWND hwndOwner,
LPCWSTR lpszDeviceClass
);
Parameters
- dwDeviceID
Phone device to be configured.
- hwndOwner
Handle to a parent window in which the dialog box window is to be placed.
- lpszDeviceClass
Pointer to a null-terminated Unicode string that identifies a device class name. This device class allows the caller to select a specific subscreen of configuration information applicable to that device class. If this parameter is NULL or an empty string, the highest level configuration dialog box is selected.
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_BADDEVICEID |
The device id is incorrect. |
PHONEERR_NOMEM |
Not enough memory is available. |
PHONEERR_INUSE |
The phone is in use. |
PHONEERR_OPERATIONFAILED |
The operation failed. |
PHONEERR_INVALPARAM |
The parameter is invalid. |
PHONEERR_OPERATIONUNAVAIL |
The operation is unavailable. |
PHONEERR_INVALDEVICECLASS |
The device class is invalid. |
PHONEERR_RESOURCEUNAVAIL |
The resource is unavailable. |
Remarks
TSPI_phoneConfigDialog causes the service provider to display a modal dialog box as a child window of hWndOwner to allow the user to configure parameters related to the phone specified by dwDeviceID. The lpszDeviceClass parameter allows the application to select a specific subscreen of configuration information applicable to the device class in which the user is interested. The permitted strings are the same as for the TSPI_phoneGetID function. The szDeviceClass parameter should be "tapi/phone", "", or NULL to cause the provider to display the highest level configuration for the phone.
Requirements
Header |
tspi.h |
Library |
CellTSP.dll |