Mercurialtest / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | raw | help
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. 
     1 /*

     2 * Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Name          : SdpCodecStringPool.h

    16 * Part of       : SDP Codec

    17 * Interface     : SDK API, SDP Codec API

    18 * Version       : 1.0

    19 *

    20 */

    21 

    22 

    23 

    24 #ifndef SDPCODECSTRINGPOOL_H

    25 #define SDPCODECSTRINGPOOL_H

    26 

    27 //  INCLUDES

    28 #include <e32base.h>

    29 #include <stringpool.h>

    30 

    31 class CSdpCodecStringPool;

    32 

    33 // CLASS DECLARATION

    34 /**

    35 * @publishedAll

    36 * @released

    37 *

    38 * This class defines string pool for SDP Codec.

    39 * The client of SDP Codec must call OpenL() before 

    40 * invoking any function of SDP Codec classes.

    41 * The client must close the string pool when finished using

    42 * SDP Codec classes.

    43 *

    44 * Note: the client must not close the string pool while

    45 *       using SDP Codec classes.

    46 * 

    47 * @lib sdpcodec.lib

    48 */

    49 class SdpCodecStringPool

    50 	{

    51 public: // Constructors and destructor

    52  		

    53 	/**

    54 	* Opens SDP Codec string pool.

    55 	*

    56     * @leave KErrAlreadyExists if pool already exists in TLS.

    57 	*/

    58 	IMPORT_C static void OpenL();

    59 

    60 	/**

    61 	* Closes SDP Codec string pool.

    62 	*

    63 	*/

    64 	IMPORT_C static void Close(); 

    65 

    66 public: 

    67 	

    68 	/**

    69 	* Gets the string pool used by SDP Codec.

    70 	*

    71 	* @return RStringPool: A handle to a string pool

    72 	* @leave KErrSdpCodecStringPool if the pool is not opened.

    73 	*

    74 	*/

    75 	IMPORT_C static RStringPool StringPoolL();

    76 

    77 	/**

    78 	* Gets the string table used by SDP Codec.

    79 	*

    80 	* @return TStringTable&: The string pool table

    81 	* @leave KErrSdpCodecStringPool if the pool is not opened.

    82 	*

    83 	*/

    84 	IMPORT_C static const TStringTable& StringTableL();

    85 	};

    86 

    87 #endif
test