SFBQoSFilter

Wrapper class for the IQoSFilter interface.

#include <SFBQoSFilter.h.hpp>

class SFBQoSFilter : public SFBWebOpts;

SFMTYPEDEFWRAPPER(SFBQoSFilter)

Inheritance diagram

Version

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

Reference

BREW API IQoSFilter

Member

Public Functions
`SFCError`	GetOpt( `SInt32` id , `AEEQoSFilterOpt*` opt ) Get the AEEQoSFilterOpt in the list of AEEQoSFilterOpts in the SFBQoSFilter instance with specified ID.
`SFCError`	GetOptAtIndex( `SInt32` index , `AEEQoSFilterOpt*` opt ) Get the AEEQoSFilterOpt in the list of AEEQoSFilterOpts in the SFBQoSFilter instance at specified index.
static `SFBQoSFilterSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBQoSFilter instance.
static `SFBQoSFilterSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBQoSFilter instance.
`SFCError`	RemoveOpt( `SInt32` id ) Removes the AEEQoSFilterOpt matching id.
`SFCError`	RemoveOptAtIndex( `SInt32` index ) Removes the AEEQoSFilterOpt at index.
`SFCError`	AddOpt( `WebOptPtr` opts ) (inherits from SFBWebOpts) Add the list of WebOpts to the current web option set.
`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.

SFBQoSFilter::GetOpt

Get the AEEQoSFilterOpt in the list of AEEQoSFilterOpts in the SFBQoSFilter instance with specified ID.

[ public ]
SFCError GetOpt(
    SInt32 id              // id of the option to find in the options list
    AEEQoSFilterOpt* opt   // placeholder for the requested AEEQoSFilterOpt
);

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

BREW API IQOSFILTER_GetOpt

SFBQoSFilter::GetOptAtIndex

Get the AEEQoSFilterOpt in the list of AEEQoSFilterOpts in the SFBQoSFilter instance at specified index.

[ public ]
SFCError GetOptAtIndex(
    SInt32 index           // option index
    AEEQoSFilterOpt* opt   // placeholder for the requested AEEQoSFilterOpt 
);

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

BREW API IQOSFILTER_GetOptAtIndex

SFBQoSFilter::NewInstance

Create a new SFBQoSFilter instance.

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

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

SFBQoSFilter::RemoveOpt

Removes the AEEQoSFilterOpt matching id.

[ public ]
SFCError RemoveOpt(
    SInt32 id   // id of the option to remove from the options list
);

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

BREW API IQOSFILTER_RemoveOpt

SFBQoSFilter::RemoveOptAtIndex

Removes the AEEQoSFilterOpt at index.

[ public ]
SFCError RemoveOptAtIndex(
    SInt32 index   // id of the option to remove from the options list
);

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

BREW API IQOSFILTER_RemoveOptAtIndex