IWDFDeviceInitialize::RetrieveDeviceInstanceId-Methode (wudfddi.h)
[Warnung: UMDF 2 ist die neueste Version von UMDF und ersetzt UMDF 1. Alle neuen UMDF-Treiber sollten mit UMDF 2 geschrieben werden. UMDF 1 werden keine neuen Features hinzugefügt, und die Unterstützung für UMDF 1 für neuere Versionen von Windows 10 ist eingeschränkt. Universelle Windows-Treiber müssen UMDF 2 verwenden. Weitere Informationen finden Sie unter Erste Schritte mit UMDF.]
Die RetrieveDeviceInstanceId-Methode ruft den Bezeichner eines instance eines Geräts ab.
Syntax
HRESULT RetrieveDeviceInstanceId(
[out, optional] PWSTR Buffer,
[in, out] DWORD *pdwSizeInChars
);
Parameter
[out, optional] Buffer
Ein Zeiger auf einen Puffer, der eine NULL-beendete Zeichenfolge empfängt, die den Bezeichner einer instance eines Geräts darstellt, wenn der angegebene Puffer nicht NULL ist und RetrieveDeviceInstanceId erfolgreich ist.
[in, out] pdwSizeInChars
Ein Zeiger auf eine Variable, die die Anzahl von Zeichen, einschließlich des NULL-Zeichens , in der Zeichenfolge empfängt, auf die Buffer zeigt.
Wenn BufferNULL ist, ist der vom Treiber bereitgestellte Wert 0. Das Framework gibt dann die Größe in Zeichen zurück, die für die Bezeichnerzeichenfolge erforderlich ist.
Wenn Puffer nicht NULL ist, gibt das Framework die Größe der Bezeichnerzeichenfolge in Zeichen zurück.
Rückgabewert
RetrieveDeviceInstanceId gibt S_OK für die folgenden Szenarien zurück:
- Der Puffer, auf den der Buffer-Parameter verweist, war nicht NULL und groß genug, um die Bezeichnerzeichenfolge zu enthalten, einschließlich des NULL-Zeichens , und das Framework hat die Zeichenfolge erfolgreich in den angegebenen Puffer kopiert und die Variable festgelegt, auf die vom pdwSizeInChars-Parameter auf die Anzahl der Zeichen in der Zeichenfolge verwiesen wurde.
- Der Puffer bei Buffer war NULL, der Treiber hat die Variable bei pdwSizeInChars auf 0 festgelegt, und das Framework legt die Variable auf pdwSizeInChars auf die Anzahl der Zeichen fest, die für die Zeichenfolge erforderlich sind.
RetrieveDeviceInstanceId kann auch andere HRESULT-Werte zurückgeben.
Anforderungen
| Anforderung | Wert |
|---|---|
| Ende des Supports | In UMDF 2.0 und höher nicht verfügbar. |
| Zielplattform | Desktop |
| UMDF-Mindestversion | 1.5 |
| Kopfzeile | wudfddi.h (include Wudfddi.h) |
| DLL | WUDFx.dll |