CTulStringResourceReader Class Reference

#include <mw/tulstringresourcereader.h>

Link against: etul.lib

class CTulStringResourceReader : public CBase

Inherits from

  • CTulStringResourceReader
Public Member Functions
~CTulStringResourceReader()
IMPORT_C CTulStringResourceReader *NewL(TFileName &)
IMPORT_C CTulStringResourceReader *NewL(TFileName &, RFs &)
IMPORT_C CTulStringResourceReader *NewLC(TFileName &)
IMPORT_C CTulStringResourceReader *NewLC(TFileName &, RFs &)
IMPORT_C const TDesC &ReadResourceString(TInt)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()

Detailed 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 <platform/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;

Constructor & Destructor Documentation

~CTulStringResourceReader ( )

~CTulStringResourceReader()

Member Function Documentation

NewL ( TFileName & )

IMPORT_C CTulStringResourceReader *NewL(TFileName &aResFile)[static]
Creates a new String Resource Reader object.
Parameters
aResFileThe resource file from which the string(s) are to be read.
Return Value
a pointer to an new instance of CTulStringResourceReader class.
Leave Codes
KErrNone,if successful; otherwise one of the other system-wide error codes.

NewL ( TFileName &, RFs & )

IMPORT_C CTulStringResourceReader *NewL(TFileName &aResFile,
RFs &aFs
)[static]
Creates a new String Resource Reader object.
Parameters
aResFileThe resource file from which the string(s) are to be read.
aFsA handle to a shared file server session.
Return Value
a pointer to an new instance of CTulStringResourceReader class.
Leave Codes
KErrNone,if successful; otherwise one of the other system-wide error codes.

NewLC ( TFileName & )

IMPORT_C CTulStringResourceReader *NewLC(TFileName &aResFile)[static]
Creates a new String Resource Reader object, and puts a pointer to it onto the cleanup stack.
Parameters
aResFileThe resource file from which the string(s) are to be read.
Return Value
a pointer to an new instance of CTulStringResourceReader class.
Leave Codes
KErrNone,if successful; otherwise one of the other system-wide error codes.

NewLC ( TFileName &, RFs & )

IMPORT_C CTulStringResourceReader *NewLC(TFileName &aResFile,
RFs &aFs
)[static]
Creates a new String Resource Reader object, and puts a pointer to it onto the cleanup stack.
Parameters
aResFileThe resource file from which the string(s) are to be read.
aFsA handle to a shared file server session.
Return Value
a pointer to an new instance of CTulStringResourceReader class.
Leave Codes
KErrNone,if successful; otherwise one of the other system-wide error codes.

ReadResourceString ( TInt )

IMPORT_C const TDesC &ReadResourceString(TIntaResourceId)
ReadResourceString: returns the string that match with the resource id. No lenght limitations are imposed on read string.
Return Value
String buffer if the string associated with the given resource Id is found, else returns empty descriptor.
Panic Codes
aResourceIdIf the alignment of Unicode strings within the resource is incorrect,
© Nokia 2005.