SFBWebOpts

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

#include <SFBWebOpts.h.hpp>

class SFBWebOpts : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBWebOpts)

継承図

バージョン

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

参照

BREW API IWebOpts

メンバ

パブリック関数
`SFCError`	AddOpt( `WebOptPtr` opts ) 入力配列を現在の Web オプションリストに追加して、Web のリストを現在の Web オプションセットに追加します。
`SFCError`	GetOpt( `SInt32` id , `SInt32` index , `WebOptPtr` opt ) SFBWebOpts インスタンス内の WebOpts リストから、指定した WebOpt ID に一致する WebOpt を取得します。
static `SFBWebOptsSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBWebOpts インターフェースのインスタンスを生成します。
static `SFBWebOptsSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBWebOpts インターフェースのインスタンスを生成します。
`SFCError`	RemoveOpt( `SInt32` id , `SInt32` index ) id に一致する index 番目の WebOpt を削除します。
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFCError`	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 から継承) オブジェクトを単一インターフェースで実装するときに使います。

プロテクト関数
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを生成します。
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBWebOpts::AddOpt

入力配列を現在の Web オプションリストに追加して、Web のリストを現在の Web オプションセットに追加します。

[ public ]
SFCError AddOpt(
    WebOptPtr opts   // WebOpt 構造体の配列
                     // nId が WEBOPT_END に設定された WebOpt で終結する
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY

参照

BREW API IWEBOPTS_AddOpt | WebOpt | SFBWebOpts::RemoveOpt | SFBWebOpts::GetOpt

SFBWebOpts::GetOpt

SFBWebOpts インスタンス内の WebOpts リストから、指定した WebOpt ID に一致する WebOpt を取得します。

[ public ]
SFCError GetOpt(
    SInt32 id       // オプションリスト内で検索するオプションの ID
                    // WEBOPT_ANY は、index 番目のオプションを返す( ある場合 )
    SInt32 index    // 同じ ID の複数 WebOpts に追加された最後の AddOpt() オプションからのインデックス
    WebOptPtr opt   // 見つかった WebOpt を格納する場所
);

戻り値

成功したとき: SFERR_NO_ERROR
引数が不正なとき: SFERR_INVALID_PARAM
失敗したとき: SFERR_FAILED

参照

BREW API IWEBOPTS_GetOpt | WebOpt | SFBWebOpts::AddOpt

SFBWebOpts::NewInstance

SFBWebOpts インターフェースのインスタンスを生成します。

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

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

SFBWebOpts::RemoveOpt

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

[ public ]
SFCError RemoveOpt(
    SInt32 id      // オプションリストから削除するオプションの ID
    SInt32 index   // 削除する、同じ ID を持った複数 WebOpts の最後の AddOpt() オプションのインデックス
);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: SFERR_FAILED

参照

BREW API IWEBOPTS_RemoveOpt | SFBWebOpts::AddOpt