IWDFDriver::RetrieveVersionString メソッド (wudfddi.h)

  • [アーティクル]

[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは UMDF 2 を使用する必要があります。 詳細については、「UMDF を使用したはじめに」を参照してください。

RetrieveVersionString メソッドは、フレームワークのバージョンを取得します。

構文

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

パラメーター

[out] pVersion

指定されたバッファーが NULL 以外で RetrieveVersionString が成功した場合に、フレームワークのバージョンを表す NULL で終わる文字列を受け取るバッファーへのポインター。

[in, out] pdwVersionLength

pVersion が指すバージョン文字列のサイズを文字単位で受け取る変数へのポインター。 入力時に、この変数には pVersion のバッファーのサイズ (バイト単位) が含まれます。

pVersion のバッファーが NULL の場合、ドライバーが提供する値は 0 です。 その後、フレームワークは、バージョン文字列に必要なサイズを文字で返します。

pVersion のバッファーが NULL 以外の場合、フレームワークはバージョン文字列のサイズを文字で返します。

戻り値

RetrieveVersionString は 、次のシナリオでS_OKを返します。

  • pVersion パラメーターが指すバッファーは NULL 以外であり、NULL 文字を含むバージョン文字列を保持するのに十分な大きさでした。 さらに、フレームワークは指定されたバッファーに文字列を正常にコピーし、 pdwVersionLength パラメーターが指す変数を文字列内の文字数に設定しました。
  • pVersion のバッファーは NULL で、ドライバーは pdwVersionLength の変数を 0 に事前設定し、フレームワークは pdwVersionLength の変数を文字列に必要な文字数に設定しました。
RetrieveVersionString はHRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) を返し、指定されたバッファーが NULL 以外であり、バージョンを保持するのに十分な領域が含まれていないことを示します。 フレームワークは 、pdwVersionLength の変数を、文字列に必要な文字数に設定します。

RetrieveVersionString は、他の HRESULT 値も返す場合があります。

要件

要件 値
サポート終了 UMDF 2.0 以降では使用できません。
対象プラットフォーム デスクトップ
最小 UMDF バージョン 1.5
Header wudfddi.h (Wudfddi.h を含む)
[DLL] WUDFx.dll