IDirectSoundBuffer8::GetFormat
バッファ内のサウンド データのフォーマットに関する情報、またはフォーマットの記述を取得するために必要なバッファ サイズを取得する。
構文
HRESULT GetFormat(
LPWAVEFORMATEX
pwfxFormat
,
DWORD
dwSizeAllocated
,
LPDWORD
pdwSizeWritten
);
パラメータ
pwfxFormat
バッファ内のサウンド データに関する情報を受け取る WAVEFORMATEX 構造体または WAVEFORMATEXTENSIBLE 構造体のアドレス。フォーマットの記述を保持するために必要なバッファ サイズを取得するには NULL を指定する。この場合、pdwSizeWritten の変数が、データを受け取るために必要な構造体のサイズを受け取る。
dwSizeAllocated
pwfxFormat の構造体のサイズ (バイト単位)。pwfxFormat が NULL でない場合は、この値は予想されるデータ サイズ以上でなければならない。
pdwSizeWritten
pwfxFormat の構造体に書き込まれたバイト数を受け取る変数のアドレス。このパラメータは NULL にしてもよい。
戻り値
成功した場合は DS_OK を返す。
失敗した場合は DSERR_INVALIDPARAM を返す。
注意
フォーマット構造体は、フォーマットに応じて長さが変化する場合がある。アプリケーションは、フォーマットの記述を取得する前に、pwfxFormat パラメータに NULL を指定してこのメソッドを呼び出し、フォーマットのサイズをバッファ オブジェクトに照会する必要がある。必要な構造体のサイズは、pdwSizeWritten パラメータに返される。続いてアプリケーションは、十分なメモリを割り当て、GetFormat をもう一度呼び出して、フォーマットの記述を取得できる。
要件
** ヘッダー:**dsound.h で宣言。
参照