Microsoft DirectX 8.0

ITuningSpaceContainer インターフェイス

ITuningSpaceContainer インターフェイスは、SystemTuningSpaces オブジェクトに実装される。SystemTuningSpaces オブジェクトを使用すると、アプリケーションからローカル システムに定義された全チューニング空間のアクセスおよび修正ができる。

メソッド名説明
get_Countローカル システム上で現在利用可能なチューニング空間の数を取得する。
get__NewEnumAutomation クライアントの For...Each ループをサポートするための列挙メソッド。
get_Item指定されたインデックス位置のチューニング空間オブジェクトを取得する。
put_Item指定されたインデックス位置にチューニング空間オブジェクトを保存する。
TuningSpacesForCLSID指定された CLSID 文字列と一致するチューニング空間のコレクションを取得する。(Automation クライアントで使用)
_TuningSpacesForCLSID指定された CLSID 文字列と一致するチューニング空間のコレクションを取得する。(C++ クライアントで使用)
TuningSpacesForNameフレンドリ名と一致するチューニング空間のコレクションを取得する。
FindID指定されたチューニング空間のローカル一意識別子を取得する。
Add新しい持続的なチューニング空間をシステムに追加する。
get_EnumTuningSpacesローカル システム上で利用可能な全チューニング空間のコレクションを取得する。
Removeチューニング空間をシステムから完全に削除する。
put_MaxCountシステム上で許されるチューニング空間の最大数を取得する。
get_MaxCountシステム上で許されるチューニング空間の最大数を設定する。

ITuningSpaceContainer::get_Count

ITuningSpaceContainer インターフェイス

ローカル システム上で現在利用可能なチューニング空間の数を取得する。

構文

HRESULT get_Count(
    long *Count
    );

パラメータ

Count
[out, retval] チューニング空間の数を受け取る Long 型変数へのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpaceContainer::get_MaxCount

ITuningSpaceContainer インターフェイス

システム上で許されるチューニング空間の最大数を取得する。

構文

HRESULT get_MaxCount(
    long *MaxCount
    );

パラメータ

MaxCount
[out, retval] チューニング空間の最大数を受け取る Long 型変数へのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpaceContainer::get__NewEnum

ITuningSpaceContainer インターフェイス

Automation クライアントの For...Each ループをサポートするための列挙メソッド。

構文

HRESULT get__NewEnum(
    IEnumVARIANT **NewEnum
    );

パラメータ

NewEnum
[out, retval] 返されるコレクションに設定する IEnumVARIANT インターフェイス ポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

このメソッドは、For...Each ループの繰り返しによってコレクション全体を処理するため、スクリプト アプリケーションおよび VB アプリケーション用に提供される。C++ アプリケーションでは get_EnumTuningSpaces メソッドを使用すること。

ITuningSpaceContainer::get_Item

ITuningSpaceContainer インターフェイス

指定されたインデックス位置の ITuningSpace オブジェクトを取得する。

構文

HRESULT get_Item(
VARIANT varIndex,
    ITuningSpace **ppTuningSpace
    );

パラメータ

varIndex
[in] 取得する項目のインデックスを指定する VARIANT 型変数。
ppTuningSpace
[out, retval] 返されるインターフェイスに設定する ITuningSpace インターフェイス ポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpaceContainer::put_Item

ITuningSpaceContainer インターフェイス

指定されたインデックス位置にチューニング空間オブジェクトを保存する。

構文

HRESULT put_Item(
VARIANT varIndex,
    ITuningSpace *pTuningSpace
    );

パラメータ

varIndex
[in] 設定する項目のインデックスを指定する VARIANT 型変数。
pTuningSpace
[in] システムに持続的に保存するオブジェクトの ITuningSpace インターフェイスへのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

ITuningSpace のメソッドを使用すると、アプリケーションから既存のチューニング空間を修正し、ITuningSpaceContainer::put_Item を使って変更内容をディスクに保存することができる。

ITuningSpaceContainer::TuningSpacesForCLSID

ITuningSpaceContainer インターフェイス

CLSID 文字列と一致するチューニング空間のコレクションを取得する。(Automation クライアントで使用)

構文

HRESULT TuningSpacesForCLSID(
    BSTR SpaceCLSID,
    ITuningSpaces **ppTuningSpaces
    );

