lineGetIcon-Funktion (tapi.h)

Die lineGetIcon-Funktion ermöglicht es einer Anwendung, ein gerätespezifisches (oder anbieterspezifisches) Dienstleitungssymbol zur Anzeige für den Benutzer abzurufen.

Syntax

LONG lineGetIcon(
  DWORD   dwDeviceID,
  LPCSTR  lpszDeviceClass,
  LPHICON lphIcon
);

Parameter

dwDeviceID

Bezeichner des Leitungsgeräts, dessen Symbol angefordert wird.

lpszDeviceClass

Zeiger auf eine NULL-endende Zeichenfolge, die einen Geräteklassennamen identifiziert. Mit dieser Geräteklasse kann die Anwendung ein bestimmtes Untersymbol auswählen, das für diese Geräteklasse gilt. Dieser Parameter ist optional und kann NULL oder leer bleiben. In diesem Fall wird das Symbol der höchsten Ebene ausgewählt, das dem Leitungsgerät und nicht einem angegebenen Medienstreamgerät zugeordnet ist.

lphIcon

Zeiger auf einen Speicherort, an dem das Handle zum Symbol zurückgegeben wird.

Rückgabewert

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

LINEERR_BADDEVICEID, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALDEVICECLASS, LINEERR_UNINITIALIZED, LINEERR_NOMEM, LINEERR_NODEVICE.

Hinweise

Die lineGetIcon-Funktion bewirkt, dass der Anbieter ein Handle (in lphIcon) an eine Symbolressource (abgerufen von LoadIcon) zurückgibt, die der angegebenen Zeile zugeordnet ist. Das Symbolhandle gilt für eine Ressource, die dem Anbieter zugeordnet ist. Die Anwendung muss CopyIcon verwenden, wenn sie nach dem Entladen des Anbieters auf das Symbol verweisen möchte. Dies ist unwahrscheinlich, solange die Zeile der Anwendung geöffnet ist.

Der Parameter lpszDeviceClass ermöglicht es dem Anbieter, unterschiedliche Symbole basierend auf dem Typ des Diensts zurückzugeben, auf den der Aufrufer verweist. Die zulässigen Zeichenfolgen sind identisch mit denen für lineGetID. Wenn die Zeile beispielsweise die Comm-API unterstützt, bewirkt die Übergabe von "COMM" als lpszDeviceClass , dass der Anbieter ein Symbol zurückgibt, das sich speziell auf die Comm-Gerätefunktionen des Dienstanbieters bezieht. Die Parameter "tapi/line", "" oder NULL können verwendet werden, um das Symbol für den Zeilendienst anzufordern.

Wenn der Anbieter bei Anwendungen, die eine frühere API-Version als 2.0 verwenden, kein Symbol zurückgibt (unabhängig davon, ob die angegebene Geräteklasse ungültig ist oder der Anbieter keine Symbole unterstützt), ersetzt TAPI ein generisches Telefonleitungsgerätesymbol. Bei Anwendungen mit API-Version 2.0 oder höher ersetzt TAPI das Standardzeilensymbol nur, wenn der lpszDeviceClass-Parameter "tapi/line", "" oder NULL lautet. Wenn die angegebene Geräteklasse ungültig ist oder der Anbieter keine Symbole für die Klasse unterstützt, gibt lineGetIcon für jede andere Geräteklasse LINEERR_INVALDEVICECLASS zurück.

Anforderungen

Weitere Informationen

Grundlegende Referenz zu Telefoniediensten

ÜBERSICHT ÜBER TAPI 2.2-Referenz

lineGetID