SFBxOpts

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

#include <SFBxOpts.h.hpp>

class SFBxOpts : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBxOpts)

継承図

バージョン

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

参照

BREW API IxOpts

メンバ

パブリック関数
`SFCError`	AddOpt( `xOpt *` opts ) xOpt のリストを現在のオプションセットに追加します。
`SFCError`	GetOpt( `SInt32` id , `SInt32` index , `xOpt *` opt ) id に一致する xOpts の xOpts リストで、 xOpt を検索します。
static `SFBxOptsSmp`	NewInstance( `SFCErrorPtr` exception = null ) NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBxOpts クラスのインスタンスを生成します。
`SFCError`	RemoveOpt( `SInt32` id , `SInt32` index ) id に一致する index 番目の xOpt を削除します。
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (SFBQuery から継承) QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。

SFBxOpts::AddOpt

xOpt のリストを現在のオプションセットに追加します。

[ public ]
SFCError AddOpt(
    xOpt * opts   // xOpt 構造体の配列で、nId が XOPT_END に設定された xOpt で終端する
);

戻り値

AEE_SUCCESS: オプションが正常に追加された場合。
AEE_ENOMEMORY: 十分なメモリが割り当てられなかった場合。

参照

BREW API IxOpts_AddOpt

SFBxOpts::GetOpt

id に一致する xOpts の xOpts リストで、 xOpt を検索します。

[ public ]
SFCError GetOpt(
    SInt32 id      // オプションリストで見つけるオプションの ID。 XOPT_ANY 存在する場合は、nIndexth オプションを返す。 
    SInt32 index   // (同じ ID の複数の xOpts がある場合)、最後にAddOpt()edされたオプションから nIndex 番目のものを取得する。 これはゼロ基準。 
    xOpt * opt     // 見つかった xOpt を追加する位置。 
);

戻り値

AEE_SUCCESS: 正常終了してオプションが追加された。
AEE_EFAILED: 指定された xOpt が見つからなかった。
AEE_EBADPARM: pItem が NULL。

参照

BREW API IxOpts_GetOpt

SFBxOpts::NewInstance

SFBxOpts クラスのインスタンスを生成します。

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

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

SFBxOpts::RemoveOpt

id に一致する index 番目の xOpt を削除します。

[ public ]
SFCError RemoveOpt(
    SInt32 id      // オプションリストから削除するオプションの ID
    SInt32 index   // (同じ ID の複数の xOpts がある場合)、最後にAddOpt()されたオプションから index 番目のものを削除する。
);

戻り値

AEE_SUCCESS: 正常終了してオプションが追加された。
AEE_EFAILED: 指定された xOpt が見つからなかった。

参照

BREW API IxOpts_RemoveOpt