次の方法で共有

IWDFDevice::RetrieveDeviceName メソッド (wudfddi.h)

  • [アーティクル]

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

RetrieveDeviceName メソッドは、基になるカーネル モード デバイスの名前を取得します。

構文

HRESULT RetrieveDeviceName(
  [out]     PWSTR pDeviceName,
  [in, out] DWORD *pdwDeviceNameLength
);

パラメーター

[out] pDeviceName

基になるカーネル モード デバイスの名前を表す NULL-terminated 文字列を受け取るバッファーへのポインター 。バッファーが非NULL で、RetrieveDeviceName 成功した場合。

[in, out] pdwDeviceNameLength

デバイス名の NULL 文字を含む文字数を受け取る変数へのポインター。

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

pDeviceName のバッファーが NULL以外の場合、フレームワークはデバイス名文字列のサイズを文字で返します。

戻り値

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

  • pDeviceName パラメーターが指すバッファーは、NULL であり、NULL 文字を含む名前文字列を保持するのに十分な大きさでした。フレームワークは指定されたバッファーに文字列を正常にコピーし、pdwDeviceNameLength が指す変数を文字列内の文字数に設定。
  • pDeviceName のバッファーは NULL 、ドライバーは pdwDeviceNameLength 変数を 0 に事前設定し、フレームワークは pdwDeviceNameLength の変数を文字列に必要な文字数に設定しました。

RetrieveDeviceName は、HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) を返して、指定されたバッファーが非NULL であり、デバイス名を保持するのに十分な領域が含まれていないことを示します。 フレームワークは、pdwDeviceNameLength 変数を、文字列に必要な文字数に設定します。

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

備考

デバイス名は物理デバイス オブジェクト (PDO) 名ではありません。 代わりに、デバイス名はリフレクタの名前です。 ドライバーは、このデバイス オブジェクトのすべての I/O を対象にする必要があります。

例

次のコード例は、基になるカーネル モード デバイスの名前を取得する方法を示しています。

    PWSTR deviceName = NULL;
    DWORD deviceNameCch = 0;
    HRESULT hr;
    //
    // Get the length of the device name to allocate a buffer
    //
    hr = m_FxDevice->RetrieveDeviceName(NULL, &deviceNameCch);
    //
    // Allocate the buffer
    //
    deviceName = new WCHAR[deviceNameCch];

    if (deviceName == NULL) {
        hr = E_OUTOFMEMORY;
        goto Exit1;
    }
    //
    // Get the device name
    //
    hr = m_FxDevice->RetrieveDeviceName(deviceName,
                                        &deviceNameCch);

    // Open the device and get the handle

    m_Handle = CreateFile(deviceName, 
                         (GENERIC_READ | GENERIC_WRITE), 
                         0, 
                         NULL, 
                         OPEN_EXISTING, 
                         FILE_FLAG_OVERLAPPED, 
                         NULL);

必要条件

要件 価値
サポート終了 UMDF 2.0 以降では使用できません。
ターゲット プラットフォーム の デスクトップ
UMDF の最小バージョン を する 1.5
ヘッダー wudfddi.h (Wudfddi.h を含む)
DLL WUDFx.dll

関連項目

IWDFDevice の