IWDFDevice::P ostEvent メソッド (wudfddi.h)

  • [アーティクル]

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

PostEvent メソッドは、ドライバーから指定されたイベントを待機しているアプリケーションに非同期的に通知します。

構文

HRESULT PostEvent(
  [in] REFGUID        EventGuid,
  [in] WDF_EVENT_TYPE EventType,
  [in] BYTE           *pbData,
  [in] DWORD          cbDataSize
);

パラメーター

[in] EventGuid

イベントの GUID。 GUID はアプリケーションとドライバーによって決定され、フレームワークに対して不透明です。

[in] EventType

イベント の種類を識別するWDF_EVENT_TYPE型指定された値。 UMDF の現在のバージョンでは、ドライバーは EventType を WdfEventBroadcast (1) に設定する必要があります。 WdfEventBroadcast は、イベントがブロードキャストされていることを示します。 アプリケーションは WdfEventBroadcast 型のイベントをサブスクライブできます。 ブロードキャスト イベントを受信するには、アプリケーションが Microsoft Win32 RegisterDeviceNotification 関数を通じて通知用に登録する必要があります。 WdfEventBroadcast 型のイベントは、DBT_CUSTOMEVENT 型のイベントとしてアプリケーションに公開されます。

[in] pbData

イベントに関連付けられているデータを含むバッファーへのポインター。 NULL は有効な値です。

[in] cbDataSize

pbData が指すデータのサイズ (バイト単位)。 pbData が NULL に設定されている場合、0 は有効なサイズ値です。

イベント データの最大サイズは MAXUSHORT (64 KB) よりわずかに小さくなります。 正確な上限は (0xFFFF - FIELD_OFFSET(TARGET_DEVICE_CUSTOM_NOTIFICATION、CustomDataBuffer)) です。

戻り値

PostEvent は、次のいずれかの値を返します。

リターン コード 説明
S_OK
 イベント データがオペレーティング システムに正常に送信されました。
HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY)
 cbDataSize パラメーターが指定するデータ サイズが、許容される最大サイズを超えています。
E_INVALIDARG
 EventType パラメーターが WdfEventBroadcast (1) に設定されていません。
E_OUTOFMEMORY

PostEvent は、完了するために必要なメモリを割り当てませんでした。
 

PostEvent は、他の HRESULT 値を返す場合もあります。

注釈

ドライバーが IWDFDevice::P ostEvent を呼び出してイベントについて要求側のアプリケーションに通知すると、UMDF はオペレーティング システムにイベントを送信します。 オペレーティング システムは、非同期操作で要求側アプリケーションに イベントを送信します。 オペレーティング システムが最初にエラーを返さない場合、ドライバーはエラーを受け取らなくなります (S_OK)。 ただし、後で、オペレーティング システムがイベントの配信中にエラーを受け取った場合 (メモリ不足の状態が原因である可能性があります)、オペレーティング システムはエラーについてドライバーに通知できません。 このイベント通知は非同期の性質上、要求側アプリケーションへのイベントの配信は保証されません。 要求元のアプリケーションまでの途中でイベント情報が失われた場合、アプリケーションは失われたイベントから回復できる必要があります。

デバイス イベントの作成の詳細については、「 UMDF ドライバーでのデバイス インターフェイスの使用」を参照してください。

要件

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

こちらもご覧ください

FIELD_OFFSET

IWDFDevice

TARGET_DEVICE_CUSTOM_NOTIFICATION

WdfDevicePostEvent