IWDFDriver::RetrieveVersionString-Methode (wudfddi.h)

  • Artikel

[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 RetrieveVersionString-Methode ruft die Version des Frameworks ab.

Syntax

HRESULT RetrieveVersionString(
  [out]     PWSTR pVersion,
  [in, out] DWORD *pdwVersionLength
);

Parameter

[out] pVersion

Ein Zeiger auf einen Puffer, der eine NULL-beendete Zeichenfolge empfängt, die die Version des Frameworks darstellt, wenn der angegebene Puffer nicht NULL ist und RetrieveVersionString erfolgreich ist.

[in, out] pdwVersionLength

Ein Zeiger auf eine Variable, die die Größe der Versionszeichenfolge in Zeichen empfängt, auf die pVersion zeigt. Bei der Eingabe enthält diese Variable die Größe des Puffers bei pVersion in Bytes.

Wenn der Puffer bei pVersionNULL ist, ist der vom Treiber bereitgestellte Wert 0. Das Framework gibt dann die Größe in Zeichen zurück, die für die Versionszeichenfolge erforderlich ist.

Wenn der Puffer bei pVersion nicht NULL ist, gibt das Framework die Größe der Versionszeichenfolge in Zeichen zurück.

Rückgabewert

RetrieveVersionString gibt S_OK für die folgenden Szenarien zurück:

  • Der Puffer, auf den der pVersion-Parameter verweist, war nicht NULL und groß genug, um die Versionszeichenfolge zu enthalten, einschließlich des NULL-Zeichens . Darüber hinaus hat das Framework die Zeichenfolge erfolgreich in den angegebenen Puffer kopiert und die Variable festgelegt, auf die vom parameter pdwVersionLength auf die Anzahl der Zeichen in der Zeichenfolge verwiesen wird.
  • Der Puffer bei pVersion war NULL, der Treiber hat die Variable bei pdwVersionLength auf 0 festgelegt, und das Framework legt die Variable auf pdwVersionLength auf die Anzahl der Zeichen fest, die für die Zeichenfolge erforderlich sind.
RetrieveVersionString gibt HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) zurück, um anzugeben, dass der angegebene Puffer nicht NULL ist und nicht genügend Speicherplatz für die Version enthielt. Das Framework legt die Variable bei pdwVersionLength auf die Anzahl der Zeichen fest, die für die Zeichenfolge erforderlich sind.

RetrieveVersionString 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