IKsJackDescription::GetJackDescription メソッド (devicetopology.h)

GetJackDescription メソッドは、オーディオジャックの説明を取得します。

構文

HRESULT GetJackDescription(
  [in]  UINT               nJack,
  [out] KSJACK_DESCRIPTION *pDescription
);

[in] nJack

ジャックインデックス。接続が n 個のジャックで構成されている場合、ジャックの番号は 0 から n – 1 になります。ジャックの数を取得するには、 IKsJackDescription::GetJackCount メソッドを呼び出します。

[out] pDescription

メソッドがジャックに関する情報を含む型 KSJACK_DESCRIPTION の構造体を書き込む呼び出し元によって割り当てられたバッファーへのポインター。バッファーサイズは、少なくとも sizeof(KSJACK_DESCRIPTION) である必要があります。

メソッドが成功した場合は、S_OK を返します。エラーが発生した場合、次の表に示す値が、可能なリターンコードに含まれますが、これらに限定されません。

リターンコード	説明
E_INVALIDARG	パラメーター nJack が有効なジャックインデックスではありません。
E_POINTER	ポインター pDescription は NULL です。

ユーザーがオーディオエンドポイントデバイスをジャックに接続するかジャックから取り外す必要がある場合、オーディオアプリケーションは、このメソッドから取得した説明情報を使用して、ユーザーがジャックを見つけるのに役立ちます。この情報には、以下が含まれます。

詳細については、「 KSJACK_DESCRIPTION」を参照してください。