CApUtils Class Reference

#include <mw/ApUtils.h>

Link against: APEngine.lib

class CApUtils : public CBase

Inherits from

  • CApUtils
    Public Member Functions
    virtual ~CApUtils()
    IMPORT_C TApBearerTypeBearerTypeL(TUint32)
    IMPORT_C TBoolDoHasMandatoryFieldsFilledL(TUint32, CCommsDbTableView *, TApBearerType)
    IMPORT_C TBoolHasMandatoryFieldsFilledL(TUint32)
    TBool HasWlanSSIDL(TUint32)
    IMPORT_C TBoolIAPExistsL(TUint32)
    IMPORT_C voidISPTypeL(TUint32, TCommsDbIspType &)
    IMPORT_C TUint32IapIdFromWapIdL(TUint32)
    IMPORT_C TBoolIsAPInUseL(TUint32)
    IMPORT_C TBoolIsReadOnlyL(TUint32)
    IMPORT_C TBoolIsValidNameL(const TDesC &)
    IMPORT_C TBoolIsValidNameL(const TDesC &, TUint32)
    TBool IsWlanL(TUint32)
    IMPORT_C TBoolMakeValidNameL(TDes &)
    IMPORT_C voidNameL(TUint32, TDes &)
    IMPORT_C CApUtils *NewLC(CCommsDatabase &)
    IMPORT_C voidSetISPTypeL(TUint32, TCommsDbIspType)
    IMPORT_C voidSetNameL(TDes &, TUint32)
    IMPORT_C TBoolWapApExistsL(TUint32)
    IMPORT_C voidWapBearerTypeL(TUint32, TDes &)
    IMPORT_C TUint32WapIdFromIapIdL(TUint32)
    Protected Member Functions
    CApUtils()
    IMPORT_C voidConstructL(CCommsDatabase &)
    TApBearerType DoBearerTypeL(TUint32)
    voidDoISPTypeL(TUint32, TCommsDbIspType &)
    TBool DoIsWlanL(TUint32)
    voidDoNameL(TUint32, TDes &)
    voidDoSetISPTypeL(TUint32, TCommsDbIspType)
    voidDoSetNameL(TDes &, TUint32)
    voidDoWapBearerTypeL(TUint32, TDes &)
    TBool DoesExistsL(TPtrC, TUint32)
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

    Representation of access point utilities. Provides utilities to access points for clients. Encapsulates database handling. This class provides utility functions for clients that need some specific information or parameters from (maybe more than one) AP. It is provided for ease of use so clients do not have to work with CApDataHandler's concept (one object-one Uid).

    Constructor & Destructor Documentation

    CApUtils ( )

    IMPORT_CCApUtils()[protected]

    C++ default constructor.

    Deprecated

    ~CApUtils ( )

    IMPORT_C~CApUtils()[virtual]

    Destructor.

    Deprecated

    Member Function Documentation

    BearerTypeL ( TUint32 )

    IMPORT_C TApBearerTypeBearerTypeL(TUint32aUid)

    Gets the bearer type of a given access point. Leaves on error. Deprecated

    ParameterDescription
    aUidThe UID of the access point.

    Returns: The type of the bearer.

    ConstructL ( CCommsDatabase & )

    IMPORT_C voidConstructL(CCommsDatabase &aDb)[protected]

    Second-phase constructor.

    Deprecated

    DoBearerTypeL ( TUint32 )

    TApBearerType DoBearerTypeL(TUint32aUid)[protected]

    Gets the bearer type of a given access point. Leaves on error.

    ParameterDescription
    aUidThe UID of the access point.

    Returns: The type of the bearer.

    DoHasMandatoryFieldsFilledL ( TUint32, CCommsDbTableView *, TApBearerType )

    IMPORT_C TBoolDoHasMandatoryFieldsFilledL(TUint32aUid,
    CCommsDbTableView *aWapt = NULL,
    TApBearerTypeaBearertype = EApBearerTypeAllBearers
    )

    Returns whether the access point has the WAP-mandatory fields filled or not. Deprecated

    ParameterDescription
    aUidThe UID of the access point

    Returns: TBool Are the WAP-mandatory fields filled in the access point?

    DoISPTypeL ( TUint32, TCommsDbIspType & )

    voidDoISPTypeL(TUint32aUid,
    TCommsDbIspType &aIspType
    )[protected]

    Indicates the ISP type of a given access point.

    ParameterDescription
    aUidThe UID of the access point.
    aIspTypeA reference to a TCommsDbIspType to hold the value

    Returns: No return value.

    DoIsWlanL ( TUint32 )

    TBool DoIsWlanL(TUint32aLanCommdbId)[protected]

    Wrapper for public API. Determines whether a given LAN_SERVICE commsdb id is linked to a WLAN data (thus is it a WLAN) or not.

    Returns: Boolean indicating if it is WLAN or not.

    DoNameL ( TUint32, TDes & )

    voidDoNameL(TUint32aUid,
    TDes &aName
    )[protected]

    Reads the Name of a given access point

    ParameterDescription
    aUidThe UID of the access point.

    Returns: no return value. Passed descriptor MUST be large enough to hold the new data, otherwise leaves with KErrDescOverflow.

    DoSetISPTypeL ( TUint32, TCommsDbIspType )

    voidDoSetISPTypeL(TUint32aUid,
    TCommsDbIspTypeaIspType
    )[protected]

    Sets the ISP type for a given access point

    ParameterDescription
    aUidThe UID of the access point
    aIspTypeThe desired Isp type of the access point

    Returns: no return value.

    DoSetNameL ( TDes &, TUint32 )

    voidDoSetNameL(TDes &aName,
    TUint32aUid
    )[protected]

    Sets the Name of a given access point Name is validated and modified if needed. Passed aName buffer MUST be large enough to hold the modified name.

    ParameterDescription
    aNameA reference to the name of the access point. The given name is returned in it.
    aUidThe UID of the access point.

    Returns: no return value.

    DoWapBearerTypeL ( TUint32, TDes & )

    voidDoWapBearerTypeL(TUint32aUid,
    TDes &aBearer
    )[protected]

    Indicates the WAP bearer type of a given access point. Passed descriptor MUST be large enough to hold the new data, otherwise leaves with KErrDescOverflow. The maximum length is the maximum length of a 'normal' text fields length in Comms DB, KCommsDbSvrMaxFieldLength, which is defined in cdblen.h.

    ParameterDescription
    aUidThe UID of the access point.
    aBearerA reference to a TBearer to hold the bearer type of the access point.

    Returns: no return value.

    DoesExistsL ( TPtrC, TUint32 )

    TBool DoesExistsL(TPtrCaTable,
    TUint32aUid
    )[protected]

    Returns in a TBool whether the record identified by the passed aUid exists or not in the table identified by the passed table name.

    ParameterDescription
    aTableThe name of the table to check
    aUidThe UID to check for

    Returns: TBool indicating whether the record with the given ID exists in the given table or not.

    HasMandatoryFieldsFilledL ( TUint32 )

    IMPORT_C TBoolHasMandatoryFieldsFilledL(TUint32aUid)

    Returns whether the access point has the WAP-mandatory fields filled or not. Starts a transaction which is 'internal' to ApEngine if client not started one. Deprecated

    ParameterDescription
    aUidThe UID of the access point

    Returns: TBool Are the WAP-mandatory fields filled in the access point?

    HasWlanSSIDL ( TUint32 )

    TBool HasWlanSSIDL(TUint32aLanCommdbId)

    Determines whether a given LAN_SERVICE commsdb id which is linked to a WLAN data (thus is it a WLAN) has a valid SSID or it is empty

    Returns: Boolean indicating if it has WLAN SSID or not.

    IAPExistsL ( TUint32 )

    IMPORT_C TBoolIAPExistsL(TUint32aUid)

    Returns in a TBool whether the internet access point part identified by the passed aUid exists or not. param aUid the internet access point ID to check for (NOT equals to Wap access point ID). return TBool indicating whether an internet access point with the given ID exists or not.

    Deprecated

    ISPTypeL ( TUint32, TCommsDbIspType & )

    IMPORT_C voidISPTypeL(TUint32aUid,
    TCommsDbIspType &aIspType
    )

    Indicates the ISP type of a given access point. Deprecated

    ParameterDescription
    aUidThe UID of the access point.
    aIspTypeA reference to a TCommsDbIspType to hold the value

    Returns: No return value.

    IapIdFromWapIdL ( TUint32 )

    IMPORT_C TUint32IapIdFromWapIdL(TUint32aUid)

    Gets the Iap record ID for a given access point ID Deprecated

    ParameterDescription
    aUidThe UID of the access point

    Returns: The Iap record ID.

    IsAPInUseL ( TUint32 )

    IMPORT_C TBoolIsAPInUseL(TUint32aUid)

    Indicates whether a given access point is in use or not. If access point does not exists, return value is TRUE Deprecated

    ParameterDescription
    aUidThe UID of the access point.

    Returns: Boolean indicating if it is in use (if used, TRUE)

    IsReadOnlyL ( TUint32 )

    IMPORT_C TBoolIsReadOnlyL(TUint32aUid)

    Determines whether a given AP is read-only or not. Deprecated

    ParameterDescription
    aUidA UID to look for

    Returns: Boolean indicating if it is read-only or not.

    IsValidNameL ( const TDesC & )

    IMPORT_C TBoolIsValidNameL(const TDesC &aNameText)

    Indicates whether a given name is valid or not. Deprecated

    ParameterDescription
    aNameTextThe name to check.

    Returns: Boolean indicating if it is valid or not.

    IsValidNameL ( const TDesC &, TUint32 )

    IMPORT_C TBoolIsValidNameL(const TDesC &aNameText,
    TUint32aAcceptUid
    )

    Indicates whether a given name is valid or not. The name is valid if none, or only the aAcceptUid AP has it. Deprecated

    ParameterDescription
    aNameTextThe name to check.
    aAcceptUidA UID to accept with this name

    Returns: Boolean indicating if it is valid or not.

    IsWlanL ( TUint32 )

    TBool IsWlanL(TUint32aLanCommdbId)

    Determines whether a given LAN_SERVICE commsdb id is linked to a WLAN data (thus is it a WLAN) or not.

    Returns: Boolean indicating if it is WLAN or not.

    MakeValidNameL ( TDes & )

    IMPORT_C TBoolMakeValidNameL(TDes &aNameText)

    TBool CApUtils::MakeValidNameL(TDes& aNameText); Creates a valid name based on the given one. Deprecated

    ParameterDescription
    aNameTextThe name to use for creating a valid name. The new name is returned in it, too.

    Returns: Whether the name was changed or not

    NameL ( TUint32, TDes & )

    IMPORT_C voidNameL(TUint32aUid,
    TDes &aName
    )

    Reads the Name of a given access point Deprecated

    ParameterDescription
    aUidThe UID of the access point.

    Returns: no return value. Passed descriptor MUST be large enough to hold the new data, otherwise leaves with KErrDescOverflow.

    NewLC ( CCommsDatabase & )

    IMPORT_C CApUtils *NewLC(CCommsDatabase &aDb)[static]

    Two-phased constructor. Leaves on failure, places instance on cleanup stack. Deprecated

    ParameterDescription
    aDba reference to a CCommsDataBase object.

    Returns: The constructed CApUtils.

    SetISPTypeL ( TUint32, TCommsDbIspType )

    IMPORT_C voidSetISPTypeL(TUint32aUid,
    TCommsDbIspTypeaIspType
    )

    Sets the ISP type for a given access point Deprecated

    ParameterDescription
    aUidThe UID of the access point
    aIspTypeThe desired Isp type of the access point

    Returns: no return value.

    SetNameL ( TDes &, TUint32 )

    IMPORT_C voidSetNameL(TDes &aName,
    TUint32aUid
    )

    Sets the Name of a given access point Name is validated and modified if needed. Passed aName buffer MUST be large enough to hold the modified name. Deprecated

    ParameterDescription
    aNameA reference to the name of the access point. The given name is returned in it.
    aUidThe UID of the access point.

    Returns: no return value.

    WapApExistsL ( TUint32 )

    IMPORT_C TBoolWapApExistsL(TUint32aUid)

    Returns in a TBool whether the access point identified by the passed aUid exists or not. Deprecated

    ParameterDescription
    aUidthe access point ID to check for.(Wap access point ID).

    Returns: TBool indicating whether an access point with the given ID exists or not.

    WapBearerTypeL ( TUint32, TDes & )

    IMPORT_C voidWapBearerTypeL(TUint32aUid,
    TDes &aBearer
    )

    Indicates the WAP bearer type of a given access point. Passed descriptor MUST be large enough to hold the new data, otherwise leaves with KErrDescOverflow. The maximum length is the maximum length of a 'normal' text fields length in Comms DB, KCommsDbSvrMaxFieldLength, which is defined in cdblen.h. Deprecated

    ParameterDescription
    aUidThe UID of the access point.
    aBearerA reference to a TBearer to hold the bearer type of the access point.

    Returns: no return value.

    WapIdFromIapIdL ( TUint32 )

    IMPORT_C TUint32WapIdFromIapIdL(TUint32aUid)

    Gets the Wap record ID for a given Iap record ID Deprecated

    ParameterDescription
    aUidThe UID of the Iap

    Returns: The Wap access point ID.

    © Nokia 2011.