TUISPI_lineConfigDialogEdit-Funktion (tspi.h)

Die TUISPI_lineConfigDialogEdit-Funktion bewirkt, dass der Anbieter des angegebenen Zeilengeräts ein modales Dialogfeld als untergeordnetes Fenster von hwndOwner anzeigt, damit der Benutzer Parameter im Zusammenhang mit dem Zeilengerät konfigurieren kann. Diese Funktion macht die TSPI_lineConfigDialogEdit Funktion in Version 2.0 und höher veraltet (unterstützt in Version 1.4 und früher).

Die Implementierung ist optional.

Syntax

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

Parameter

lpfnUIDLLCallback

Zeiger auf eine Funktion, die die UI-DLL aufrufen kann, um mit der Dienstanbieter-DLL zu kommunizieren, um Informationen abzurufen, die zum Anzeigen des Dialogfelds erforderlich sind.

dwDeviceID

Das zu konfigurierende Leitungsgerät.

hwndOwner

Ein Handle an ein Fenster, an das das Dialogfeld angefügt werden soll.

lpszDeviceClass

Ein Zeiger auf eine Unicode-Zeichenfolge mit Null-Beendigung, die einen Geräteklassennamen identifiziert. Mit dieser Geräteklasse kann der Aufrufer einen bestimmten Unterbildschirm mit Konfigurationsinformationen auswählen, die für diese Geräteklasse gelten. Wenn dieser Parameter NULL ist oder auf eine leere Zeichenfolge verweist, wird die Konfiguration der höchsten Ebene ausgewählt. Die zulässigen Zeichenfolgen sind identisch mit TSPI_lineGetID.

lpDeviceConfigIn

Ein Zeiger auf die undurchsichtige Konfigurationsdatenstruktur, die von TSPI_lineGetDevConfig (oder einem vorherigen Aufruf von TUISPI_lineConfigDialogEdit) im Variablenteil der VARSTRING-Struktur zurückgegeben wurde.

dwSize

Die Anzahl der Bytes in der Struktur, auf die von lpDeviceConfigIn verwiesen wird. Dieser Wert wird im dwStringSize-Member in der VARSTRING-Struktur zurückgegeben, die von TSPI_lineGetDevConfig oder einem vorherigen Aufruf von TUISPI_lineConfigDialogEdit zurückgegeben wird.

Hinweis Wenn die Größenparameter in der Struktur nicht korrekt sind, besteht die Möglichkeit, dass Daten überschrieben werden. Weitere Informationen zum Festlegen von Strukturgrößen finden Sie im Thema Speicherzuordnung .
 

lpDeviceConfigOut

Ein Zeiger auf den Speicherspeicherort des Typs VARSTRING , an dem die Gerätekonfigurationsstruktur zurückgegeben wird. Nach erfolgreichem Abschluss der Anforderung wird dieser Speicherort mit der Gerätekonfiguration gefüllt. Das dwStringFormat-Element in der VARSTRING-Struktur ist auf STRINGFORMAT_BINARY festgelegt. Vor dem Aufrufen von lineGetDevConfig (oder einem zukünftigen Aufruf von lineConfigDialogEdit) sollte die Anwendung den dwTotalSize-Member dieser Struktur festlegen, um die Menge an Arbeitsspeicher anzugeben, der TAPI zum Zurückgeben von Informationen zur Verfügung steht.

Rückgabewert

Gibt null zurück, wenn die Anforderung erfolgreich ist, oder eine Fehlernummer, wenn ein Fehler auftritt. Mögliche Rückgabewerte sind:

LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONFAILED, LINEERR_INVALPARAM, LINEERR_RESOURCEUNAVAIL, LINEERR_NODRIVER, LINEERR_OPERATIONUNAVAIL, LINEERR_NOMEM.

Hinweise

Der parameter lpszDeviceClass wählt einen bestimmten Unterbildschirm der Konfigurationsinformationen aus, die für die Geräteklasse gelten, an der der Benutzer interessiert ist. Die zulässigen Zeichenfolgen sind identisch mit TSPI_lineGetID. Wenn die Zeile z. B. die Comm-API unterstützt, bewirkt die Übergabe von comm/datamodem als lpszDeviceClass , dass der Anbieter die Parameter anzeigt, die sich speziell auf Comm beziehen (oder zumindest an dem entsprechenden Punkt in einer Mehrebenenkonfigurationsdialogfeldkette starten, sodass der Benutzer nicht "graben" muss, um die relevanten Parameter zu finden).

Der lpszDeviceClass-Parameter ist "tapi/line", "" oder NULL , damit der Anbieter die Konfiguration der höchsten Ebene für die Zeile anzeigt.

Der Unterschied zwischen dieser Funktion und TUISPI_lineConfigDialog ist die Quelle der zu bearbeitenden Parameter und das Ergebnis der Bearbeitung. In TUISPI_lineConfigDialog werden die parameter bearbeitet, die derzeit auf dem Gerät verwendet werden (oder für die Verwendung beim nächsten Aufruf festgelegt sind), und alle vorgenommenen Änderungen haben (soweit möglich) unmittelbare Auswirkungen auf jede aktive Verbindung; Außerdem muss die Anwendung lineGetDevConfig verwenden, um das Ergebnis von Parameteränderungen aus TUISPI_lineConfigDialog abzurufen. Bei TUISPI_lineConfigDialogEdit werden die zu bearbeitenden Parameter von der Anwendung übergeben, und die Ergebnisse werden an die Anwendung zurückgegeben, ohne dass sich dies auf aktive Verbindungen auswirkt. die Ergebnisse der Bearbeitung werden mit dieser Funktion zurückgegeben, und die Anwendung muss lineGetDevConfig nicht aufrufen. Daher ermöglicht TUISPI_lineConfigDialogEdit einer Anwendung, dem Benutzer die Möglichkeit zu bieten, Parameter für zukünftige Aufrufe einzurichten, ohne auswirkungen auf einen aktiven Aufruf zu haben. Die Ausgabe dieser Funktion kann jedoch an TSPI_lineSetDevConfig übergeben werden, um den aktuellen oder nächsten Aufruf zu beeinflussen.

Aus Gründen der Abwärtskompatibilität wird diese Funktion nicht von älteren Dienstanbietern exportiert. TAPI erkennt diese Bedingung und meldet LINEERR_OPERATIONUNAVAIL, wenn eine Anwendung versucht, diese Funktion bei einem älteren Anbieter aufzurufen.

Anforderungen

   
Zielplattform Windows
Kopfzeile tspi.h

Weitere Informationen

TSPI_lineGetDevConfig

TSPI_lineGetID

TSPI_lineSetDevConfig

TUISPI_lineConfigDialog

VARSTRING