SFBWIFIOpts

Wrapper Class for the IWIFIOpts interface.

#include <SFBWIFIOpts.h.hpp>

class SFBWIFIOpts : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBWIFIOpts)

Inheritance diagram

Version

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

Reference

BREW API IWIFIOpts

Member

Public Functions
`SFCError`	AddOpt( `WIFIOpt *` wifiopt ) Adds an ID-Value pair to SFBWIFIOpts.
`SFCError`	GetOpt( `SInt32` optId , `WIFIOpt *` wifiopt ) Find the ID-value pair matching the specified ID.
static `SFBWIFIOptsSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBWIFIOpts instance.
static `SFBWIFIOptsSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBWIFIOpts instance.
`SFCError`	RemoveOpt( `SInt32` optId ) Remove the ID-value pair matching the specified ID.
`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.

SFBWIFIOpts::AddOpt

Adds an ID-Value pair to SFBWIFIOpts.

[ public ]
SFCError AddOpt(
    WIFIOpt * wifiopt   // WIFI option 
);

Return value

SUCCESS: If addition was successful.
ENOMEMORY: If enough memory couldn't be allocated
EBADPARM: If any of the input parameters is NULL.

Description

Only one value is allowed for each ID except for WEPKEY's which may contain up to 4.

Reference

BREW API IWIFIOpts_AddOpt

SFBWIFIOpts::GetOpt

Find the ID-value pair matching the specified ID.

[ public ]
SFCError GetOpt(
    SInt32 optId        // Option ID to search for
    WIFIOpt * wifiopt   // Reference to WIFIOpt where matching call option is copied
);

Return value

SUCCESS: If a matching call option is found.
EFAILED: Otherwise

Reference

BREW API IWIFIOpts_GetOpt

SFBWIFIOpts::NewInstance

Create a new SFBWIFIOpts instance.

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

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

SFBWIFIOpts::RemoveOpt

Remove the ID-value pair matching the specified ID.

[ public ]
SFCError RemoveOpt(
    SInt32 optId   // Option ID
);

Return value

SUCCESS: If remove was successful
EFAILED: If ID was not found

Reference

BREW API IWIFIOpts_RemoveOpt