RProperty Class Reference

class RProperty : public RHandleBase

User side interface to Publish & Subscribe.

The class defines a handle to a property, a single data value representing an item of state information. Threads can publish (change) a property value through this handle. Threads can also subscribe (request notification of changes) to a property value through this handle; they can also retrieve the current property value.

Inherits from

Public Member Functions
IMPORT_C TIntAttach(TUid, TUint, TOwnerType)
IMPORT_C voidCancel()
IMPORT_C TIntDefine(TUid, TUint, TInt, TInt)
IMPORT_C TIntDefine(TUid, TUint, TInt, const TSecurityPolicy &, const TSecurityPolicy &, TInt)
IMPORT_C TIntDefine(TUint, TInt, const TSecurityPolicy &, const TSecurityPolicy &, TInt)
IMPORT_C TIntDelete(TUid, TUint)
IMPORT_C TIntDelete(TUint)
IMPORT_C TIntGet(TUid, TUint, TInt &)
IMPORT_C TIntGet(TUid, TUint, TDes8 &)
IMPORT_C TIntGet(TUid, TUint, TDes16 &)
IMPORT_C TIntGet(TInt &)
IMPORT_C TIntGet(TDes8 &)
IMPORT_C TIntGet(TDes16 &)
IMPORT_C TIntSet(TUid, TUint, TInt)
IMPORT_C TIntSet(TUid, TUint, const TDesC8 &)
IMPORT_C TIntSet(TUid, TUint, const TDesC16 &)
IMPORT_C TIntSet(TInt)
IMPORT_C TIntSet(const TDesC8 &)
IMPORT_C TIntSet(const TDesC16 &)
IMPORT_C voidSubscribe(TRequestStatus &)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::Close()
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RHandleBase::SetReturnedHandle(TInt)
RHandleBase::SetReturnedHandle(TInt,RHandleBase &)
Public Member Enumerations
enumTType {
EInt, EByteArray, EText = EByteArray, ELargeByteArray, ELargeText = ELargeByteArray, ETypeLimit, ETypeMask = 0xff
}
Inherited Enumerations
RHandleBase:TAttributes
Inherited Attributes
RHandleBase::iHandle

Member Functions Documentation

Attach(TUid, TUint, TOwnerType)

IMPORT_C TIntAttach(TUidaCategory,
TUintaKey,
TOwnerTypeaType = EOwnerProcess
)

Parameters

TUid aCategory
TUint aKey
TOwnerType aType = EOwnerProcess

Cancel()

IMPORT_C voidCancel()

Define(TUid, TUint, TInt, TInt)

IMPORT_C TIntDefine(TUidaCategory,
TUintaKey,
TIntaAttr,
TIntaPreallocate = 0
)[static]

Parameters

TUid aCategory
TUint aKey
TInt aAttr
TInt aPreallocate = 0

Define(TUid, TUint, TInt, const TSecurityPolicy &, const TSecurityPolicy &, TInt)

IMPORT_C TIntDefine(TUidaCategory,
TUintaKey,
TIntaAttr,
const TSecurityPolicy &aReadPolicy,
const TSecurityPolicy &aWritePolicy,
TIntaPreallocated = 0
)[static]

Parameters

TUid aCategory
TUint aKey
TInt aAttr
const TSecurityPolicy & aReadPolicy
const TSecurityPolicy & aWritePolicy
TInt aPreallocated = 0

Define(TUint, TInt, const TSecurityPolicy &, const TSecurityPolicy &, TInt)

IMPORT_C TIntDefine(TUintaKey,
TIntaAttr,
const TSecurityPolicy &aReadPolicy,
const TSecurityPolicy &aWritePolicy,
TIntaPreallocated = 0
)[static]

Parameters

TUint aKey
TInt aAttr
const TSecurityPolicy & aReadPolicy
const TSecurityPolicy & aWritePolicy
TInt aPreallocated = 0

Delete(TUid, TUint)

IMPORT_C TIntDelete(TUidaCategory,
TUintaKey
)[static]

Parameters

TUid aCategory
TUint aKey

Delete(TUint)

IMPORT_C TIntDelete(TUintaKey)[static]

Parameters

TUint aKey

Get(TUid, TUint, TInt &)

IMPORT_C TIntGet(TUidaCategory,
TUintaKey,
TInt &aValue
)[static]

Parameters

TUid aCategory
TUint aKey
TInt & aValue

Get(TUid, TUint, TDes8 &)

IMPORT_C TIntGet(TUidaCategory,
TUintaKey,
TDes8 &aValue
)[static]

Parameters

TUid aCategory
TUint aKey
TDes8 & aValue

Get(TUid, TUint, TDes16 &)

IMPORT_C TIntGet(TUidaCategory,
TUintaKey,
TDes16 &aValue
)[static]

Parameters

TUid aCategory
TUint aKey
TDes16 & aValue

Get(TInt &)

IMPORT_C TIntGet(TInt &aValue)

Parameters

TInt & aValue

Get(TDes8 &)

IMPORT_C TIntGet(TDes8 &aValue)

Parameters

TDes8 & aValue

Get(TDes16 &)

IMPORT_C TIntGet(TDes16 &aValue)

Parameters

TDes16 & aValue

Set(TUid, TUint, TInt)

IMPORT_C TIntSet(TUidaCategory,
TUintaKey,
TIntaValue
)[static]

Parameters

TUid aCategory
TUint aKey
TInt aValue

Set(TUid, TUint, const TDesC8 &)

IMPORT_C TIntSet(TUidaCategory,
TUintaKey,
const TDesC8 &aValue
)[static]

Parameters

TUid aCategory
TUint aKey
const TDesC8 & aValue

Set(TUid, TUint, const TDesC16 &)

IMPORT_C TIntSet(TUidaCategory,
TUintaKey,
const TDesC16 &aValue
)[static]

Parameters

TUid aCategory
TUint aKey
const TDesC16 & aValue

Set(TInt)

IMPORT_C TIntSet(TIntaValue)

Parameters

TInt aValue

Set(const TDesC8 &)

IMPORT_C TIntSet(const TDesC8 &aValue)

Parameters

const TDesC8 & aValue

Set(const TDesC16 &)

IMPORT_C TIntSet(const TDesC16 &aValue)

Parameters

const TDesC16 & aValue

Subscribe(TRequestStatus &)

IMPORT_C voidSubscribe(TRequestStatus &aRequest)

Parameters

TRequestStatus & aRequest

Member Enumerations Documentation

Enum TType

Property type attribute.

Enumerators

EInt

Integral property type.

EByteArray

Byte-array (binary data) property type. This type provides real-time guarantees but is limited to a maximum size of 512 bytes.

KMaxPropertySize

EText = EByteArray

Text property type. This is just a programmer friendly view of a byte-array property, and is implemented in the same way as EByteArray.

ELargeByteArray

Large byte-array (binary data) property type. This type provides no real-time guarantees but supports properties of up to 65536 bytes.

KMaxLargePropertySize

ELargeText = ELargeByteArray

Large text property type. This is just a programmer friendly view of a byte-array property, and is implemented in the same way as EByteArray.

ETypeLimit

Upper limit for TType values. It is the maximal legal TType value plus 1.

ETypeMask = 0xff

Bitmask for TType values coded within TInt attributes.

© Nokia 2010.