次の方法で共有

IKsPropertySet::Get メソッド

  • [アーティクル]

[このページに関連付けられている機能 DirectShow は、従来の機能です。 MediaPlayer、IMFMediaEngine、Media Foundation のオーディオ/ビデオ キャプチャに置き換わりました。 これらの機能は、Windows 10とWindows 11用に最適化されています。 新しいコードでは、可能であれば、DirectShow ではなく Media Foundation で MediaPlayer、IMFMediaEngine、Audio/Video Capture を使用することを強くお勧めします。 Microsoft は、レガシ API を使用する既存のコードを、可能であれば新しい API を使用するように書き換えるよう提案しています。]

Get メソッドは、プロパティ セット GUID とプロパティ ID で識別されるプロパティを取得します。

構文

HRESULT Get(
  [in]  REFGUID guidPropSet,
  [in]  DWORD   dwPropID,
  [in]  LPVOID  pInstanceData,
  [in]  DWORD   cbInstanceData,
  [out] LPVOID  pPropData,
  [in]  DWORD   cbPropData,
  [out] DWORD   *pcbReturned
);

パラメーター

guidPropSet [in]

プロパティ セットの GUID。

dwPropID [in]

プロパティ セット内のプロパティの識別子。

pInstanceData [in]

プロパティのインスタンス データを含むバイト配列へのポインター。

cbInstanceData [in]

pInstanceData で指定された配列のサイズ (バイト単位)。

pPropData [out]

プロパティ データを受け取るバイト配列へのポインター。

cbPropData [in]

pPropData で指定された配列のサイズ (バイト単位)。

pcbReturned [out]

メソッドが pPropData 配列にコピーするバイト数を受け取ります。

戻り値

HRESULT 値を返します。 使用可能な値は次のとおりです。

リターン コード 説明
S_OK
 成功しました。
E_PROP_SET_UNSUPPORTED
 プロパティ セットはサポートされていません。
E_PROP_ID_UNSUPPORTED
 プロパティ ID は、指定されたプロパティ セットではサポートされていません。

 

解説

注意

この名前の別のインターフェイスが dsound.h ヘッダー ファイルに存在します。 2 つのインターフェイスには互換性がありません。 DirectShow DDK に記載されている IKsControl インターフェイスが、WDM ドライバーとユーザー モード コンポーネント間でプロパティ セットを渡すための推奨インターフェイスになりました。

 

プロパティを取得するには、このメソッドが入力するバッファーを割り当てます。 必要なバッファー サイズを確認するには、pPropData に NULL、cbPropData にゼロ (0) を指定します。 このメソッドは 、pcbReturned で必要なバッファー サイズを返します。

Ksproxy.h の前に Ks.h を含める必要があります。

例

次の例では、 AMPROPERTY_PIN_CATEGORY プロパティを取得して、ピンカテゴリのピンを照会します。 (「 Pin プロパティ セット」を参照)。

HRESULT GetPinCategory(IPin *pPin, GUID *pPinCategory)
{
    IKsPropertySet *pKs = NULL;

    HRESULT hr = pPin->QueryInterface(IID_PPV_ARGS(&pKs));
    if (FAILED(hr))
    {
        return hr;
    }

    // Try to retrieve the pin category.
    DWORD cbReturned = 0;
    hr = pKs->Get(AMPROPSETID_Pin, AMPROPERTY_PIN_CATEGORY, NULL, 0, 
        pPinCategory, sizeof(GUID), &cbReturned);
    
    // If this succeeded, pPinCategory now contains the category GUID.

    SafeRelease(&pKs);
    return hr;
}

要件

要件 値
サポートされている最小のクライアント
 Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー
Ksproxy.h
ライブラリ
Strmiids.lib

関連項目

エラーコードと成功コード

IKsPropertySet インターフェイス

プロパティ セット