Collapse all Symbian^3 Product Developer Library

CBaNamedPlugins::TResourceFile Class Reference

class CBaNamedPlugins::TResourceFile

Information about a resource file containing the names of one or more named plug-ins.

The information is the full filename of the resource file (the language-specific version of this file provides the localised names, for display to users), the format for the contents of the resource file and a unique identifier for the plug-in, which is either a UID or an arbitrary textual identifier (this is not for display).

An array of TResourceFile objects is passed to CParameters::NewL() and NewLC().

Public Member Enumerations
enum	TFormat { EFormatTbuf, EFormatArrayOfUidNamePairs }

Public Attributes
TFormat	iFormat
HBufC *	iFullFileName
HBufC *	iIdentifier
TUid	iUid

Member Enumerations Documentation

Enum TFormat

The format of the contents of a resource file.

The EFormatArrayOfUidNamePairs format enables the names of multiple plug-ins to be held in a single resource file. This could be used in situations where a fixed set of plug-ins are provided in a single package, e.g. the plug-ins provided in a ROM (helping to reduce ROM space). In other cases, the EFormatTbuf format should be used (here a single resource file provides the name of a single plug-in).

Enumerators

EFormatTbuf	The resource file contains a single TBUF (text string) resource, to hold the plug-in name.
EFormatArrayOfUidNamePairs	The resource file contains an ARRAY resource, whose items are UID_NAME_PAIR structs. These contain plug-in UID and name pairs.

Member Data Documentation

TFormat iFormat

TFormat

iFormat

The format of the resource file's contents.

HBufC * iFullFileName

HBufC *

iFullFileName

The full filename of the resource file, with a language-independent extension (i.e. .rsc rather than, for instance, .r12). The language-specific version of this file (with the correct language extension) contains the localised name of the plug-in. The BaflUtils class is used internally to create the correct language extension for iFullFileName.

BaflUtils::NearestLanguageFile()

HBufC * iIdentifier

HBufC *

iIdentifier

Optional unique identifier for the plug-in , for instance the filename of the plug in's DLL. If not applicable, it may be NULL.

TUid iUid

TUid

iUid

Optional plug-in UID. If not applicable, it may have a value of KNullUid.