phoneConfigDialog

  • Article

This function causes the provider of the specified phone device to display a modal dialog box (attached to the application's hwndOwner parameter) that allows the user to configure parameters related to the phone device specified by the dwDeviceID parameter.

LONG WINAPI phoneConfigDialog(
  DWORD dwDeviceID,
  HWND hwndOwner,
  LPCSTR lpszDeviceClass 
);

Parameters

  • dwDeviceID
    Phone device to be configured.
  • hwndOwner
    Handle to a window to which the dialog box is to be attached. Can be a NULL value to indicate that any window created during the function should have no owner window.
  • lpszDeviceClass
    Pointer to a null-terminated string that identifies a device class name. This device class allows the application to select a specific subscreen of configuration information applicable to that device class. This parameter is optional and can be left NULL or empty, in which case the highest-level configuration is selected.

Return Values

Returns zero if the request succeeds or a negative error number if an error occurs. The following table shows the return values for this function.

Value Description
PHONEERR_BADDEVICEID The device identifier is incorrect.
PHONEERR_NOMEM Not enough memory is available.
PHONEERR_INUSE The phone device 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 resources are unavailable.
PHONEERR_INVALPOINTER The pointer is invalid.
PHONEERR_UNINITIALIZED A parameter is uninitialized.
PHONEERR_NODEVICE The device was not found.

Remarks

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 phoneGetID. For example, if the phone supports the wave API, passing "wave/in" as lpszDeviceClass would cause the provider to display the parameters related specifically to wave (or at least to start at the corresponding point in a multilevel configuration dialog box chain, eliminating the need to search for relevant parameters).

The lpszDeviceClass parameter should be "tapi/phone", "", or NULL to cause the provider to display the highest level configuration for the phone.

Note   This function is for TAPI version 2.0 and later.

Requirements

OS Versions: Windows CE 3.0 and later.
Header: Tapi.h.
Link Library: Coredll.lib.

See Also

phoneGetID

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.