conn::CSBPackageId Class Reference

class conn::CSBPackageId : public conn::CSBGenericDataType

Generic Data Type representing a data owner identified by a Package Id, Secure Id and Package Name. Package Id's are used to represent multiple SID's installed under a single package. There would potentially be several CSBPackageId's associated with a package, each detailing a single SID.

Byte Structure

All child classes have their data following on from the parent classes so that the parent classes may remain atomic with respect to the structure of their data. The binary structure of this data type inside the descriptor buffer is as follows. Note that the endianness of the data types specified below is determined by the platform and the PC must pack accordingly:

TSBDerivedType [4-bytes]

TUid [4-bytes]

TSecureId [4-bytes]

Pkg name length [4-bytes]

Pkg name data [variable]

Generic Data Type representing a data owner identified by a Package Id, Secure Id and Package Name. Package Id's are used to represent multiple SID's installed under a single package. There would potentially be several CSBPackageId's associated with a package, each detailing a single SID.

Byte Structure

All child classes have their data following on from the parent classes so that the parent classes may remain atomic with respect to the structure of their data. The binary structure of this data type inside the descriptor buffer is as follows. Note that the endianness of the data types specified below is determined by the platform and the PC must pack accordingly:

TSBDerivedType [4-bytes]

TUid [4-bytes]

TSecureId [4-bytes]

Pkg name length [4-bytes]

Pkg name data [variable]

Inherits from

Public Member Functions
~CSBPackageId ()
IMPORT_C CSBPackageId * NewL ( TUid , TSecureId , const TDesC &)
IMPORT_C TPackageName PackageNameL ()
IMPORT_C TSecureId SecureIdL ()
Protected Member Functions
void InitialiseL ( TInt &)
void InitialiseL ( TInt &, TInt )
Private Member Functions
CSBPackageId ()
void ConstructL ( TUid , TSecureId , const TDesC &)
void ConstructL ( CSBGenericDataType *)
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()
conn::CSBGenericDataType::BaseConstructL()
conn::CSBGenericDataType::CSBGenericDataType()
conn::CSBGenericDataType::ConstructL(const TDesC8 &)
conn::CSBGenericDataType::DerivedTypeL()const
conn::CSBGenericDataType::Externalise()const
conn::CSBGenericDataType::NewL(const TDesC8 &)
conn::CSBGenericDataType::PackDescriptorTypeAdvance(const TDesC16 &,TInt &)
conn::CSBGenericDataType::PackDescriptorTypeAdvance(const TDesC8 &,TInt &)
conn::CSBGenericDataType::UnpackDescriptorTypeAdvance(TDesC16 &,TInt &)
conn::CSBGenericDataType::UnpackDescriptorTypeAdvance(TDesC8 &,TInt &)
conn::CSBGenericDataType::UnpackTPtrAdvance(TPtrC16 &,TInt &)
conn::CSBGenericDataType::UnpackTPtrAdvance(TPtrC8 &,TInt &)
conn::CSBGenericDataType::~CSBGenericDataType()
Private Attributes
TInt iPackageIdOffset
TInt iPackageNameOffset
TInt iSecureIdOffset
Inherited Attributes
conn::CSBGenericDataType::iDataBuffer
conn::CSBGenericDataType::iDerivedTypeOffset
conn::CSBGenericDataType::iSize

Constructor & Destructor Documentation

CSBPackageId()

CSBPackageId ( ) [private]

C++ Constructor. Any derived types must increment iSize in their C++ constructors in order that when CSBGenericDataType::BaseConstructL() is called, the data buffer is initialised to be large enough to accomodate the data stored by the derived type

~CSBPackageId()

IMPORT_C ~CSBPackageId ( )

C++ Destructor

Member Functions Documentation

ConstructL(TUid, TSecureId, const TDesC &)

void ConstructL ( TUid aPackageId,
TSecureId aSecureId,
const TDesC & aPackageName
) [private]

Symbian OS 2nd phase constructor.

Parameters

TUid aPackageId the package identifier
TSecureId aSecureId the secure identifier
const TDesC & aPackageName the name of the package

ConstructL(CSBGenericDataType *)

void ConstructL ( CSBGenericDataType * aGenericDataType ) [private]

Parameters

CSBGenericDataType * aGenericDataType

InitialiseL(TInt &)

void InitialiseL ( TInt & aOffset ) [protected, virtual]

Initialise all member pointers to data

Parameters

TInt & aOffset The running offset of where the descriptor has been parsed up to

InitialiseL(TInt &, TInt)

void InitialiseL ( TInt & aOffset,
TInt aPackageNameLength
) [protected]

Parameters

TInt & aOffset
TInt aPackageNameLength

NewL(TUid, TSecureId, const TDesC &)

IMPORT_C CSBPackageId * NewL ( TUid aPackageId,
TSecureId aSecureId,
const TDesC & aPackageName
) [static]

Symbian constructor used for creating a derived class from it's constituent parameters. Used for example when creating a derived type from scratch

Parameters

TUid aPackageId the package identifier
TSecureId aSecureId the secure identifier
const TDesC & aPackageName the name of the package

PackageNameL()

IMPORT_C TPackageName PackageNameL ( ) const

SecureIdL()

IMPORT_C TSecureId SecureIdL ( ) const

Getter for the secure identifier

Member Data Documentation

TInt iPackageIdOffset

TInt iPackageIdOffset [private]

the package identifier

TInt iPackageNameOffset

TInt iPackageNameOffset [private]

user-readable name for the package

TInt iSecureIdOffset

TInt iSecureIdOffset [private]

the secure identifier