StringLoader Class Reference

API published in: S60 2nd Ed

Link against: commonengine.lib

Capability Information

Required Capabilities

None

#include <stringloader.h>

Detailed Description

Class provides methods to load and format resource strings.

String Loader API provides an interface to load and format resource strings that may contain parameter(s) (%U for text or or %N for numerical). Resource strings are usually defined in an RSS file.

The API consists of the StringLoader class. All methods are static, so there is no need to explicitly allocate memory for the interface class. The implementation needs a CCoeEnv instance to access for example the resource files.

Usage:

Applications load and format resource strings from normal resources with static methods of the StringLoader class. The loading is done with the LoadL and LoadLC methods and with the Load method in situations where memory allocation from the heap is not possible. Formatting is done automatically after loading in the LoadL and LoadLC methods, but it can also be done separately with the Format method in situations where memory allocation from the heap is not possible. For reading the resource strings with the Load, LoadL and LoadLC methods, the user should provide a pointer to CCoeEnv for efficiency reasons. If the pointer is not provided, the implementation uses the CCoeEnv::Static method internally to get it.

Different size displays can handle different length strings. To take full advantage of this fact, StringLoader supports resource strings with multiple options for string separated by 0x0001 character. Each such string can contain same or different sub string keys (%U and %N). StringLoader returns all strings, it is responsibility of the caller to parse the result and choose the proper string to display.

Setting the maximum sub string length may be done in the text resources. Sub string maximum lengths can be localized separately for every language. The maximum sub string length is of the format: %U[NN] where NN is a number [01..99]. Please note that NN must always consist of two characters, i.e. if the sub string maximum length is eight characters, the value to be used is 08, not plain 8. If the number of characters exceeds the maximum length, the sub string is cut to fit and the last character is replaced with an ellipsis character.

The following examples describe the usage of the String Loader API.

Usage when one TInt is added:

  // In .loc -file
  // #define text_example "You have %N undone tasks."

  // In .rss -file
  // RESOURCE TBUF r_text_example { buf = text_example; }

  // (In the .cpp -file)
  #include <stringloader.h>

  // Get CCoeEnv instance
  CEikonEnv* iEikonEnv = CEikonEnv::Static();

  TInt number( 324 );

  // Method reads a resource string with memory allocation
  // and replaces all %N-strings in it with a replacement TInt.
  // The heap descriptor must be destroyed when it is no longer needed.
  // iEikonEnv is needed for loading the resource string.
  HBufC* stringholder = StringLoader::LoadL( R_TEXT_EXAMPLE, number, iEikonEnv );

  // The 'number' is added to the resource string. The result is
  // that stringholder points to a heap descriptor containing string:
  // "You have 324 undone tasks."

  // Delete the heap descriptor
  delete stringholder;

Usage when several strings are added:

Index can be included to parameters. Several parameters can have same index, if same replacement is needed multiple times.

  // In .loc -file
  // #define text_example "I'm %2U%1U %3U%0U fine."

  // In .rss -file
  // RESOURCE TBUF r_text_example { buf = text_example; }

  // In the .cpp -file
  #include <stringloader.h>

  // Get CCoeEnv instance
  CEikonEnv* iEikonEnv = CEikonEnv::Static();

  CDesCArrayFlat* strings = new CDesCArrayFlat( 4 );
  CleanupStack::PushL( strings );

  strings->AppendL( _L("orking") ); //First string

  strings->AppendL( _L("ll") ); //Second string

  strings->AppendL( _L("sti") ); //Third string

  strings->AppendL( _L("w") ); //Fourth string

  // Method reads a resource string with memory allocation and replaces
  // the %(index)U strings in it with replacement strings from an array.
  // The heap descriptor must be destroyed when it is no longer needed.
  // iEikonEnv is needed for loading the resource string.
  HBufC* stringholder = StringLoader::LoadL( R_TEXT_EXAMPLE, *strings, iEikonEnv );

  // Four strings are added to the resource string. The result is
  // that stringholder points to a heap descriptor containing string:
  // "I'm still working fine."

  // Pop and delete strings array
  CleanupStack::PopAndDestroy();

  // Delete the heap descriptor
  delete stringholder;

