TSPI_lineConfigDialogEdit

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function causes the provider of the specified line device to display a modal dialog box as a child window of hwndOwner to allow the user to configure parameters related to the line device.

Syntax

LONG TSPIAPI TSPI_lineConfigDialogEdit(
  DWORD dwDeviceID, 
  HWND hwndOwner, 
  LPCWSTR lpszDeviceClass, 
  LPVOID const lpDeviceConfigIn, 
  DWORD dwSize, 
  LPVARSTRING lpDeviceConfigOut 
);

Parameters

• dwDeviceID
  Line device to be configured.

• hwndOwner
  Handle to a window to which the dialog box is to be attached.

• 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 points to an empty string, the highest level configuration is selected. The permitted strings are the same as for the TSPI_lineGetID function.

• lpDeviceConfigIn
  Pointer to the opaque configuration data structure that was returned by the TSPI_lineGetDevConfig function (or a previous invocation of TSPI_lineConfigDialogEdit) in the variable portion of the VARSTRING structure.

• dwSize
  Number of bytes in the structure pointed to by the lpDeviceConfigIn parameter. This value is returned in the dwStringSize member in the VARSTRING structure returned by TSPI_lineGetDevConfig or a previous invocation of TSPI_lineConfigDialogEdit.

• lpDeviceConfigOut
  Pointer to the memory location of type VARSTRING where the device configuration structure is returned. Upon successful completion of the request, this location is filled with the device configuration. The dwStringFormat member in the VARSTRING structure is set to STRINGFORMAT_BINARY. Prior to calling lineGetDevConfig (or a future invocation of lineConfigDialogEdit), the application should set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.

Return Value

Returns zero if the request succeeds or an error number if an error occurs.

Remarks

This function causes the service provider to display a modal dialog box (attached to hwndOwner) to allow the user to configure parameters related to the line specified by dwDeviceID.

The lpszDeviceClass parameter selects 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_lineGetID.

The lpszDeviceClass parameter is "tapi/line" , "", or NULL to cause the provider to display the highest level configuration for the line.

For backward compatibility, this function is not exported by older service providers. TAPI detects this condition and reports LINEERR_OPERATIONUNAVAIL if an application attempts to call this function on an older provider.

Requirements

See Also

Reference

TSPI_lineGetDevConfig
TSPI_lineGetID
TSPI_lineSetDevConfig