lineConfigDialog
The lineConfigDialog
function causes the provider of the specified line device to display a dialog
(attached to hwndOwner of the application) to allow the user to
configure parameters related to the line device.
LONG lineConfigDialog(
DWORD dwDeviceID, |
|
HWND hwndOwner, |
|
LPCSTR lpszDeviceClass |
|
); |
|
Parameters
dwDeviceID
The line
device to be configured.
hwndOwner
A handle to a
window to which the dialog is to be attached. Can be NULL to indicate that any
window created during the function should have no owner window.
lpszDeviceClass
A 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 is successful or a negative error number if an error has
occurred. Possible return values are:
LINEERR_BADDEVICEID,
LINEERR_NOMEM, LINEERR_INUSE, LINEERR_OPERATIONFAILED, LINEERR_INVALDEVICECLASS,
LINEERR_RESOURCEUNAVAIL, LINEERR_INVALPARAM, LINEERR_UNINITIALIZED,
LINEERR_INVALPOINTER, LINEERR_OPERATIONUNAVAIL, LINEERR_NODEVICE.
Remarks
The lineConfigDialog
function causes the service provider to display a modal dialog (attached to hwndOwner
of the application) to allow the user to configure parameters related to the
line 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 lineGetID. For example, if the
line supports the Comm API, passing "COMM" as lpszDeviceClass
causes the provider to display the parameters related specifically to Comm (or,
at least, start at the corresponding point in a multilevel configuration dialog
chain, so the user doesn't have to "dig" to find the parameters of
interest).
The lpszDeviceClass
parameter would be "tapi/line" , "", or NULL to cause the
provider to display the highest level configuration for the line.
See Also