epoc32/include/mw/sdpcodecstringpool.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/sdpcodecstringpool.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,88 @@
     1.4 +/*
     1.5 +* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:
    1.18 +* Name          : SdpCodecStringPool.h
    1.19 +* Part of       : SDP Codec
    1.20 +* Interface     : SDK API, SDP Codec API
    1.21 +* Version       : 1.0
    1.22 +*
    1.23 +*/
    1.24 +
    1.25 +
    1.26 +
    1.27 +#ifndef SDPCODECSTRINGPOOL_H
    1.28 +#define SDPCODECSTRINGPOOL_H
    1.29 +
    1.30 +//  INCLUDES
    1.31 +#include <e32base.h>
    1.32 +#include "_sdpdefs.h"
    1.33 +#include <stringpool.h>
    1.34 +
    1.35 +class CSdpCodecStringPool;
    1.36 +
    1.37 +// CLASS DECLARATION
    1.38 +/**
    1.39 +* @publishedAll
    1.40 +* @released
    1.41 +*
    1.42 +* This class defines string pool for SDP Codec.
    1.43 +* The client of SDP Codec must call OpenL() before 
    1.44 +* invoking any function of SDP Codec classes.
    1.45 +* The client must close the string pool when finished using
    1.46 +* SDP Codec classes.
    1.47 +*
    1.48 +* Note: the client must not close the string pool while
    1.49 +*       using SDP Codec classes.
    1.50 +* 
    1.51 +* @lib sdpcodec.lib
    1.52 +*/
    1.53 +class SdpCodecStringPool
    1.54 +	{
    1.55 +public: // Constructors and destructor
    1.56 + 		
    1.57 +	/**
    1.58 +	* Opens SDP Codec string pool.
    1.59 +	*
    1.60 +    * @leave KErrAlreadyExists if pool already exists in TLS.
    1.61 +	*/
    1.62 +	IMPORT_C static void OpenL();
    1.63 +
    1.64 +	/**
    1.65 +	* Closes SDP Codec string pool.
    1.66 +	*
    1.67 +	*/
    1.68 +	IMPORT_C static void Close(); 
    1.69 +
    1.70 +public: 
    1.71 +	
    1.72 +	/**
    1.73 +	* Gets the string pool used by SDP Codec.
    1.74 +	*
    1.75 +	* @return RStringPool: A handle to a string pool
    1.76 +	* @leave KErrSdpCodecStringPool if the pool is not opened.
    1.77 +	*
    1.78 +	*/
    1.79 +	IMPORT_C static RStringPool StringPoolL();
    1.80 +
    1.81 +	/**
    1.82 +	* Gets the string table used by SDP Codec.
    1.83 +	*
    1.84 +	* @return TStringTable&: The string pool table
    1.85 +	* @leave KErrSdpCodecStringPool if the pool is not opened.
    1.86 +	*
    1.87 +	*/
    1.88 +	IMPORT_C static const TStringTable& StringTableL();
    1.89 +	};
    1.90 +
    1.91 +#endif