Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: e32des16.h
Link against: euser.lib

Class TPtrC16

class TPtrC16 : public TDesC16;

Description

16-bit non-modifiable pointer descriptor.

This is a descriptor class intended for instantiation and encapsulates a pointer to the 16-bit data that it represents. The data can live in ROM or RAM and this location is separate from the descriptor object itself.

The data is intended to be accessed, but not changed, through this descriptor. The base class provides the functions through which data is accessed.

Derivation

Members

Defined in TPtrC16:
Set(), Set(), Set(), TPtrC16(), TPtrC16(), TPtrC16(), TPtrC16(), iPtr

Inherited from TDesC16:
Alloc(), AllocL(), AllocLC(), AtC(), Compare(), CompareC(), CompareF(), DoSetLength(), EIsNotPrefix, EIsPrefix, EMightBePrefix, Find(), FindC(), FindF(), HasPrefixC(), Left(), Length(), Locate(), LocateF(), LocateReverse(), LocateReverseF(), Match(), MatchC(), MatchF(), Mid(), Ptr(), Right(), Size(), TPrefix, Type(), operator!=(), operator>(), operator>=(), operator<(), operator<=(), operator==(), operator[]()

See also:


Construction and destruction


TPtrC16()

IMPORT_C TPtrC16();

Description

Constructs an empty 16-bit non-modifiable pointer descriptor.

It represents no data and its length is zero.

The non-modifiable pointer descriptor can, subsequently, be set to represent data.

See also:


TPtrC16()

IMPORT_C TPtrC16(const TDesC16 &aDes);

Description

Constructs the 16-bit non-modifiable pointer descriptor from any existing descriptor.

It is set to point to the same data and is given the same length as the source descriptor.

Parameters

const TDesC16 &aDes

A reference to a 16-bit non-modifiable descriptor.


TPtrC16()

IMPORT_C TPtrC16(const TUint16 *aString);

Description

Constructs the 16-bit non-modifiable pointer descriptor to point to a zero terminated string, whether in RAM or ROM.

The length of the descriptor is set to the length of the zero terminated string, excluding the zero terminator.

Parameters

const TUint16 *aString

A pointer to a zero terminated string.


TPtrC16()

IMPORT_C TPtrC16(const TUint16 *aBuf, TInt aLength);

Description

Constructs the 16-bit non-modifiable pointer descriptor to point to the specified location in memory, whether in RAM or ROM.

The length of the descriptor is set to the specified length.

Parameters

const TUint16 *aBuf

A pointer to the location that the descriptor is to represent.

TInt aLength

The length of the descriptor.This value must be non-negative.

Panic codes

USER

17 if aLength is negative.

[Top]


Member functions


Set()

inline void Set(const TUint16 *aBuf, TInt aLength);

Description

Sets the 16-bit non-modifiable pointer descriptor to point to the specified location in memory, whether in RAM or ROM.

The length of the descriptor is set to the specified length.

Parameters

const TUint16 *aBuf

A pointer to the location that the descriptor is to represent.

TInt aLength

The length of the descriptor. This value must be non-negative

Panic codes

USER

17, if aLength is negative.


Set()

inline void Set(const TDesC16 &aDes);

Description

Sets the 16-bit non-modifiable pointer descriptor from the specified descriptor.

It is set to point to the same data and is given the same length.

Parameters

const TDesC16 &aDes

A reference to a 16-bit non-modifiable descriptor


Set()

inline void Set(const TPtrC16 &aPtr);

Description

Parameters

const TPtrC16 &aPtr

[Top]


Member data


iPtr

protected: const TUint16 * iPtr;

Description