Usage with scalable UI support:

  // In .loc -file
  // #define TEXT_EXAMPLE "You have missed %N messages from %U."<0x0001>"Missed %N msgs from %U."<0x0001>"Missed %N msgs."

  // In .rss -file
  // RESOURCE TBUF R_TEXT_EXAMPLE { buf = TEXT_EXAMPLE; }

  // In the .cpp -file
  #include <stringloader.h>

  // Get CCoeEnv instance
  CEikonEnv* iEikonEnv = CEikonEnv::Static();

  TInt number( 12 );
  _LIT(name, "John Doe");

  // Method reads a resource string with memory allocation,
  // replaces all %N strings in it with a replacement TInt and
  // all %U strings in it with a replacement string.
  // The heap descriptor must be destroyed  when it is no longer needed.
  // iEikonEnv is needed for loading the resource string.
  HBufC* stringholder = StringLoader::LoadL( R_TEXT_EXAMPLE, name, number, iEikonEnv );

  // The number and name are added to the resource string. The result is
  // that stringholder points to a heap descriptor containing string:
  // "You have missed 12 messages from John Doe.\001Missed 12 msgs from John
  // Doe.\001Missed 12 msgs."

  // Delete the heap descriptor
  delete stringholder;

Error handling:

The leave mechanism of the Symbian OS environment is used to handle memory exhaustion. The panic mechanism is used to handle programming errors while debugging. RStringLoader panics for seven different reasons. The panic category is named STRINGLOADER. The panic codes are:

