SFBQoSList

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

#include <SFBQoSList.h.hpp>

class SFBQoSList : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBQoSList)

継承図

バージョン

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

参照

BREW API IQoSList

メンバ

パブリック関数
`SFCError`	Add( `SFBQuerySmpConstRef` query ) リストの最後に新しいエントリを追加します。
`SFCError`	AddAt( `UInt32` index , `SFBQuerySmpConstRef` query ) インデックスパラメータとして指定されたインデックスに新しいエントリを加えます。
`Void`	Clear( `Void` ) リストをクリアして、メモリーを開放します。
`SInt32`	Find( `SFBQuerySmpConstRef` query ) リスト内のエントリのインデックスを返します。
`SFCError`	GetAt( `UInt32` index , `SFBQuerySmpConstRef` query ) インデックスにおけるリストのエントリを取得します。
static `SFBQoSListSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBQoSList インスタンスを生成します。
static `SFBQoSListSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBQoSList インスタンスを生成します。
`SFCError`	Remove( `SFBQuerySmpConstRef` query ) パラメータ query によってポイントされているエントリを削除します。
`SFCError`	RemoveAt( `UInt32` index ) インデックスにおけるエントリをリストから削除します。
`UInt32`	Size( `Void` ) リスト内のエントリの数を返します。
`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 インスタンスを使用して生成します。

SFBQoSList::Add

リストの最後に新しいエントリを追加します。

[ public ]
SFCError Add(
    SFBQuerySmpConstRef query   // リストに追加される新しいエントリへのポインタ
);

戻り値

成功したとき: SFERR_NO_ERROR
エントリポインタが無効のとき: SFERR_INVALID_PARAM
失敗したとき: SFERR_FAILED

参照

BREW API IQOSLIST_Add | SFBQoSList::AddAt

SFBQoSList::AddAt

インデックスパラメータとして指定されたインデックスに新しいエントリを加えます。

[ public ]
SFCError AddAt(
    UInt32 index                // 追加されるエントリの索引
    SFBQuerySmpConstRef query   // リストに追加される新しいエントリへのポインタ
);

戻り値

成功したとき: SFERR_NO_ERROR
インデックスが無効のとき: SFERR_INVALID_PARAM
失敗したとき: SFERR_FAILED

解説

インデックスは 0 を基準にしており、インデックスがリストのサイズ以上なら、新しいエントリがリストの最後に加えられます。

参照

BREW API IQOSLIST_AddAt | SFBQoSList::Add

SFBQoSList::Clear

リストをクリアして、メモリーを開放します。

[ public ]
Void Clear(Void);

参照

BREW API IQOSLIST_Clear

SFBQoSList::Find

リスト内のエントリのインデックスを返します。

[ public ]
SInt32 Find(
    SFBQuerySmpConstRef query   // リスト内で見つける必要のあるエントリへのポインタ
);

解説

戻されるインデックスは 0 を基準にしており、関数がリスト内にエントリを見つけられなかった場合、-1 が返されます。

参照

BREW API IQOSLIST_Find

SFBQoSList::GetAt

インデックスにおけるリストのエントリを取得します。

[ public ]
SFCError GetAt(
    UInt32 index                // エントリのインデックス
    SFBQuerySmpConstRef query   // リストに追加される新しいエントリへのポインタ
);

戻り値

成功したとき: SFERR_NO_ERROR
インデックスが無効のとき、または query が null のとき: SFERR_INVALID_PARAM
失敗したとき: SFERR_FAILED

解説

インデックスは 0 を基準にしており、インデックスがリストのサイズ以上の場合に、SFERR_INVALID_PARAM が返されます。

参照

BREW API IQOSLIST_GetAt

SFBQoSList::NewInstance

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

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

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

SFBQoSList::Remove

パラメータ query によってポイントされているエントリを削除します。

[ public ]
SFCError Remove(
    SFBQuerySmpConstRef query   // リストに追加される新しいエントリへのポインタ
);

戻り値

成功したとき: SFERR_NO_ERROR
エントリポインタが無効のとき: SFERR_INVALID_PARAM
失敗したとき: SFERR_FAILED

参照

BREW API IQOSLIST_Remove | SFBQoSList::RemoveAt

SFBQoSList::RemoveAt

インデックスにおけるエントリをリストから削除します。

[ public ]
SFCError RemoveAt(
    UInt32 index   // リストから削除されるエントリのインデックス
);

戻り値

成功したとき: SFERR_NO_ERROR
インデックスが無効のとき: SFERR_INVALID_PARAM
失敗したとき: SFERR_FAILED

解説

インデックスは 0 を基準にしており、インデックスがリストのサイズ以上の場合に、SFERR_INVALID_PARAM が返されます。

参照

BREW API IQOSLIST_RemoveAt | SFBQoSList::Remove

SFBQoSList::Size

リスト内のエントリの数を返します。

[ public ]
UInt32 Size(Void);

参照

BREW API IQOSLIST_Size