epoc32/include/comms-infras/ss_connsettings.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
//
williamr@4
    15
williamr@4
    16
/**
williamr@4
    17
 @file 
williamr@4
    18
 @internalTechnology 
williamr@4
    19
*/
williamr@4
    20
williamr@4
    21
#if !defined(__SS_CONNSETTINGS_H__)
williamr@4
    22
#define __SS_CONNSETTINGS_H__
williamr@4
    23
williamr@4
    24
#include <e32def.h>
williamr@4
    25
#include <e32base.h>
williamr@4
    26
williamr@4
    27
/**
williamr@4
    28
 Base class that any client wishing to access underlying comms database settings
williamr@4
    29
 @internalTechnology
williamr@4
    30
 @released Since 9.1
williamr@4
    31
 @see CConnectionProvider
williamr@4
    32
 */
williamr@4
    33
class CConnectionSettings : public CBase
williamr@4
    34
	{
williamr@4
    35
public:
williamr@4
    36
	IMPORT_C CConnectionSettings();
williamr@4
    37
	
williamr@4
    38
	IMPORT_C void GetBoolSettingL(const TDesC& aSettingName, TBool& aValue, const RMessagePtr2* aMessage );
williamr@4
    39
	IMPORT_C void GetDes16SettingL(const TDesC& aSettingName, TDes16& aValue, const RMessagePtr2* aMessage );
williamr@4
    40
	IMPORT_C void GetDes8SettingL(const TDesC& aSettingName, TDes8& aValue, const RMessagePtr2* aMessage );
williamr@4
    41
	IMPORT_C void GetIntSettingL(const TDesC& aSettingName, TUint32& aValue, const RMessagePtr2* aMessage );
williamr@4
    42
	IMPORT_C HBufC* GetLongDesSettingLC(const TDesC& aSettingName, const RMessagePtr2* aMessage );
williamr@4
    43
williamr@4
    44
protected:
williamr@4
    45
	/**
williamr@4
    46
	 Override this to retrieve a boolean value from the database with the given field name
williamr@4
    47
	 
williamr@4
    48
	 @param aSettingName Field name
williamr@4
    49
	 @param aValue Reference to a boolean that will contain the value on call success
williamr@4
    50
	 @param aMessage RMessage pointer required for secure session communication
williamr@4
    51
	 */
williamr@4
    52
	virtual void DoGetBoolSettingL(const TDesC& aSettingName, TBool& aValue, const RMessagePtr2* aMessage ) = 0;
williamr@4
    53
	
williamr@4
    54
	/**
williamr@4
    55
	 Override this to retrieve a unicode string value from the database with the given field name
williamr@4
    56
	 
williamr@4
    57
	 @param aSettingName Field name
williamr@4
    58
	 @param aValue Reference to a string that will contain the value on call success
williamr@4
    59
	 @param aMessage RMessage pointer required for secure session communication
williamr@4
    60
	 */
williamr@4
    61
	virtual void DoGetDes16SettingL(const TDesC& aSettingName, TDes16& aValue, const RMessagePtr2* aMessage ) = 0;
williamr@4
    62
	
williamr@4
    63
	/**
williamr@4
    64
	 Override this to retrieve a 8-bit string value from the database with the given field name
williamr@4
    65
	 
williamr@4
    66
	 @param aSettingName Field name
williamr@4
    67
	 @param aValue Reference to a string that will contain the value on call success
williamr@4
    68
	 @param aMessage RMessage pointer required for secure session communication
williamr@4
    69
	 */
williamr@4
    70
	virtual void DoGetDes8SettingL(const TDesC& aSettingName, TDes8& aValue, const RMessagePtr2* aMessage ) = 0;
williamr@4
    71
	
williamr@4
    72
	/**
williamr@4
    73
	 Override this to retrieve a unsigned 32-bit int value from the database with the given field name
williamr@4
    74
	 
williamr@4
    75
	 @param aSettingName Field name
williamr@4
    76
	 @param aValue Reference to a TUint32 that will contain the value on call success
williamr@4
    77
	 @param aMessage RMessage pointer required for secure session communication
williamr@4
    78
	 */	
williamr@4
    79
	virtual void DoGetIntSettingL(const TDesC& aSettingName, TUint32& aValue, const RMessagePtr2* aMessage ) = 0;
williamr@4
    80
	
williamr@4
    81
	/**
williamr@4
    82
	 Override this to retrieve a string value as a heap allocated buffer from the database with the given field name
williamr@4
    83
	 
williamr@4
    84
	 @param aSettingName Field name	 
williamr@4
    85
	 @param aMessage RMessage pointer required for secure session communication
williamr@4
    86
	 @return Pointer to the dynamically allocated string
williamr@4
    87
	 */
williamr@4
    88
	virtual HBufC* DoGetLongDesSettingLC(const TDesC& aSettingName, const RMessagePtr2* aMessage ) = 0;
williamr@4
    89
	};
williamr@4
    90
	
williamr@4
    91
#endif	// __SS_CONNSETTINGS_H__
williamr@4
    92