TUISPI_providerConfig function (tspi.h)

Article
02/22/2024

The TUISPI_providerConfig function implements the UI elements that must execute in the context of the calling application. This function makes the TSPI_providerConfig function obsolete in version 2.0 and later (supported in version 1.4 and earlier).

The TUISPI_providerConfig function gathers configuration information from the user. It can use a dialog box, and this dialog box can include sub-dialog boxes associated with other APIs (such as Comm/datamodem) for the setup of specific devices.

Implementation is optional.

Syntax

LONG TSPIAPI TUISPI_providerConfig(
  TUISPIDLLCALLBACK lpfnUIDLLCallback,
  HWND              hwndOwner,
  DWORD             dwPermanentProviderID
);

Parameters

lpfnUIDLLCallback

Pointer to a function the UI DLL can call to communicate with the service provider DLL to obtain information needed to display the dialog box and to send updated configuration to the service provider.

hwndOwner

The handle of the parent window in which the function can create any dialog box windows required during the configuration.

dwPermanentProviderID

The service provider's permanent provider identifier.

Return value

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

LINEERR_OPERATIONFAILED, LINEERR_NOMEM.

Remarks

This function may be called while the service provider is in use (that is, between calls of TSPI_providerInit and TSPI_providerShutdown).

Any changes that affect the behavior visible through TSPI should take effect only when the service provider is restarted at the next TSPI_providerInit.

There is no directly corresponding function at the TAPI level. In TAPI, applications have access to the functions lineConfigDialog and phoneConfigDialog, which allow configuration of parameters of a particular line or phone once it has been installed.

Requirements

Requirement	Value
Target Platform	Windows
Header	tspi.h