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

[アーティクル]
08/08/2023

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

CreatePreallocatedWdfMemory メソッドは、指定されたバッファーのフレームワークメモリオブジェクトを作成します。

構文

HRESULT CreatePreallocatedWdfMemory(
  [in]           BYTE       *pBuff,
  [in]           SIZE_T     BufferSize,
  [in, optional] IUnknown   *pCallbackInterface,
  [in, optional] IWDFObject *pParentObject,
  [out]          IWDFMemory **ppWdfMemory
);

パラメーター

[in] pBuff

メモリオブジェクトのドライバー指定のデータバッファーへのポインター。

[in] BufferSize

pBuff が指すデータのサイズ (バイト単位)。

[in, optional] pCallbackInterface

新しく作成されたメモリオブジェクトでドライバーがサブスクライブするオブジェクト関連のイベントコールバック関数を決定するためにフレームワークが使用する IUnknown インターフェイスへのポインター。このパラメーターは省略可能です。ドライバーが通知を必要としない場合、ドライバーは NULL を 渡すことができます。 IUnknown インターフェイスは、オブジェクトのクリーンアップと破棄に使用されます。ドライバーが有効なポインターを渡した場合、フレームワークは IObjectCleanup インターフェイスの IUnknown インターフェイスで QueryInterface を呼び出します。フレームワークがドライバーの IObjectCleanup インターフェイスを取得した場合、フレームワークは後でドライバーの IObjectCleanup::OnCleanup メソッドを呼び出して、メモリオブジェクトがクリーンアップされたことをドライバーに通知できます。

[in, optional] pParentObject

作成されたメモリオブジェクトの親オブジェクトの IWDFObject インターフェイスへのポインター。 NULL の場合、ドライバーオブジェクトは既定の親になります。

[out] ppWdfMemory

新しく作成された WDF メモリオブジェクトの IWDFMemory インターフェイスへのポインターを受け取るバッファーへのポインター。

戻り値

CreatePreallocatedWdfMemory は、操作が成功した場合にS_OKを返します。それ以外の場合、このメソッドは Winerror.h で定義されているエラーコードのいずれかを返します。

注釈

CreatePreallocatedWdfMemory メソッドは、ドライバーが以前に割り当てたか取得したバッファーのフレームワークメモリオブジェクトを作成します。

既存のメモリバッファーを表すメモリオブジェクトを作成する必要がある場合、UMDF ドライバーは CreatePreallocatedWdfMemory を呼び出すことができます。たとえば、ドライバーは、内部 I/O コントロールコードを含む I/O 要求のバッファー内でドライバー定義構造体を受け取る場合があります。ドライバーは CreatePreallocatedWdfMemory を 呼び出してメモリオブジェクトを作成し、ドライバーが構造体を I/O ターゲットに渡すことができるようにすることができます。

UMDF ドライバーが CreatePreallocatedWdfMemory を呼び出した後、ドライバーは IWDFMemory::SetBuffer を呼び出して 、CreatePreallocatedWdfMemory が作成したメモリオブジェクトに別のバッファーを割り当てることができます。

CreatePreallocatedWdfMemory が作成したフレームワークメモリオブジェクトが削除された場合、フレームワークは既存のバッファーの割り当てを解除しません。同様に、 IWDFMemory::SetBuffer の呼び出しでは、以前に割り当てられたバッファーの割り当てが解除されません。

例

次のコード例は、バッファーのメモリオブジェクトを作成する方法を示しています。

    //
    // Allocate a request.
    hr = wdfDevice->CreateRequest(NULL, NULL, &request);

    // Allocate a buffer and wrap it in a memory object. 
    // Make the memory object a child of the request. 
    // When the request object is deleted, the memory object 
    // is also deleted. 

    if (SUCCEEDED(hr))
    {
       buffer = new BYTE[m_HidDescriptor->wReportLength];

       if (buffer == NULL)
       {
          hr = E_OUTOFMEMORY;
       }
    }

    if (SUCCEEDED(hr))
    {
       CComPtr<IWDFDriver> driver;
       wdfDevice->GetDriver(&driver);

       hr = driver->CreatePreallocatedWdfMemory(
                       buffer,
                       m_HidDescriptor->wReportLength,
                       NULL,
                       request,
                       &memory
                       );
    }

要件

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