Win32 API 日本語リファレンス
ホームMedia.Audio › IPartsList

IPartsList

COM
IID6daa848c-5eb0-45cc-aea5-998a2cda1ffb継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IPartsList インターフェイスは、パーツのリストを表します。各パーツは、コネクターまたはサブユニットを表す IPart インターフェイスを持つオブジェクトです。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetCount(DWORD* pCount)

GetCount メソッドは、パーツリスト内のパーツ数を取得します。

pCountDWORD*outパーツ数(パーツリスト内のパーツの個数)を書き込む UINT 変数へのポインター。

戻り値

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

戻り値 説明
E_POINTER
ポインター pCountNULL です。
vtbl 4 HRESULT GetPart(DWORD nIndex, IPart** ppPart)

GetPart メソッドは、パーツリストからパーツを取得します。

nIndexDWORDin取得するパーツのパーツ番号。パーツリストに n 個のパーツが含まれる場合、パーツには 0 から n– 1 までの番号が付けられます。リスト内のパーツ数を取得するには、IPartsList::GetCount メソッドを呼び出します。
ppPartIPart**outパーツオブジェクトの IPart インターフェイスのアドレスを書き込むポインター変数へのポインター。このメソッドを通じて、呼び出し元は IPart インターフェイスへのカウント付き参照を取得します。呼び出し元は、インターフェイスが不要になったときに、インターフェイスの Release メソッドを呼び出して解放する責任があります。GetPart の呼び出しが失敗した場合、*ppPartNULL になります。

戻り値

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

戻り値 説明
E_INVALIDARG
パラメーター nIndex が範囲外です。
E_POINTER
ポインター ppPartNULL です。

解説(Remarks)

GetPart メソッドを呼び出すコード例については、Device Topologies にある SelectCaptureDevice 関数の実装を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_IPartsList "{6DAA848C-5EB0-45CC-AEA5-998A2CDA1FFB}"
#usecom global IPartsList IID_IPartsList "{}"
#comfunc global IPartsList_GetCount  3 var
#comfunc global IPartsList_GetPart   4 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。