Freigeben über


IWDFDriver::RetrieveVersionString-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 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--terminated-Zeichenfolge empfängt, die die Version des Frameworks darstellt, wenn der angegebene Puffer nichtNULL- 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 verweist. Bei eingaben enthält diese Variable die Größe des Puffers in Byte bei pVersion.

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

Wenn der Puffer bei pVersion nichtNULL-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 nichtNULL- und groß genug, um die Versionszeichenfolge aufzunehmen, einschließlich des NULL- Zeichens. Darüber hinaus hat das Framework die Zeichenfolge erfolgreich in den bereitgestellten Puffer kopiert und die Variable festgelegt, auf die durch die pdwVersionLength Parameter 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 nichtNULL- ist und nicht genügend Platz zum Speichern der Version enthält. Das Framework legt die Variable bei pdwVersionLength auf die Anzahl der Zeichen fest, die für die Zeichenfolge erforderlich sind.

RetrieveVersionString- 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