SetupDiLoadDeviceIcon-Funktion (setupapi.h)

Die SetupDiLoadDeviceIcon-Funktion ruft ein Symbol für ein angegebenes Gerät ab.

Syntax

WINSETUPAPI BOOL SetupDiLoadDeviceIcon(
  [in]  HDEVINFO         DeviceInfoSet,
  [in]  PSP_DEVINFO_DATA DeviceInfoData,
  [in]  UINT             cxIcon,
  [in]  UINT             cyIcon,
  [in]  DWORD            Flags,
  [out] HICON            *hIcon
);

Parameter

[in] DeviceInfoSet

Ein Handle für den Geräteinformationssatz , der das Geräteinformationselement enthält, das das Gerät darstellt, für das ein Symbol abgerufen werden soll.

[in] DeviceInfoData

Ein Zeiger auf eine SP_DEVINFO_DATA-Struktur , die das Geräteinformationselement in DeviceInfoSet angibt.

[in] cxIcon

Die Breite des abzurufenden Symbols in Pixel. Verwenden Sie den Systemmetrikindex SM_CXICON, um ein Symbol mit Standardgröße anzugeben, oder verwenden Sie den Systemmetrikindex SM_CXSMICON, um ein kleines Symbol anzugeben. Die Systemmetrikindizes werden in Winuser.h definiert, und die zugehörigen Werte können durch einen Aufruf der GetSystemMetrics-Funktion abgerufen werden. (Die GetSystemMetrics-Funktion ist im Microsoft Windows SDK dokumentiert.)

[in] cyIcon

Die Höhe des abzurufenden Symbols in Pixel. Verwenden Sie SM_CXICON, um ein Symbol mit Standardgröße anzugeben, oder verwenden Sie SM_CXSMICON, um ein kleines Symbol anzugeben.

[in] Flags

Wird nicht verwendet. Muss auf 0 (null) festgelegt werden.

[out] hIcon

Ein Zeiger auf ein Handle auf ein Symbol, das ein Handle für das Symbol empfängt, das von dieser Funktion abgerufen wird. Nachdem die Anwendung, die diese Funktion aufruft, mithilfe des Symbols abgeschlossen wurde, muss die Anwendung DestroyIcon aufrufen, um das Symbol zu löschen. (DestroyIcon ist im Microsoft Windows SDK dokumentiert.)

Rückgabewert

SetupDiLoadDeviceIcon gibt TRUE zurück, wenn die Funktion das Symbol für das angegebene Gerät abrufen kann. Andernfalls gibt die Funktion FALSE zurück, und der protokollierte Fehler kann durch einen Aufruf von GetLastError abgerufen werden.

Hinweise

SetupDiLoadDeviceIcon versucht, ein Symbol für das Gerät wie folgt abzurufen:

  • Wenn die DEVPKEY_DrvPkg_Icon Geräteeigenschaft des Geräts eine Liste von Ressourcenbezeichnerzeichenfolgen enthält, versucht die Funktion, das Symbol abzurufen, das von der ersten Ressourcenbezeichnerzeichenfolge in der Liste angegeben wird.

    Der Datentyp der Geräteeigenschaft der DEVPKEY_DrvPkg_Icon-Geräteeigenschaft ist DEVPROP_TYPE_STRING_LIST.

    Das Format einer Ressourcenbezeichnerzeichenfolge ist

    [filepath\]filename,-resourceID
    

    Hierbei gilt:

    • filepath, gefolgt vom umgekehrten Schrägstrich (\\), ist optional und gibt einen Pfad der Datei an, die das Symbol enthält.
    • FileName, gefolgt vom Komma (",") gibt den Namen der Datei an, die das Symbol enthält.
    • ResourceID, dem ein Bindestrich ("-") vorangestellt ist, gibt die Ressourcen-ID des Symbols an.
  • Wenn die Funktion kein gerätespezifisches Symbol abrufen kann, versucht sie dann, das Klassensymbol für das Gerät abzurufen. Informationen zu Klassensymbolen finden Sie unter SetupDiLoadClassIcon.
  • Wenn die Funktion das Klassensymbol für das Gerät nicht abrufen kann, versucht sie dann, das Symbol für die Setupklasse des unbekannten Geräts abzurufen, wobei das Symbol für die Setupklasse Unbekanntes Gerät das Bild eines Fragezeichens (?) enthält.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Verfügbar in Windows Vista und späteren Windows-Versionen.
Zielplattform Desktop
Kopfzeile setupapi.h (schließen Sie Setupapi.h ein)
Bibliothek Setupapi.lib
DLL Setupapi.dll

Weitere Informationen

DEVPROP_TYPE_STRING_LIST

SetupDiLoadClassIcon