SIPStrings Class Reference

#include <mw/sipstrings.h>

Link against: sipcodec.lib

class SIPStrings

Public Member Functions
IMPORT_C void	Close()
IMPORT_C void	OpenL()
IMPORT_C RStringPool	Pool()
IMPORT_C RStringF	StringF(TInt)
IMPORT_C const TStringTable &	Table()

Detailed Description

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.

Member Function Documentation

Close ( )

IMPORT_C void

(

)

[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().

OpenL ( )

IMPORT_C void

OpenL

(

)

[static]

Opens SIP Codec string pool. Implemented with a reference count.

Pool ( )

IMPORT_C RStringPool

Pool

(

)

[static]

Gets the string pool used by SIP Codec.

Returns: RStringPool: A handle to a string pool

StringF ( TInt )

IMPORT_C RStringF

StringF

(

TInt

aIndex

)

[static]

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

Parameter	Description
aIndex	The string table enumeration value

Returns: Initialised RStringF object

Table ( )

IMPORT_C const TStringTable &

Table

(

)

[static]

Gets the string table used by SIP Codec.

Returns: TStringTable&: The string pool table