Class CTulStringResourceReader

class CTulStringResourceReader : public CBase;

Description

CTulStringResourceReader reads strings from resource without CCoeEnv. If resource file given to the constructor is not found, the constructor leaves. This module is mainly for server usage, where there is the need to read resources, but no CCoeEnv instance is present.

Usage:

#include <stringresourcereader.h>
#include <errorres.rsg> // Resource to be read header 

TFileName myFileName( _L("z:\\resource\\errorres.rsc") );
CTulStringResourceReader* test = CTulStringResourceReader::NewL( myFileName );

TPtrC buf;
buf.Set(test-> ReadResourceString(R_ERROR_RES_GENERAL)); 
  
// Note that buf will only be valid as long as CTulStringResourceReader 
// instance is alive and no new string is read by the same instance.
// If you need to read multiple strings, make copies.

delete test;

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CTulStringResourceReader - CTulStringResourceReader reads strings from resource without CCoeEnv. If resourc...

Members

Defined in CTulStringResourceReader:

• NewL(TFileName &)Creates a new String Resource Reader object.
• NewL(TFileName &,RFs &)Creates a new String Resource Reader object.
• NewLC(TFileName &)Creates a new String Resource Reader object, and puts a pointer to it onto the c...
• NewLC(TFileName &,RFs &)Creates a new String Resource Reader object, and puts a pointer to it onto the c...
• ReadResourceString(TInt)ReadResourceString: returns the string that match with the resource id. No lengh...

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CTulStringResourceReader* NewL(TFileName &aResFile);

Description

Creates a new String Resource Reader object.

Parameters

TBuf &aResFile The resource file from which the string(s) are to be read.

Return value

CTulStringResourceReader * a pointer to an new instance of CTulStringResourceReader class.

Leave codes

KErrNone, if successful; otherwise one of the other system-wide error codes.

IMPORT_C static CTulStringResourceReader* NewLC(TFileName &aResFile);

Description

Creates a new String Resource Reader object, and puts a pointer to it onto the cleanup stack.

Parameters

TBuf &aResFile The resource file from which the string(s) are to be read.

Return value

CTulStringResourceReader * a pointer to an new instance of CTulStringResourceReader class.

Leave codes

KErrNone, if successful; otherwise one of the other system-wide error codes.

IMPORT_C static CTulStringResourceReader* NewL(TFileName &aResFile, RFs &aFs);

Description

Creates a new String Resource Reader object.

Parameters

TBuf &aResFile The resource file from which the string(s) are to be read. RFs &aFs A handle to a shared file server session.

Return value

CTulStringResourceReader * a pointer to an new instance of CTulStringResourceReader class.

Leave codes

KErrNone, if successful; otherwise one of the other system-wide error codes.

IMPORT_C static CTulStringResourceReader* NewLC(TFileName &aResFile, RFs &aFs);

Description

Creates a new String Resource Reader object, and puts a pointer to it onto the cleanup stack.

Parameters

TBuf &aResFile The resource file from which the string(s) are to be read. RFs &aFs A handle to a shared file server session.

Return value

CTulStringResourceReader * a pointer to an new instance of CTulStringResourceReader class.

Leave codes

KErrNone, if successful; otherwise one of the other system-wide error codes.

IMPORT_C const TDesC& ReadResourceString(TInt aResourceId);

Description

ReadResourceString: returns the string that match with the resource id. No lenght limitations are imposed on read string.

Parameters

TInt aResourceId

Return value

const TDesC16 & String buffer if the string associated with the given resource Id is found, else returns empty descriptor.

Panic codes

aResourceId If the alignment of Unicode strings within the resource is incorrect,