SFBWIFI

Wrapper Class for the IWIFI interface.

#include <SFBWIFI.h.hpp>

class SFBWIFI : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBWIFI)

Inheritance diagram

Version

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

Reference

BREW API IWIFI

Member

Public Functions
`SFCError`	CommitOptions( `UInt32` id , `SFBWIFIOptsSmpConstRef` options ) Stores the options for a given profile.
`SFCError`	EnumNextProfile( `UInt32Ptr` id ) Returns next stored profile ID if any.
`SFCError`	EnumProfileInit( `Void` ) Resets the SFBWIFI’s internal profile enumeration.
`SFCError`	GetStatistics( `AEEWIFIStatistics *` statistics ) Gets the current Statistics for 802.11 activity.
`SFCError`	LoadOptions( `UInt32` id , `SFBWIFIOptsSmpRef` options ) Loads the options for the given profile id into an IWIFIOpts object.
static `SFBWIFISmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new instance of
static `SFBWIFISmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new instance of
`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.

SFBWIFI::CommitOptions

Stores the options for a given profile.

[ public ]
SFCError CommitOptions(
    UInt32 id                        // Profile ID to get.
    SFBWIFIOptsSmpConstRef options   // Options associated with the given ID.
);

Return value

AEE_SUCCESS: If the options were saved succesfully.
EBADPARM: If ID or options are out of range.
EUNSUPPORTED: Used if we do not support multiple profiles.
ENOTALLOWED: Application does not have permission to change one of options present.
EFAILED: Otherwise.

Reference

BREW API IWIFI_CommitOptions

SFBWIFI::EnumNextProfile

Returns next stored profile ID if any.

[ public ]
SFCError EnumNextProfile(
    UInt32Ptr id   // Pointer to profile id 
);

Return value

AEE_SUCCESS: Valid profile id was returned.
EBADPARM: If any of the parameters are NULL.
EFAILED: All profile ids have been returned in previous calls or an error occured.

Reference

BREW API IWIFI_EnumNextProfile

SFBWIFI::EnumProfileInit

Resets the SFBWIFI’s internal profile enumeration.

[ public ]
SFCError EnumProfileInit(Void);

Return value

AEE_SUCCESS: If enumeration of profiles is allowed.
EFAILED: Unspecified internal failure.

Reference

BREW API IWIFI_EnumProfileInit

SFBWIFI::GetStatistics

Gets the current Statistics for 802.11 activity.

[ public ]
SFCError GetStatistics(
    AEEWIFIStatistics * statistics   // Buffer to be filled in with the statistics
);

Return value

AEE_SUCCESS: If the statictics buffer was filled.
EBADPARM: If the statistics buffer is not provided.
EFAILED: Unspecified failure.

Reference

BREW API IWIFI_GetStatistics

SFBWIFI::LoadOptions

Loads the options for the given profile id into an IWIFIOpts object.

[ public ]
SFCError LoadOptions(
    UInt32 id                   // Profile ID to get 
    SFBWIFIOptsSmpRef options   // Options associated with the given ID 
);

Return value

AEE_SUCCESS: If a set of options was found for the given ID.
ENOSUCH: If a set of options with the given ID does not exist.
EBADPARM: If ID or options are out of range. ENOMEMORY If there is not enough heap memory to complete the operation.
EUNSUPPORTED: Used if we do not support multiple profiles.
EFAILED: Otherwise.

Reference

BREW API IWIFI_LoadOptions

SFBWIFI::NewInstance

Create a new instance of

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

[ public, static ]
SFBWIFISmp NewInstance(
    AEECLSID id                    // 
    SFCErrorPtr exception = null   // 
);

Argument

exception: ... exception の説明 ...

Return value

*** description of return value ***

Description

*** description ***

Example

*** example ***

Reference

*** write xref link ***