ETooFewArguments = 0 (Unsolved parameters in resource string.)
ETooManyArguments = 1 (Already solved all parameters in resource string.)
EKeyStringNotFound = 2 (The key string wasn't found in formatting.)
EInvalidIndex = 3 (Invalid index in Format-method)
EDescriptorTooSmall = 4 (Too small destination descriptor.)
ECCoeEnvNotInitialized = 5 (CCoeEnv is not initialized)
EInvalidSubstitute = 6 (Substituted string contains KSubStringSeparator)


Static Public Member Functions
static IMPORT_C void	Load (TDes &aDest, TInt aResourceId, CCoeEnv *aLoaderEnv=NULL)
	Load( TDes&, TInt ) reads a resource string without memory allocation.
static IMPORT_C void	Format (TDes &aDest, const TDesC &aSource, TInt aPosition, const TDesC &aSubs)
	Format( TDes&, TDesC&, TInt, TInt ) formats a resource string without memory allocation.
static IMPORT_C HBufC *	LoadL (TInt aResourceId, CCoeEnv *aLoaderEnv=NULL)
	LoadL( TInt ) reads a resource string with memory allocation.
static IMPORT_C HBufC *	LoadL (TInt aResourceId, TInt aInt, CCoeEnv *aLoaderEnv=NULL)
	LoadL( TInt, TInt ) reads a resource string with memory allocation and replaces all %N strings in it with a replacement TInt.
static IMPORT_C HBufC *	LoadL (TInt aResourceId, const TDesC &aString, CCoeEnv *aLoaderEnv=NULL)
	LoadL( TInt, const TDesC& ) reads a resource string with memory allocation and replaces all %U-strings in it with a replacement string.
static IMPORT_C HBufC *	LoadL (TInt aResourceId, const TDesC &aString, TInt aInt, CCoeEnv *aLoaderEnv=NULL)
	LoadL( TInt, const TDesC&, TInt ) reads a resource string with memory allocation, replaces all %N-strings in it with a replacement TInt and all %U-strings in it with a replacement string.
static IMPORT_C HBufC *	LoadL (TInt aResourceId, const CArrayFix< TInt > &aInts, CCoeEnv *aLoaderEnv=NULL)
	LoadL( TInt, const CArrayFix<TInt>& ) reads a resource string with memory allocation and replaces the %(index)N-strings in it with replacement TInts from an array.
static IMPORT_C HBufC *	LoadL (TInt aResourceId, const MDesCArray &aStrings, CCoeEnv *aLoaderEnv=NULL)
	LoadL( TInt, const MDesCArray& ) reads a resource string with memory allocation and replaces the %(index)U-strings in it with replacement strings from an array.
static IMPORT_C HBufC *	LoadL (TInt aResourceId, const MDesCArray &aStrings, const CArrayFix< TInt > &aInts, CCoeEnv *aLoaderEnv=NULL)
	LoadL( TInt, const MDesCArray&, const CArrayFix<TInt>& ) reads a resource string with memory allocation and replaces the %(index)U-strings in it with replacement strings from an array and the %(index)N-strings in it with replacement TInts from another array.
static IMPORT_C HBufC *	LoadLC (TInt aResourceId, CCoeEnv *aLoaderEnv=NULL)
	LoadLC( TInt ) reads a resource string with memory allocation and pushes the string onto the cleanup stack.
static IMPORT_C HBufC *	LoadLC (TInt aResourceId, TInt aInt, CCoeEnv *aLoaderEnv=NULL)
	LoadLC( TInt, TInt ) reads a resource string with memory allocation, replaces all %N-strings in it with a replacement TInt and pushes the string onto the cleanup stack.
static IMPORT_C HBufC *	LoadLC (TInt aResourceId, const TDesC &aString, CCoeEnv *aLoaderEnv=NULL)
	LoadLC( TInt, const TDesC& ) reads a resource string with memory allocation, replaces all %U-strings in it with a replacement string and pushes the string onto the cleanup stack.
static IMPORT_C HBufC *	LoadLC (TInt aResourceId, const TDesC &aString, TInt aInt, CCoeEnv *aLoaderEnv=NULL)
	LoadLC( TInt, const TDesC&, TInt ) reads a resource string with memory allocation, replaces all %N-strings in it with a replacement TInt and the first %U-strings in it with a replacement string and pushes the string onto the cleanup stack.
static IMPORT_C HBufC *	LoadLC (TInt aResourceId, const CArrayFix< TInt > &aInts, CCoeEnv *aLoaderEnv=NULL)
	LoadLC( TInt, const CArrayFix<TInt>& ) reads a resource string with memory allocation, replaces the %(index)N-strings in it with replacement TInts from an array and pushes the string onto the cleanup stack.
static IMPORT_C HBufC *	LoadLC (TInt aResourceId, const MDesCArray &aStrings, CCoeEnv *aLoaderEnv=NULL)
	LoadLC( TInt, const MDesCArray& ) reads a resource string with memory allocation, replaces the %(index)U-strings in it with replacement strings from an array and pushes the string onto the cleanup stack.
static IMPORT_C HBufC *	LoadLC (TInt aResourceId, const MDesCArray &aStrings, const CArrayFix< TInt > &aInts, CCoeEnv *aLoaderEnv=NULL)
	LoadLC( TInt, const MDesCArray&, const CArrayFix<TInt>& ) reads a resource string with memory allocation, replaces the %(index)U-strings in it with replacement strings from an array and the %(index)N-strings in it with replacement TInts from another array and pushes the string onto the cleanup stack.

Member Function Documentation

static IMPORT_C void StringLoader::Format	(	TDes &	aDest,
		const TDesC &	aSource,
		TInt	aPosition,
		const TDesC &	aSubs
	)	`[static]`

Format( TDes&, TDesC&, TInt, TInt ) formats a resource string without memory allocation.

The formatted string is stored in the destination TDes&. Because this method doesn't allocate memory the destination descriptor must be long enough. In aPosition -1 means that there is no index in the key string and all %N-strings in the original string are replaced with aSubs. In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aDest	Reference to the descriptor where the resource string is formatted.
	aSource	Reference to the original string.
	aPosition	The index of the key string.
	aSubs	The replacing TInt.

Panic:: EInvalidIndex In debug build if the index of the key string is invalid.

Panic:: EDescriptorTooSmall In debug build if the length of the destination descriptor is to small.

Panic:: EKeyStringNotFound In debug build if the key string 'N' wasn't found, aDest is empty.

One small sample describing the usage of the method.

 // Load example string "%0N %1N" defined in rss- and loc-files.
 // %0N stands for area code and %1N for phone number.
 HBufC* telFormat = StringLoader::LoadLC( R_TEL_FORMAT, iEikonEnv );

 // The replacing number.
 TInt areaCode(123);

 StringLoader::Format( destBuf, telFormat, 
                       0, // %0N stands for area code
                       areaCode );

 // After returning destBuf contains string "123 %1N".
        */
        IMPORT_C static void Format( TDes& aDest, const TDesC& aSource,
                                   TInt aPosition, TInt aSubs );

static IMPORT_C void StringLoader::Load	(	TDes &	aDest,
		TInt	aResourceId,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

Load( TDes&, TInt ) reads a resource string without memory allocation.

The loaded string is stored in the destination TDes&. Because this method doesn't allocate memory the destination descriptor must be long enough.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aDest	Reference to the descriptor where the resource string is loaded.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Panic:: ECCoeEnvNotInitialized Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadL	(	TInt	aResourceId,
		const MDesCArray &	aStrings,
		const CArrayFix< TInt > &	aInts,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadL( TInt, const MDesCArray&, const CArrayFix<TInt>& ) reads a resource string with memory allocation and replaces the %(index)U-strings in it with replacement strings from an array and the %(index)N-strings in it with replacement TInts from another array.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aStrings	Reference to the array including pointers to the replacing strings.
	aInts	Reference to the array including the replacing TInts.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. The calling program must destroy the heap descriptor when it is no longer needed.

Panic:: ETooManyArguments In debug build if too many replacing elements in aStrings and/or aInts arrays.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadL	(	TInt	aResourceId,
		const MDesCArray &	aStrings,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadL( TInt, const MDesCArray& ) reads a resource string with memory allocation and replaces the %(index)U-strings in it with replacement strings from an array.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aStrings	Reference to the array including pointers to the replacing strings.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. The calling program must destroy the heap descriptor when it is no longer needed.

Panic:: ETooManyArguments In debug build if too many replacing elements in aStrings array.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadL	(	TInt	aResourceId,
		const CArrayFix< TInt > &	aInts,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadL( TInt, const CArrayFix<TInt>& ) reads a resource string with memory allocation and replaces the %(index)N-strings in it with replacement TInts from an array.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aInts	Reference to the array including the replacing TInts.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. The calling program must destroy the heap descriptor when it is no longer needed.

Panic:: ETooManyArguments In debug build if too many replacing elements in aInts array.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadL	(	TInt	aResourceId,
		const TDesC &	aString,
		TInt	aInt,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadL( TInt, const TDesC&, TInt ) reads a resource string with memory allocation, replaces all %N-strings in it with a replacement TInt and all %U-strings in it with a replacement string.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aString	Reference to the replacing string.
	aInt	The replacing TInt.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. The calling program must destroy the heap descriptor when it is no longer needed.

Panic:: EKeyStringNotFound In debug build if the key string 'N' or 'U' wasn't found in formatting.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadL	(	TInt	aResourceId,
		const TDesC &	aString,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadL( TInt, const TDesC& ) reads a resource string with memory allocation and replaces all %U-strings in it with a replacement string.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aString	Reference to the replacing string.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. The calling program must destroy the heap descriptor when it is no longer needed.

Panic:: EKeyStringNotFound In debug build if the key string 'U' wasn't found in formatting.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadL	(	TInt	aResourceId,
		TInt	aInt,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadL( TInt, TInt ) reads a resource string with memory allocation and replaces all %N strings in it with a replacement TInt.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aInt	The replacing TInt.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. The calling program must destroy the heap descriptor when it is no longer needed.

Panic:: EKeyStringNotFound In debug build if the key string 'N' wasn't found in formatting.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadL	(	TInt	aResourceId,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadL( TInt ) reads a resource string with memory allocation.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the resource string. The calling program must destroy the heap descriptor when it is no longer needed.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadLC	(	TInt	aResourceId,
		const MDesCArray &	aStrings,
		const CArrayFix< TInt > &	aInts,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadLC( TInt, const MDesCArray&, const CArrayFix<TInt>& ) reads a resource string with memory allocation, replaces the %(index)U-strings in it with replacement strings from an array and the %(index)N-strings in it with replacement TInts from another array and pushes the string onto the cleanup stack.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aStrings	Reference to the array including pointers to the replacing strings.
	aInts	Reference to the array including the replacing TInts.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. This pointer is in the cleanup stack. The calling program should pop and destroy the heap descriptor when it is no longer needed.

Panic:: ETooManyArguments In debug build if too many replacing elements in aStrings and/or aInts arrays.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadLC	(	TInt	aResourceId,
		const MDesCArray &	aStrings,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadLC( TInt, const MDesCArray& ) reads a resource string with memory allocation, replaces the %(index)U-strings in it with replacement strings from an array and pushes the string onto the cleanup stack.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aStrings	Reference to the array including pointers to the replacing strings.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. This pointer is in the cleanup stack. The calling program should pop and destroy the heap descriptor when it is no longer needed.

Panic:: ETooManyArguments In debug build if too many replacing elements in aStrings array.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadLC	(	TInt	aResourceId,
		const CArrayFix< TInt > &	aInts,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadLC( TInt, const CArrayFix<TInt>& ) reads a resource string with memory allocation, replaces the %(index)N-strings in it with replacement TInts from an array and pushes the string onto the cleanup stack.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aInts	Reference to the array including the replacing TInts.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. This pointer is in the cleanup stack. The calling program should pop and destroy the heap descriptor when it is no longer needed.

Panic:: ETooManyArguments In debug build if too many replacing elements in aInts array.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadLC	(	TInt	aResourceId,
		const TDesC &	aString,
		TInt	aInt,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadLC( TInt, const TDesC&, TInt ) reads a resource string with memory allocation, replaces all %N-strings in it with a replacement TInt and the first %U-strings in it with a replacement string and pushes the string onto the cleanup stack.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aString	Reference to the replacing string.
	aInt	The replacing TInt.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. This pointer is in the cleanup stack. The calling program should pop and destroy the heap descriptor when it is no longer needed.

Panic:: EKeyStringNotFound In debug build if the key string 'N' or 'U' wasn't found in formatting.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadLC	(	TInt	aResourceId,
		const TDesC &	aString,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadLC( TInt, const TDesC& ) reads a resource string with memory allocation, replaces all %U-strings in it with a replacement string and pushes the string onto the cleanup stack.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aString	Reference to the replacing string.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the formatted resource string. This pointer is in the cleanup stack. The calling program should pop and destroy the heap descriptor when it is no longer needed.

Panic:: EKeyStringNotFound In debug build if the key string 'U' wasn't found in formatting.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadLC	(	TInt	aResourceId,
		TInt	aInt,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadLC( TInt, TInt ) reads a resource string with memory allocation, replaces all %N-strings in it with a replacement TInt and pushes the string onto the cleanup stack.

In debug builds the Symbian OS panic mechanism is used to notify programming errors.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aInt	the replacing TInt.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: pointer to a heap descriptor containing the formatted resource string. This pointer is in the cleanup stack. The calling program should pop and destroy the heap descriptor when it is no longer needed.

Panic:: EKeyStringNotFound In debug build if the key string 'N' wasn't found in formatting.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

static IMPORT_C HBufC* StringLoader::LoadLC	(	TInt	aResourceId,
		CCoeEnv *	aLoaderEnv = `NULL`
	)	`[static]`

LoadLC( TInt ) reads a resource string with memory allocation and pushes the string onto the cleanup stack.

Parameters:

	aResourceId	The numeric ID of the resource string to be read.
	aLoaderEnv	Pointer to the control environment. If user doesn't give this, CCoeEnv::Static is called to get it.

Returns:: Pointer to a heap descriptor containing the resource string. This pointer is in the cleanup stack. The calling program should pop and destroy the heap descriptor when it is no longer needed.

Leave:: KErrNotSupported Parameter aLoaderEnv is NULL and CCoeEnv::Static returned NULL.

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

stringloader.h

StringLoader Class Reference

Capability Information

Detailed Description

Static Public Member Functions

Member Function Documentation