ITLegacyAddressMediaControl2::ConfigDialogEdit method (tapi3if.h)

The ConfigDialogEdit method causes the provider of the specified line device to display a dialog box to allow the user to configure parameters related to the line device. The configuration data is passed in and out of this method by the application. (The data is the same as that retrieved by the ITLegacyAddressMediaControl::GetDevConfig method and set by the ITLegacyAddressMediaControl::SetDevConfig method.)

Syntax

HRESULT ConfigDialogEdit(
  [in]  HWND  hwndOwner,
  [in]  BSTR  pDeviceClass,
  [in]  DWORD dwSizeIn,
  [in]  BYTE  *pDeviceConfigIn,
  [out] DWORD *pdwSizeOut,
  [out] BYTE  **ppDeviceConfigOut
);

Parameters

[in] hwndOwner

A handle to a window to which the dialog box is to be attached. Can be NULL to indicate that a window created by the method should have no owner window.

[in] pDeviceClass

Pointer to a BSTR that specifies 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.

[in] dwSizeIn

Pointer to the size of the configuration data pointed to by the pDeviceConfigIn parameter.

[in] pDeviceConfigIn

Pointer to an array of bytes containing device configuration data to edit.

[out] pdwSizeOut

Pointer to the size of the configuration data pointed to by the ppDeviceConfigOut parameter.

[out] ppDeviceConfigOut

Pointer to an array of bytes containing edited device configuration data.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method translates to a TAPI 2.x lineConfigDialogEdit call. The ITLegacyAddressMediaControl2::ConfigDialog method translates to a lineConfigDialog call. These methods differ in their source of parameters to edit and the result of the editing on an active connection. For a discussion about these differences, see lineConfigDialogEdit.

Requirements

Requirement Value
Target Platform Windows
Header tapi3if.h
Library Uuid.lib
DLL Tapi3.dll

See also

ITLegacyAddressMediaControl2

ITLegacyAddressMediaControl2::ConfigDialog