epoc32/include/mw/sdpcodecstringpool.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/epoc32/include/mw/sdpcodecstringpool.h	Wed Mar 31 12:27:01 2010 +0100
@@ -0,0 +1,88 @@
+/*
+* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* 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
+* which accompanies this distribution, and is available
+* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+* Name          : SdpCodecStringPool.h
+* Part of       : SDP Codec
+* Interface     : SDK API, SDP Codec API
+* Version       : 1.0
+*
+*/
+
+
+
+#ifndef SDPCODECSTRINGPOOL_H
+#define SDPCODECSTRINGPOOL_H
+
+//  INCLUDES
+#include <e32base.h>
+#include "_sdpdefs.h"
+#include <stringpool.h>
+
+class CSdpCodecStringPool;
+
+// CLASS DECLARATION
+/**
+* @publishedAll
+* @released
+*
+* This class defines string pool for SDP Codec.
+* The client of SDP Codec must call OpenL() before 
+* invoking any function of SDP Codec classes.
+* The client must close the string pool when finished using
+* SDP Codec classes.
+*
+* Note: the client must not close the string pool while
+*       using SDP Codec classes.
+* 
+* @lib sdpcodec.lib
+*/
+class SdpCodecStringPool
+	{
+public: // Constructors and destructor
+ 		
+	/**
+	* Opens SDP Codec string pool.
+	*
+    * @leave KErrAlreadyExists if pool already exists in TLS.
+	*/
+	IMPORT_C static void OpenL();
+
+	/**
+	* Closes SDP Codec string pool.
+	*
+	*/
+	IMPORT_C static void Close(); 
+
+public: 
+	
+	/**
+	* Gets the string pool used by SDP Codec.
+	*
+	* @return RStringPool: A handle to a string pool
+	* @leave KErrSdpCodecStringPool if the pool is not opened.
+	*
+	*/
+	IMPORT_C static RStringPool StringPoolL();
+
+	/**
+	* Gets the string table used by SDP Codec.
+	*
+	* @return TStringTable&: The string pool table
+	* @leave KErrSdpCodecStringPool if the pool is not opened.
+	*
+	*/
+	IMPORT_C static const TStringTable& StringTableL();
+	};
+
+#endif