Microsoft DirectX 8.0 (C++)

IDirectSoundCaptureBuffer8::GetFormat

キャプチャ バッファのフォーマットを取得する。

HRESULT GetFormat(
  LPWAVEFORMATEX pwfxFormat, 
  DWORD dwSizeAllocated, 
  LPDWORD pdwSizeWritten 
);

パラメータ

pwfxFormat
キャプチャ バッファ内のサウンド データに関する情報を受け取る WAVEFORMATEX 構造体のアドレス。フォーマットの記述を保持するために必要なバッファ サイズを取得するには NULL を指定する。この場合、pdwSizeWritten パラメータが指す DWORD で、完全なフォーマット情報を受け取るために必要な構造体のサイズを受け取る。
dwSizeAllocated
WAVEFORMATEX 構造体のサイズ (バイト単位)。DirectSoundCapture が構造体へ書き込むバイト数は、最大で dwSizeAllocated バイトである。構造体がそれより多くのメモリを必要とする場合、切り捨てが行われる。
pdwSizeWritten
WAVEFORMATEX 構造体に書き込まれたバイト数を受け取る変数のアドレス。または、pwfxFormat が NULL の場合は、情報を受け取るために必要な WAVEFORMATEX 構造体のサイズ。値が必要でない場合、このパラメータを NULL にする。

戻り値

成功した場合は DS_OK を返す。

失敗した場合は DSERR_INVALIDPARAM を返す。

動作環境

  ヘッダー : dsound.h で宣言。