TSPI_lineGetIcon-Funktion (tspi.h)
Die TSPI_lineGetIcon-Funktion ruft ein gerätespezifisches Symbol für die Dienstlinie ab, das dem Benutzer angezeigt werden soll.
Syntax
LONG TSPIAPI TSPI_lineGetIcon(
DWORD dwDeviceID,
LPCWSTR lpszDeviceClass,
LPHICON lphIcon
);
Parameter
dwDeviceID
Das Zeilengerät, dessen Symbol angefordert wird.
lpszDeviceClass
Ein Zeiger auf eine Unicode-Zeichenfolge mit Null-Beendigung, die einen Geräteklassennamen identifiziert. Mit dieser Geräteklasse kann der Aufrufer ein für diese Geräteklasse spezifisches Symbol auswählen. Dieser Parameter ist optional und kann NULL belassen werden. In diesem Fall wird das Symbol der höchsten Ebene ausgewählt, das dem Zeilengerät zugeordnet ist, und nicht ein angegebenes Medienstreamgerät.
Zulässige Zeichenfolgen sind identisch mit TSPI_lineGetID. Wenn die Zeile beispielsweise die Comm-API unterstützt, bewirkt die Übergabe von comm/datamodem als lpszDeviceClass , dass der Anbieter ein Symbol zurückgibt, das sich speziell auf die Comm-Gerätefunktionen des Dienstanbieters bezieht.
lphIcon
Ein Zeiger auf einen Speicherspeicherort, an dem das Handle auf das Symbol zurückgegeben wird.
Rückgabewert
Gibt null zurück, wenn die Funktion erfolgreich ist, oder eine Fehlernummer, wenn ein Fehler auftritt. Mögliche Rückgabewerte sind wie folgt:
LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_RESOURCEUNAVAIL, LINEERR_OPERATIONUNAVAIL.
Hinweise
Der Anbieter sollte ein Handle (im DWORD , auf das von lphIcon verwiesen wird) an eine Symbolressource zurückgeben (abgerufen aus dem
LoadIcon-Funktion ), die der angegebenen Zeile zugeordnet ist.
Ein Anbieter unterstützt möglicherweise viele Symbole (ausgewählt durch lpszDeviceClass und/oder Zeilennummer), ein einzelnes Symbol (z. B. für den Hersteller, das für alle TSPI_lineGetIcon Anforderungen zurückgegeben wird, unabhängig von der ausgewählten lpszDeviceClass ), oder keine Symbole. In diesem Fall wird das DWORD , auf das von lphIcon verwiesen wird, auf NULL festgelegt. TAPI untersucht das vom Anbieter zurückgegebene Handle, und wenn der Anbieter NULL zurückgibt, ersetzt TAPI ein generisches Telefoniesymbol (das generische "Zeilensymbol").
Anforderungen
| Zielplattform | Windows |
| Kopfzeile | tspi.h |