IKsFormatSupport::GetDevicePreferredFormat メソッド (devicetopology.h)

  • [アーティクル]

GetDevicePreferredFormat メソッドは、接続に適したオーディオ ストリーム形式を取得します。

構文

HRESULT GetDevicePreferredFormat(
  [out] PKSDATAFORMAT *ppKsFormat
);

パラメーター

[out] ppKsFormat

メソッドが優先形式の書式指定子を含むバッファーのアドレスを書き込むポインター変数へのポインター。 指定子は、追加の書式情報が続く可能性がある KSDATAFORMAT 構造体で始まります。 メソッドは、書式指定子にストレージを割り当てます。 呼び出し元は、不要になったときに CoTaskMemFree 関数を呼び出すことによって、ストレージを解放する役割を担います。 メソッドが失敗した場合、 *ppKsFormat は NULL です。 KSDATAFORMAT、書式指定子、および CoTaskMemFree の詳細については、Windows DDK のドキュメントを参照してください。

戻り値

メソッドが成功した場合は、S_OK を返します。 失敗した場合、次の表に示す値が含まれますが、これに限定されません。

リターン コード 説明
E_POINTER
 ポインター ppKsFormat は NULL です。
E_OUTOFMEMORY
 メモリが不足しています。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー devicetopology.h

こちらもご覧ください

IKsFormatSupport インターフェイス