epoc32/include/mw/sdpcodecstringpool.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
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@2
     1
/*
williamr@2
     2
* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Name          : SdpCodecStringPool.h
williamr@2
    16
* Part of       : SDP Codec
williamr@2
    17
* Interface     : SDK API, SDP Codec API
williamr@2
    18
* Version       : 1.0
williamr@2
    19
*
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
#ifndef SDPCODECSTRINGPOOL_H
williamr@2
    25
#define SDPCODECSTRINGPOOL_H
williamr@2
    26
williamr@2
    27
//  INCLUDES
williamr@2
    28
#include <e32base.h>
williamr@2
    29
#include <stringpool.h>
williamr@2
    30
williamr@2
    31
class CSdpCodecStringPool;
williamr@2
    32
williamr@2
    33
// CLASS DECLARATION
williamr@2
    34
/**
williamr@2
    35
* @publishedAll
williamr@2
    36
* @released
williamr@2
    37
*
williamr@2
    38
* This class defines string pool for SDP Codec.
williamr@2
    39
* The client of SDP Codec must call OpenL() before 
williamr@2
    40
* invoking any function of SDP Codec classes.
williamr@2
    41
* The client must close the string pool when finished using
williamr@2
    42
* SDP Codec classes.
williamr@2
    43
*
williamr@2
    44
* Note: the client must not close the string pool while
williamr@2
    45
*       using SDP Codec classes.
williamr@2
    46
* 
williamr@2
    47
* @lib sdpcodec.lib
williamr@2
    48
*/
williamr@2
    49
class SdpCodecStringPool
williamr@2
    50
	{
williamr@2
    51
public: // Constructors and destructor
williamr@2
    52
 		
williamr@2
    53
	/**
williamr@2
    54
	* Opens SDP Codec string pool.
williamr@2
    55
	*
williamr@2
    56
    * @leave KErrAlreadyExists if pool already exists in TLS.
williamr@2
    57
	*/
williamr@2
    58
	IMPORT_C static void OpenL();
williamr@2
    59
williamr@2
    60
	/**
williamr@2
    61
	* Closes SDP Codec string pool.
williamr@2
    62
	*
williamr@2
    63
	*/
williamr@2
    64
	IMPORT_C static void Close(); 
williamr@2
    65
williamr@2
    66
public: 
williamr@2
    67
	
williamr@2
    68
	/**
williamr@2
    69
	* Gets the string pool used by SDP Codec.
williamr@2
    70
	*
williamr@2
    71
	* @return RStringPool: A handle to a string pool
williamr@2
    72
	* @leave KErrSdpCodecStringPool if the pool is not opened.
williamr@2
    73
	*
williamr@2
    74
	*/
williamr@2
    75
	IMPORT_C static RStringPool StringPoolL();
williamr@2
    76
williamr@2
    77
	/**
williamr@2
    78
	* Gets the string table used by SDP Codec.
williamr@2
    79
	*
williamr@2
    80
	* @return TStringTable&: The string pool table
williamr@2
    81
	* @leave KErrSdpCodecStringPool if the pool is not opened.
williamr@2
    82
	*
williamr@2
    83
	*/
williamr@2
    84
	IMPORT_C static const TStringTable& StringTableL();
williamr@2
    85
	};
williamr@2
    86
williamr@2
    87
#endif