IMiniportMidiStream::Read メソッド (portcls.h)

Read メソッドは、着信 MIDI ストリームからデータを読み取ります。

構文

NTSTATUS Read(
  [in]  PVOID  BufferAddress,
  [in]  ULONG  BufferLength,
  [out] PULONG BytesRead
);

[in] BufferAddress

呼び出し元によって割り当てられたバッファーのアドレスを指定します。このメソッドは、受信 MIDI データをデバイスからバッファーにコピーします。このバッファーの割り当てられたサイズは、BufferLength 以上である必要があります。

[in] BufferLength

BufferAddress 指すバッファーの長さをバイト単位で指定します。

[out] BytesRead

メソッドがデバイスから正常に読み取られた実際のバイト数を指定するカウントをバッファーに書き込む呼び出し元によって割り当てられた変数への出力ポインター。

Read は、呼び出しが成功した場合にSTATUS_SUCCESSを返します。それ以外の場合、メソッドは適切なエラーコードを返します。次の表に、考えられる戻り状態コードの一部を示します。

リターンコード	形容
STATUS_INVALID_DEVICE_REQUEST	無効なデバイス要求 (MIDI 出力ストリームでの `Read` の呼び出しなど)。

ミニポートドライバーは、IPortMidi::着信 MIDI データがキャプチャデバイスから使用可能になったときにポートドライバーに通知するを呼び出します。ポートドライバーは、IMiniportMidi::Read 呼び出してデータを取得します。ポートドライバーは、使用可能なデータが増える限り、Read を引き続き呼び出します。

Read メソッドは、STATUS_SUCCESSと BytesRead 0 のカウントを返し、デバイスから現在使用できる MIDI 入力データがないことを示します。