ITuningSpaceContainer

ITuningSpaceContainer インターフェイスは、SystemTuningSpaces オブジェクトに実装されています。

このインターフェイスのインターフェイス識別子 (IID) を宣言するには、__uuidof 演算子を使用します: __uuidof(ITuningSpaceContainer)。

get_Count メソッドは、現在ローカルシステムで利用可能なチューニングスペースの数を取得します。

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。

get__NewEnum メソッドは、Automation クライアントでの For...Each ループをサポートします。

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。

このメソッドは、スクリプトや Visual Basic のアプリケーションが For...Each ループでコレクションを反復処理できるようにするために提供されています。C++ アプリケーションでは、ITuningSpaceContainer::get_EnumTuningSpaces メソッドを使用してください。

返される IEnumVARIANT インターフェイスは、主に Automation クライアントでの使用を目的としているため、スレッドセーフではありません。クライアントは、複数のスレッドからこのインターフェイスのメソッドを呼び出さないでください。

get_Item メソッドは、指定した ID を持つチューニングスペースを取得します。

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。

チューニングスペースは ID 番号で識別されます。ID 番号はコレクション内で一意です。有効な ID の範囲は連続しているとは限らず、チューニングスペースが追加された後に削除されると、欠番が生じる場合があります。

例

CComPtr <ITuningSpaceContainer>  pTuningSpaceContainer;
// SystemTuningSpaces オブジェクトを作成します (図示せず)。

long cCount = 0;
long ID = 1; // ゼロは有効な ID ではありません。
hr = pTuningSpaceContainer->get_Count(&cCount);
if (SUCCEEDED(hr))
{
    while (cCount)
    {
        CComPtr<ITuningSpace> pTuningSpace;
        CComVariant varIndex(ID);
        hr = pITuningSpaceContainer->get_Item(varIndex, &pTuningSpace);
        if (SUCCEEDED(hr))
        {
             // pTuningSpace はこの ID を持つチューニングスペースを指すようになります。
             --cCount;
        }
        ID++; // 次の ID のためにインクリメントします。
    }
}

put_Item メソッドは、コレクション内の既存のチューニングスペースに対する変更を保存します。

HRESULT を返します。取り得る値には次の表のものが含まれます。

メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。

アプリケーションは、コレクションから既存のチューニングスペースを取得し、ITuningSpace のメソッドを呼び出してそのプロパティを変更した後、put_Item を呼び出して変更を保存できます。チューニングスペースの一意の名前プロパティは、コレクション内の指定したインデックスにあるチューニングスペースと一致している必要があります。一致しない場合、メソッドは E_INVALIDARG を返します。

新しいチューニングスペースを追加するには、ITuningSpaceContainer::Add メソッドを使用してください。

TuningSpacesForCLSID メソッドは、指定した CLSID に一致するチューニングスペースのコレクションを取得します。このメソッドは CLSID を BSTR として返すため、Automation クライアント向けです。

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。

TuningSpacesForName メソッドは、指定した名前に一致するチューニングスペースのコレクションを取得します。

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。

名前に一致するチューニングスペースがない場合、返されるコレクションは空になることがあります。

例

CComPtr <ITuningSpaceContainer>  pTuningSpaceContainer;
// SystemTuningSpaces オブジェクトを作成します (図示せず)。

// "Local (something) 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 を使用してコレクションを反復処理します。
        }
    }
}

FindID メソッドは、コレクション内の指定したチューニングスペースの ID を取得します。

HRESULT を返します。取り得る値には次の表のものが含まれます。

Add メソッドは、新しい永続的なチューニングスペースをシステムに追加します。

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。

このメソッドは、新しいチューニングスペースをコレクションに追加します。コレクションオブジェクトは、チューニングスペースの情報を自動的に永続化します。

チューニングスペースには、コレクションに既に存在するどのチューニングスペースとも競合しない一意の名前が必要です。既存のチューニングスペースを上書きするには、ITuningSpaceContainer::put_Item メソッドを使用してください。

get_EnumTuningSpaces メソッドは、ローカルシステムで利用可能なすべてのチューニングスペースのコレクションを取得します。

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。

C++ アプリケーションでは、このメソッドを使用して、ローカルシステムで定義されているチューニングスペースの初期リストを取得します。

Remove メソッドは、チューニングスペースをシステムから完全に削除します。

成功した場合は S_OK を返します。指定したチューニングスペースがレジストリ内で無効または破損していた場合、このメソッドはそこにある情報をすべて削除し、S_FALSE を返します。

get_MaxCount メソッドは、システムで許可されるチューニングスペースの最大数を取得します。

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。

put_MaxCount メソッドは、システムで許可されるチューニングスペースの最大数を設定します。

成功した場合は S_OK を返します。メソッドが失敗した場合は、標準的な COM の IErrorInfo インターフェイスを使用してエラー情報を取得できます。