TSPI_lineConfigDialogEdit-Funktion (tspi.h)
Die funktion TSPI_lineConfigDialogEdit ist veraltet. TAPI Version 1.4 oder frühere Dienstanbieter können diese TSPI-Funktion implementieren. TAPI Version 2.0 oder höher implementieren TSPs TUISPI_lineConfigDialogEdit.
Die TSPI_lineConfigDialogEdit-Funktion bewirkt, dass der Anbieter des angegebenen Leitungsgeräts ein modales Dialogfeld als untergeordnetes Fenster von hwndOwner anzeigt, damit der Benutzer Parameter im Zusammenhang mit dem Leitungsgerät konfigurieren kann.
Syntax
LONG TSPIAPI TSPI_lineConfigDialogEdit(
DWORD dwDeviceID,
HWND hwndOwner,
LPCSTR lpszDeviceClass,
LPVOID const lpDeviceConfigIn,
DWORD dwSize,
LPVARSTRING lpDeviceConfigOut
);
Parameter
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 der Konfigurationsinformationen auswählen, die für diese Geräteklasse gelten. Wenn dieser Parameter NULL ist oder auf eine leere Zeichenfolge zeigt, wird die Konfiguration der höchsten Ebene ausgewählt. Die zulässigen Zeichenfolgen sind identisch mit denen für TSPI_lineGetID.
lpDeviceConfigIn
Ein Zeiger auf die undurchsichtige Konfigurationsdatenstruktur, die von TSPI_lineGetDevConfig (oder einem vorherigen Aufruf von TSPI_lineConfigDialogEdit) im variablen Teil der VARSTRING-Struktur zurückgegeben wurde.
dwSize
Die Anzahl der Bytes in der Struktur, auf die lpDeviceConfigIn verweist. Dieser Wert wird im dwStringSize-Element in der VARSTRING-Struktur zurückgegeben, die von TSPI_lineGetDevConfig oder einem vorherigen Aufruf von TSPI_lineConfigDialogEdit zurückgegeben wurde.
lpDeviceConfigOut
Ein Zeiger auf den Speicherort des Arbeitsspeichers vom Typ VARSTRING , an dem die Gerätekonfigurationsstruktur zurückgegeben wird. Nach erfolgreichem Abschluss der Anforderung wird dieser Speicherort mit der Gerätekonfiguration ausgefü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 anzugeben, wie viel Arbeitsspeicher 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
Diese Funktion bewirkt, dass der Dienstanbieter ein modales Dialogfeld (an hwndOwner angefügt) anzeigt, damit der Benutzer Parameter konfigurieren kann, die sich auf die durch dwDeviceID angegebene Zeile beziehen.
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 denen für TSPI_lineGetID. Wenn die Zeile beispielsweise 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 am entsprechenden Punkt in einer Konfigurationsdialogfeldkette mit mehreren Ebenen beginnen, sodass der Benutzer nicht "graben" muss, um die relevanten Parameter zu finden).
Der parameter lpszDeviceClass 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 TSPI_lineConfigDialog ist die Quelle der zu bearbeitenden Parameter und das Ergebnis der Bearbeitung. In TSPI_lineConfigDialog sind die bearbeiteten Parameter diejenigen, 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) sofortige Auswirkungen auf jede aktive Verbindung; Außerdem muss die Anwendung lineGetDevConfig verwenden, um das Ergebnis von Parameteränderungen aus TSPI_lineConfigDialog abzurufen. Mit TSPI_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 TSPI_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 Aufruf oder den 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
| Anforderung | Wert |
|---|---|
| Zielplattform | Windows |
| Kopfzeile | tspi.h |