パラメータ

SpaceCLSID
[in] チューニング空間の CLSID を表す文字列。
ppTuningSpaces
[out, retval] 返されるコレクションに設定する ITuningSpaces インターフェイス ポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

このメソッドを使用すると、Automation クライアントから CLSID を BSTR で指定できる。内部的には、_TuningSpacesForCLSID を呼び出しているだけである。

ITuningSpaceContainer::_TuningSpacesForCLSID

ITuningSpaceContainer インターフェイス

指定された CLSID 文字列と一致するチューニング空間のコレクションを取得する。(C++ クライアントで使用)

構文

HRESULT _TuningSpacesForCLSID(
    REFCLSID SpaceCLSID,
    ITuningSpaces **ppTuningSpaces
    );

パラメータ

SpaceCLSID
[in] 取得するチューニング空間のタイプを指定する REFCLSID 型変数。
ppTuningSpaces
[out, retval] 返されるコレクションに設定する ITuningSpaces インターフェイス ポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

C++ アプリケーションでは、TuningSpacesForCLSID ではなくこのメソッドを使用すること。

ITuningSpaceContainer::TuningSpacesForName

ITuningSpaceContainer インターフェイス

フレンドリ名と一致するチューニング空間のコレクションを取得する。

構文

HRESULT TuningSpacesForName(
    BSTR Name,
    ITuningSpaces **ppTuningSpaces
    );

パラメータ

Name
[in] チューニング空間タイプのフレンドリ名を表す文字列。
ppTuningSpaces
[out, retval] 返されるコレクションに設定する ITuningSpaces インターフェイス ポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpaceContainer::FindID

ITuningSpaceContainer インターフェイス

指定されたチューニング空間のローカル一意識別子を取得する。

構文

HRESULT FindID(
    ITuningSpace *pTuningSpace,
    long *pID
    );

パラメータ

pTuningSpace
[in] ID を取得するオブジェクトの ITuningSpace インターフェイスへのポインタ。
pID
[out, retval] ID 番号を受け取る Long 型変数へのポインタ。

戻り値

成功した場合は、S_OK を返す。TuningSpace が有効なオブジェクトを指していない場合は、E_INVALIDARG を返す。

ITuningSpaceContainer::Add

ITuningSpaceContainer インターフェイス

新しい持続的なチューニング空間をシステムに追加する。

構文

HRESULT Add(
    ITuningSpace *pTuningSpace,
    VARIANT *pNewIndex
    );

パラメータ

pTuningSpace
[in] システムに追加する新しいチューニング空間オブジェクトの ITuningSpace インターフェイスへのポインタ。
pNewIndex
[out, retval] 現在のコレクションにおける新しいチューニング空間のインデックス番号を受け取る VARIANT 型変数へのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

ITuningSpaceContainer::Add() メソッドでは、追加したオブジェクトのインデックスが 1 から始まる。IComponentTypes::Add() メソッドおよびその他のコレクションでは、すべて 0 から始まる。

ITuningSpaceContainer::get_EnumTuningSpaces

ITuningSpaceContainer インターフェイス

ローカル システム上で利用可能な全チューニング空間のコレクションを取得する。

構文

HRESULT get_EnumTuningSpaces(
    IEnumTuningSpaces **ppEnum
    );

パラメータ

ppEnum
[out, retval] 返されるコレクションに設定する IEnumTuningSpaces インターフェイス ポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

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

ITuningSpaceContainer::put_MaxCount

ITuningSpaceContainer インターフェイス

システム上で許されるチューニング空間の最大数を設定する。

構文

HRESULT put_MaxCount(
    long MaxCount
    );

パラメータ

MaxCount
[in] チューニング空間の最大数を指定する Long 型変数。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpaceContainer::Remove

ITuningSpaceContainer インターフェイス

チューニング空間をシステムから完全に削除する。

構文

HRESULT Remove(
VARIANT Index
    );

パラメータ

Index
[in] システムから削除するチューニング空間のインデックス番号を指定する VARIANT 型変数。

戻り値

成功した場合は、S_OK を返す。指定されたチューニング空間が無効か、またはレジストリ内で破損している場合は、情報をすべて削除し、S_FALSE を返す。