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. Es werden keine neuen Features zu UMDF 1 hinzugefügt, und es gibt eingeschränkte Unterstützung für UMDF 1 für neuere Versionen von Windows 10. Universelle Windows-Treiber müssen UMDF 2 verwenden. Weitere Informationen finden Sie unter Erste Schritte mit UMDF-.]

Die RetrieveDeviceInstanceId Methode ruft den Bezeichner einer Instanz 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--terminated-Zeichenfolge empfängt, die den Bezeichner einer Instanz eines Geräts darstellt, wenn der angegebene Puffer nichtNULL- und RetrieveDeviceInstanceId- erfolgreich ist.

[in, out] pdwSizeInChars

Ein Zeiger auf eine Variable, die die Anzahl der Zeichen erhält, einschließlich des NULL- Zeichens, in der Zeichenfolge, auf die Buffer verweist.

Wenn BufferNULL-ist, ist der Vom Treiber bereitgestellte Wert Null. Das Framework gibt dann die Größe in Zeichen zurück, die für die Bezeichnerzeichenfolge erforderlich ist.

Wenn Buffer nichtNULL-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 nichtNULL- und groß genug, um die Bezeichnerzeichenfolge zu speichern, einschließlich des NULL- Zeichens, und das Framework hat die Zeichenfolge erfolgreich in den angegebenen Puffer kopiert und die Variable festgelegt, auf die der pdwSizeInChars Parameter auf die Anzahl der Zeichen in der Zeichenfolge verweist.
• 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 gibt HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) zurück, um anzugeben, dass der angegebene Puffer nichtNULL- ist und nicht genügend Platz zum Speichern der Bezeichnerzeichenfolge enthält. Das Framework legt die Variable bei pdwSizeInChars- auf die Anzahl der Zeichen fest, die für die Zeichenfolge erforderlich sind.

RetrieveDeviceInstanceId- können auch andere HRESULT-Werte zurückgeben.

Anforderungen

Anforderung	Wert
Ende des Supports	In UMDF 2.0 und höher nicht verfügbar.
Zielplattform-	Desktop
Mindest-UMDF-Version	1.5
Header-	wudfddi.h (include Wudfddi.h)
DLL-	WUDFx.dll

Siehe auch

IWDFDeviceInitialize