SFBParameters

IParameters インターフェースのラッパークラスです。

#include <SFBParameters.h.hpp>

class SFBParameters : public SFBParametersRO;

SFMTYPEDEFWRAPPER(SFBParameters)

継承図

バージョン

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
×	×	×	○

参照

BREW API IParameters

メンバ

パブリック関数
static `SFBParametersSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBParameters インスタンスを生成します。
static `SFBParametersSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBParameters インスタンスを生成します。
`SFCError`	SetParam( `SInt32` id , `VoidConstPtr` data , `UInt32` length ) このメソッドはパラメータ値を設定します。
`SFCError`	SetParam( `SInt32` id , `SFXBufferConstRef` data ) このメソッドはパラメータ値を設定します。
`SFCError`	SetParam( `SInt32` id , `SFXAnsiStringConstRef` data ) このメソッドはパラメータ値を設定します。

SFBParameters::NewInstance

SFBParameters インスタンスを生成します。

[ public, static ]
SFBParametersSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

[ public, static ]
SFBParametersSmp NewInstance(
    AEECLSID id                    // クラスID
    SFCErrorPtr exception = null   // エラー値
);

SFBParameters::SetParam

このメソッドはパラメータ値を設定します。

[ public ]
SFCError SetParam(
    SInt32 id           // 設定するパラメータ
    VoidConstPtr data   // 設定するデータ／バッファへのポインタ
    UInt32 length       // data が指すデータのサイズ
);

[ public ]
SFCError SetParam(
    SInt32 id                // 設定するパラメータ
    SFXBufferConstRef data   // 設定するデータ／バッファへのポインタ
);

[ public ]
SFCError SetParam(
    SInt32 id                    // 設定するパラメータ
    SFXAnsiStringConstRef data   // 設定するデータ／バッファへのポインタ
);

戻り値

AEE_SUCCESS: データがコピーされた場合。
AEE_ENOSUCH: パラメータ ID が不明の場合。
AEE_EREADONLY: パラメータを取得できるが、設定はできない。
AEE_ENOMEMORY: パラメータを格納するためのヒープメモリーを割り当てできない。

実装またはパラメータタイプに応じたその他の値が戻ることもある。

解説

標準の動作は、data が指しているデータをコピーすることです。length で指定した数のバイトがコピーされます。

コール側は、データがコピーされたと想定でき、それ以上データの寿命を管理する必要はありません。

参照

BREW API IParameters_SetParam