SFBQoSList

Wrapper class for the IQoSList interface.

#include <SFBQoSList.h.hpp>

class SFBQoSList : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBQoSList)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	O	O

Reference

BREW API IQoSList

Member

Public Functions
`SFCError`	Add( `SFBQuerySmpConstRef` query ) Add new entry at the end of the list.
`SFCError`	AddAt( `UInt32` index , `SFBQuerySmpConstRef` query ) Add new entry at the index that is specified by index.
`Void`	Clear( `Void` ) Clear the list, release the memory.
`SInt32`	Find( `SFBQuerySmpConstRef` query ) Return the index of an entry in the list.
`SFCError`	GetAt( `UInt32` index , `SFBQuerySmpConstRef` query ) Return the entry specified by index from the list.
static `SFBQoSListSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBQoSList instance.
static `SFBQoSListSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBQoSList instance.
`SFCError`	Remove( `SFBQuerySmpConstRef` query ) Remove the entry pointed by the parameter query.
`SFCError`	RemoveAt( `UInt32` index ) Removes the entry that is specified by "index" from the list.
`UInt32`	Size( `Void` ) Return the number of the entries in the list.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBQoSList::Add

Add new entry at the end of the list.

[ public ]
SFCError Add(
    SFBQuerySmpConstRef query   // the pointer to the new entry that will be added to the list
);

Return value

If succeeds: SFERR_NO_ERROR
The entry pointer is invalid: SFERR_INVALID_PARAM
If failed: SFERR_FAILED

Reference

BREW API IQOSLIST_Add | SFBQoSList::AddAt

SFBQoSList::AddAt

Add new entry at the index that is specified by index.

[ public ]
SFCError AddAt(
    UInt32 index                // the index where the entry will be added
    SFBQuerySmpConstRef query   // pointer to the entry that will be added to the list
);

Return value

If succeeds: SFERR_NO_ERROR
The index is invalid: SFERR_INVALID_PARAM
If failed: SFERR_FAILED

Description

The index is zero based, if the index is greater than or equal to the size of the list then the new entry will be added at the end of the list.

Reference

BREW API IQOSLIST_AddAt | SFBQoSList::Add

SFBQoSList::Clear

Clear the list, release the memory.

[ public ]
Void Clear(Void);

Reference

BREW API IQOSLIST_Clear

SFBQoSList::Find

Return the index of an entry in the list.

[ public ]
SInt32 Find(
    SFBQuerySmpConstRef query   // pointer to the entry that the user wants to find in the list
);

Description

The index that will be returned is zero based. If the entry wasn't found in the list, it returns -1.

Reference

BREW API IQOSLIST_Find

SFBQoSList::GetAt

Return the entry specified by index from the list.

[ public ]
SFCError GetAt(
    UInt32 index                // the index of the entry that will be returned.
    SFBQuerySmpConstRef query   // on return points to the requested entry in the list
);

Return value

If succeeds: SFERR_NO_ERROR
The index is invalid, or the query is null: SFERR_INVALID_PARAM
If failed: SFERR_FAILED

Description

The index is zero based, if the index is greater than or equal to the size of the list then SFERR_INVALID_PARAM is returned.

Reference

BREW API IQOSLIST_GetAt

SFBQoSList::NewInstance

Create a new SFBQoSList instance.

[ public, static ]
SFBQoSListSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBQoSListSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBQoSList::Remove

Remove the entry pointed by the parameter query.

[ public ]
SFCError Remove(
    SFBQuerySmpConstRef query   // the pointer to the entry that will be removed from the list
);

Return value

If succeeds: SFERR_NO_ERROR
The entry pointer is invalid: SFERR_INVALID_PARAM
If failed: SFERR_FAILED

Reference

BREW API IQOSLIST_Remove | SFBQoSList::RemoveAt

SFBQoSList::RemoveAt

Removes the entry that is specified by "index" from the list.

[ public ]
SFCError RemoveAt(
    UInt32 index   // the index of the entry that will be removed from the list.
);

Return value

If succeeds: SFERR_NO_ERROR
The index is invalid: SFERR_INVALID_PARAM
If failed: SFERR_FAILED

Description

The index is zero based, if the index is greater than or equal to the size of the list then SFERR_INVALID_PARAM is returned.

Reference

BREW API IQOSLIST_RemoveAt | SFBQoSList::Remove

SFBQoSList::Size

Return the number of the entries in the list.

[ public ]
UInt32 Size(Void);

Return value

Return the number of the entries in the list.

Reference

BREW API IQOSLIST_Size