ITuningSpaceContainer::TuningSpacesForName
TuningSpacesForName メソッドは、指定された名前と一致するチューニング空間のコレクションを取得する。
構文
HRESULT TuningSpacesForName(
BSTR Name,
ITuningSpaces** ppTuningSpaces
);
パラメータ
Name
[in] チューニング空間のフレンドリ名または一意の名前のいずれかと一致する正規表現を含む文字列。
ppTuningSpaces
[out] ITuningSpaces インターフェイス ポインタを受け取る変数のアドレス。このインターフェイスを使ってコレクションを列挙する。呼び出し元はそのインターフェイスを解放しなければならない。
戻り値
成功した場合は S_OK を返す。メソッドが失敗した場合は、標準 COM IErrorInfo インターフェイスを使ってエラー情報を取得できる。
サンプル コード
CComPtr <ITuningSpaceContainer> pTuningSpaceContainer;
// SystemTuningSpaces オブジェクトを作成する (省略)。
// "Local (任意の文字列) Cable" という名前に一致するチューニング空間を検索する。
CComPtr<ITuningSpaces> pTunes;
CComBSTR bstrName("Local.*Cable");
hr = pITuningSpaceContainer->TuningSpacesForName(bstrName, &pTunes);
if (SUCCEEDED(hr))
{
// 返されたコレクションのサイズを検索する。
long cCount = 0;
hr = pTunes->get_Count(&cCount);
if (SUCCEEDED(hr) && (cCount > 0))
{
// コレクションを列挙する。
CComPtr<IEnumTuningSpaces> pTuneEnum;
hr = pTunes->get_EnumTuningSpaces(&pTuneEnum);
if (SUCCEEDED(hr))
{
// IEnumTuningSpaces を使用してコレクションを順に処理する。
}
}
}
注意
名前の一致するチューニング空間が存在しない場合、返されるコレクションは空である可能性がある。
参照