Platform SDK: DirectX

IKsPropertySet::Get

IKsPropertySet::Get メソッドは、プロパティ セット内の特定の項目に対応するデータを取り出す。

HRESULT Get(
  REFGUID rguidPropSet,
  ULONG ulId, 
  LPVOID pInstanceData, 
  ULONG ulInstanceLength, 
  LPVOID pPropertyData, 
  ULONG ulDataLength,
  ULONG * pulBytesReturned
);

パラメータ

rguidPropSet
アクセスすべきプロパティ セットを表す GUID への参照 (C++) またはアドレス (C)。
ulId
アクセスすべきプロパティ セット内の項目。項目は 0 から始まるインデックス番号を割り当てられており、特定のプロパティ セット GUID では常に同じである。
pInstanceData
Get 呼び出しの対象となるインスタンス データ。
ulInstanceLength
pInstanceData が指すバイト数。
pPropertyData
この項目から取得されるデータ。
ulDataLength
pPropertyData が指すバイト数。
pulBytesReturned
pPropertyData に書き込まれたバイト数を受け取る変数のアドレス。

戻り値

戻り値は、プロパティ セットの設計者によって決定される。

成功すれば S_OK、失敗すれば E_POINTER を返す。

注意

pInstanceData pPropertyData の各データのフォーマットは、項目ごとに異なる。

動作環境

  Windows NT/2000 : Windows 2000 が必要。
  Windows 95/98 : Windows 95 以降が必要。Windows 95 用に再配布可能な形で使用可能。
  ヘッダー : dsound.h で宣言。