S60 3rd Edition API Reference: SIPStrings Class Reference

SIPStrings Class Reference

API published in: S60 3rd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None


#include <sipstrings.h>

Detailed Description

PublishedAll
Released
This class defines string pool for SIP Codec. The client of SIP Codec must call
OpenL() before invoking any function of SIP Codec classes. The client must close the string pool when finished using SIP Codec classes.

Static Public Member Functions

static IMPORT_C void OpenL ()
 Opens SIP Codec string pool.
static IMPORT_C void Close ()
 Closes SIP Codec string pool.
static IMPORT_C RStringF StringF (TInt aIndex)
 Gets a case-insensitive string specified in the original string table.
static IMPORT_C RStringPool Pool ()
 Gets the string pool used by SIP Codec.
static IMPORT_C const TStringTable & Table ()
 Gets the string table used by SIP Codec.

Member Function Documentation

static IMPORT_C void SIPStrings::Close  )  [static]
 

Closes SIP Codec string pool.

In other words decrements reference count and if it reaches zero, closes the string pool. The user must not call Close() if it has not called OpenL().

static IMPORT_C void SIPStrings::OpenL  )  [static]
 

Opens SIP Codec string pool.

Implemented with a reference count.

static IMPORT_C RStringPool SIPStrings::Pool  )  [static]
 

Gets the string pool used by SIP Codec.

Returns:
RStringPool: A handle to a string pool
static IMPORT_C RStringF SIPStrings::StringF TInt  aIndex  )  [static]
 

Gets a case-insensitive string specified in the original string table.

Parameters:
aIndex The string table enumeration value
Returns:
Initialised RStringF object
static IMPORT_C const TStringTable& SIPStrings::Table  )  [static]
 

Gets the string table used by SIP Codec.

Returns:
TStringTable&: The string pool table

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2007
Back to top