Skip to content

Latest commit

 

History

History
94 lines (71 loc) · 4.22 KB

nf-tspi-tspi_phoneconfigdialog.md

File metadata and controls

94 lines (71 loc) · 4.22 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:tspi.TSPI_phoneConfigDialog
TSPI_phoneConfigDialog function (tspi.h)
The TSPI_phoneConfigDialog function is obsolete. TAPI version 1.4 or earlier service providers can implement this TSPI function. TAPI version 2.0 or later TSPs implement TUISPI_phoneConfigDialog.
TSPI_phoneConfigDialog
TSPI_phoneConfigDialog function [TAPI 2.2]
_tspi_tspi_phoneconfigdialog
tspi.tspi_phoneconfigdialog
tspi/TSPI_phoneConfigDialog
tspi\tspi_phoneconfigdialog.htm
tapi3
cce9460c-0914-4f02-a6a4-efb7f43ed22a
12/05/2018
TSPI_phoneConfigDialog, TSPI_phoneConfigDialog function [TAPI 2.2], _tspi_tspi_phoneconfigdialog, tspi.tspi_phoneconfigdialog, tspi/TSPI_phoneConfigDialog
tspi.h
Windows
Windows
19H1
TSPI_phoneConfigDialog
tspi/TSPI_phoneConfigDialog
c++
APIRef
kbSyntax
UserDefined
Tspi.h
TSPI_phoneConfigDialog

TSPI_phoneConfigDialog function

-description

The TSPI_phoneConfigDialog function is obsolete. TAPI version 1.4 or earlier service providers can implement this TSPI function. TAPI version 2.0 or later TSPs implement TUISPI_phoneConfigDialog.

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.

-parameters

-param dwDeviceID

The phone device to be configured.

-param hwndOwner

A handle to a parent window in which the dialog box window is to be placed.

-param lpszDeviceClass

A 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.

-returns

Returns zero if the function succeeds, or an error number if an error occurs. Possible return values are as follows:

PHONEERR_BADDEVICEID, PHONEERR_NOMEM, PHONEERR_INUSE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPARAM, PHONEERR_OPERATIONUNAVAIL, PHONEERR_INVALDEVICECLASS, PHONEERR_RESOURCEUNAVAIL.

-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 TSPI_phoneGetID. For example, if the phone supports the Comm API, passing comm/datamodem as lpszDeviceClass causes the provider to display the parameters related specifically to Comm (or, at least, to start at the corresponding point in a multilevel configuration dialog box chain, so that the user doesn't have to search to find the desired parameters). The szDeviceClass parameter should be "tapi/phone", "", or NULL to cause the provider to display the highest level configuration for the phone.

The procedure must update the [Windows Telephony] section in the Win.ini file and broadcast the WM_WININICHANGE message if it makes any changes to Telephon.ini that affect the contents of structures visible to applications (such as PHONECAPS), or if phone devices are created or removed.

-see-also

PHONECAPS

TSPI_phoneGetID