SFBNetUtils

Wrapper Class for the INetUtils interface.

#include <SFBNetUtils.h.hpp>

class SFBNetUtils : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBNetUtils)

Inheritance diagram

Version

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

Reference

BREW API INetUtils

Member

Public Functions
`SFCError`	GetDefaultNetwork( `SInt16` family , `SInt32Ptr` network ) Return the default data network.
`SFCError`	GetPDPCount( `UInt16Ptr` count ) Return the number of Packet Data Profiles available on the device.
`SFCError`	GetPDPInfo( `UInt16` profile , `AEEPDPInfo *` info ) Return the profile information for a given Packet Data Profile number.
static `SFBNetUtilsSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBNetUtils instance.
static `SFBNetUtilsSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBNetUtils instance.
`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.

SFBNetUtils::GetDefaultNetwork

Return the default data network.

[ public ]
SFCError GetDefaultNetwork(
    SInt16 family       // the requested address family to be supported by the default network 
    SInt32Ptr network   // filled with the default data network (AEE_NETWORK_*) 
);

Return value

AEE_NET_SUCCESS: the default data network was filled in
AEE_EFAILED: operation failed.

Other error codes are also possible.

Description

Most applications will not need to get the default network.

Reference

BREW API INetUtils_GetDefaultNetwork

SFBNetUtils::GetPDPCount

Return the number of Packet Data Profiles available on the device.

[ public ]
SFCError GetPDPCount(
    UInt16Ptr count   // filled in with the PDP count 
);

Return value

AEE_NET_SUCCESS: if the count was filled in

Other error codes are also possible.

Description

In an UMTS device/network, there may be several networks configured and/or available.

The count of available networks may be determined at runtime using this function. This is useful for enumerating the networks via SFBNetUtils::GetPDPInfo().

Reference

BREW API INetUtils_GetPDPCount | SFBNetUtils::GetPDPInfo

SFBNetUtils::GetPDPInfo

Return the profile information for a given Packet Data Profile number.

[ public ]
SFCError GetPDPInfo(
    UInt16 profile      // the profile number of interest
    AEEPDPInfo * info   // filled in with the profile information 
);

Return value

AEE_NET_SUCCESS: the information was filled in
AEE_NET_EINVAL: the PDP number is not valid
AEE_EFAILED: operation failed

Other error codes are also possible

Description

In an UMTS device/network, there may be several networks configured and/or available.

The count of available networks may be determined at runtime using SFBNetUtils::GetPDPCount(). This is useful for enumerating the networks via this function.

Reference

BREW API INetUtils_GetPDPInfo | SFBNetUtils::GetPDPCount

SFBNetUtils::NewInstance

Create a new SFBNetUtils instance.

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

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