Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <e32property.h>
Link against: euser.lib

Class RProperty

class RProperty : public RHandleBase;

Description

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.

Derivation

Members

Defined in RProperty:

Inherited from RHandleBase:


Member functions


Define(TUid,TUint,TInt,TInt)

Interface status: deprecated
Capability: WriteDeviceData if aCategory==KUidSystemCategoryValue. if aCategory not equal to the current process's Secure ID and aCategory<KUidSecurityThresholdCategoryValue.

IMPORT_C static TInt Define(TUid aCategory, TUint aKey, TInt aAttr, TInt aPreallocate=0);

Description

Defines a property.

Defines the attributes and access control for a property. This can only be done once for each property. Subsequent attempts to define the same property will return KErrAlreadyExists.

Only processes with the write-system-data capability are allowed to define properties in the system category (KUidSystemCategory). Any attempt to define a property in the system category by a process with insufficient capabilities will fail with a KErrPermissionDenied error.

Following definition, the property has a default value, 0 for integer properties and zero-length data for byte-array and text properties. Pending subscriptions for this property will not be completed until a new value is published.

Parameters

TUid aCategory

The UID that identifies the property category.

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

TInt aAttr

This describes the property type, a TType value; persistence, as defined by the KPersistent bit, may be ORed in.

TInt aPreallocate

The number of bytes to be pre-allocated for variable sized properties. Pre-allocating enough space ensures that a variable sized property can be set in 'real-time', (i.e. the time to set the property is bounded).

Return value

TInt

KErrNone, if successful; KErrArgument, if the wrong type or attribute was specified; KErrArgument, if aType is TInt and aPreallocate is not 0; KErrTooBig, if aPreallocate is greater than KMaxPropertySize; KErrPermissionDenied, if an attempt is made to define a property in the system category by a process with insufficient capabilities.

See also:


Delete(TUid,TUint)

IMPORT_C static TInt Delete(TUid aCategory, TUint aKey);

Description

Deletes a property.

This can only be called by the property owner, as defined by the process Security ID; any attempt by another process to delete the property will fail.

Any pending subscriptions for this property will be completed with KErrNotFound. Any new request will not complete until the property is defined and published again.

Parameters

TUid aCategory

The UID that identifies the property category.

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if a process that is not the owner of the property attempts to delete it. KErrNotFound, if the property has not been defined.


Delete(TUint)

IMPORT_C static TInt Delete(TUint aKey);

Description

Deletes a property.

The category ID for the property will be the same as the current processes Secure ID.

Any pending subscriptions for this property will be completed with KErrNotFound. Any new request will not complete until the property is defined and published again.

Parameters

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

Return value

TInt

KErrNone, if successful; KErrNotFound, if the property has not been defined.


Get(TUid,TUint,TInt &)

IMPORT_C static TInt Get(TUid aCategory, TUint aKey, TInt &aValue);

Description

Gets an integer property.

The function gets the integer value of the specified property.

The Platform Security attributes of the current process are checked against the Read Policy which was specified when the property was defined. If this check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return KErrNone even though the check failed.

Parameters

TUid aCategory

The UID that identifies the property category.

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

TInt &aValue

A reference to the variable where the property value will be reported.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Read Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not of integral type.


Get(TUid,TUint,TDes8 &)

IMPORT_C static TInt Get(TUid aCategory, TUint aKey, TDes8 &aValue);

Description

Gets a binary property.

The function gets the byte-array (binary) value of the specified property.

The Platform Security attributes of the current process are checked against the Read Policy which was specified when the property was defined. If this check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return KErrNone even though the check failed.

Parameters

TUid aCategory

The UID that identifies the property category.

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

TDes8 &aValue

A reference to the buffer descriptor where the property value will be reported.

Return value

TInt

KErrNone if successful; KErrPermissionDenied, if the caller process doesn't pass the Read Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not a byte-array (binary) type; KErrOverflow, if the supplied buffer is too small to contain the full property value, and note that the buffer aDes contains the truncated property value.


Get(TUid,TUint,TDes16 &)

IMPORT_C static TInt Get(TUid aCategory, TUint aKey, TDes16 &aValue);

Description

Gets a text property.

The function gets the text value of the specified property.

The Platform Security attributes of the current process are checked against the Read Policy which was specified when the property was defined. If this check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return KErrNone even though the check failed.

Parameters

TUid aCategory

The UID that identifies the property category.

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

TDes16 &aValue

A reference to the buffer descriptor where the property value will be reported.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Read Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not a text type; KErrOverflow, if the supplied buffer is too small to contain the full property value, and note that the buffer aDes contains the truncated property value.


Set(TUid,TUint,TInt)

IMPORT_C static TInt Set(TUid aCategory, TUint aKey, TInt aValue);

Description

Sets an integer property.

The function publishes a new integral property value.

Any pending subscriptions for this property will be completed.

The Platform Security attributes of the current process are checked against the Write Policy which was specified when the property was defined. If this check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return KErrNone even though the check failed.

Parameters

TUid aCategory

The UID that identifies the property category.

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

TInt aValue

The new property value.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Write Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not of integral type.


Set(TUid,TUint,const TDesC8 &)

IMPORT_C static TInt Set(TUid aCategory, TUint aKey, const TDesC8 &aValue);

Description

Sets a binary property.

The function Publishes a new byte-array (binary) value for the specified property.

Any pending subscriptions for this property will be completed.

Note that if the new property value requires more storage space than is currently allocated, then memory allocation will be required. This invalidates any real-time guarantee, i.e. the guarantee that the operation will complete within a bounded time.

The Platform Security attributes of the current process are checked against the Write Policy which was specified when the property was defined. If this check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return KErrNone even though the check failed.

Parameters

TUid aCategory

The UID that identifies the property category.

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

const TDesC8 &aValue

A reference to the descriptor containing the new property value.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Write Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not a byte-array (binary) type; KErrNoMemory, if memory allocation is required, and there is insufficient available.


Set(TUid,TUint,const TDesC16 &)

IMPORT_C static TInt Set(TUid aCategory, TUint aKey, const TDesC16 &aValue);

Description

Sets a text property.

The function publishes a new text value for the specified property.

Any pending subscriptions for this property will be completed.

Note that if the new property value requires more storage space than is currently allocated, then memory allocation will be required. This invalidates any real-time guarantee, i.e. the guarantee that the operation will complete within a bounded time.

The Platform Security attributes of the current process are checked against the Write Policy which was specified when the property was defined. If this check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return KErrNone even though the check failed.

Parameters

TUid aCategory

The UID that identifies the property category.

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

const TDesC16 &aValue

A reference to the descriptor containing the new property value.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Write Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not a text type; KErrNoMemory, if memory allocation is required, and there is insufficient available; KErrTooBig, if the property is larger than KMaxPropertySize;


Attach(TUid,TUint,TOwnerType)

IMPORT_C TInt Attach(TUid aCategory, TUint aKey, TOwnerType aType=EOwnerProcess);

Description

Attaches to the specified property.

The function creates a handle (this object) to the specified property. This allows the caller to subscribe for notification of changes to this property, and to faster and real-time property access methods.

If the specified property does not exist, then this operation will still succeed. However, memory allocation will be required. Note that this invalidates any real-time guarantee, i.e. the guarantee that the operation completes within a bounded time.

Parameters

TUid aCategory

The UID that identifies the property category.

TUint aKey

The property sub-key, i.e. the key that identifies the specific property within the category.

TOwnerType aType

The ownership of this property handle. By default, ownership is vested in the current process, but can be vested in the current thread by specifying EOwnerThread.

Return value

TInt

KErrNone, if successful; KErrNoMemory, if memory allocation is required, and there is insufficient available.


Subscribe(TRequestStatus &)

IMPORT_C void Subscribe(TRequestStatus &aRequest);

Description

Subscribes to a property.

The function issues an asynchronous request to be notified when the property is changed. The calling thread is signalled, and the specified request status object is updated when the property is next changed.

The property may change several times before the subscribing thread can deal with a notification request completion. To ensure that the subscriber does not miss updates, it should re-issue a subscription request before retrieving the current value and acting on it.

If the property has not been defined, the request does not complete until the property is subsequently defined and published. When defined, if the caller process doesn't pass the Read Policy, then the request completes with KErrPermissionDenied.

If the property is already defined, and the caller process doesn't pass the Read Policy, then the request completes immediately with KErrPermissionDenied.

When Read Policy checks fail the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then the request will complete successfully even though the check failed.

If an outstanding request is cancelled through a call to RProperty::Cancel(), then it completes with KErrCancel.

Parameters

TRequestStatus &aRequest

The request status object to be signalled on update.

Panic codes

KERN-EXEC

9 if there is already a subscription on this property handle; only one subscription per RProperty is allowed.


Cancel()

IMPORT_C void Cancel();

Description

Cancels an outstanding subscription request for this property handle.

If the request has not already completed, then it completes with KErrCancel.


Get(TInt &)

IMPORT_C TInt Get(TInt &aValue);

Description

Gets the integer value of this property.

The implementation guarantees that this call has a bounded response time.

Parameters

TInt &aValue

A reference to the variable where the property value will be reported.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Read Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not of integral type.


Get(TDes8 &)

IMPORT_C TInt Get(TDes8 &aValue);

Description

Gets the byte-array (binary) value of this property.

The implementation guarantees that this call has a bounded response time.

Parameters

TDes8 &aValue

A reference to the buffer descriptor where the property value will be reported.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Read Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not a byte-array (binary) type. KErrOverflow, if the supplied buffer is too small to contain the full property value, and note that the buffer aDes contains the truncated property value.


Get(TDes16 &)

IMPORT_C TInt Get(TDes16 &aValue);

Description

Gets the text value of this property.

The implementation guarantees that this call has a bounded response time.

Parameters

TDes16 &aValue

A reference to the buffer descriptor where the property value will be reported.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Read Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not a text type; KErrOverflow, if the supplied buffer is too small to contain the full property value, and note that the buffer aDes contains the truncated property value.


Set(TInt)

IMPORT_C TInt Set(TInt aValue);

Description

Sets a new integer value for this property.

The function publishes the attached new integral property value, and any pending subscriptions for this property are completed.

The implementation guarantees that this call has a bounded response time.

Parameters

TInt aValue

The property new value.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Write Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not of integral type.


Set(const TDesC8 &)

IMPORT_C TInt Set(const TDesC8 &aValue);

Description

Sets the byte-array (binary) property.

The function publishes the attached new binary property value, and any pending subscriptions for this property are completed.

The implementation guarantees that this call has a bounded response time only if the new property value requires no more storage space than is currently allocated. If more memory needs to be allocated, then this invalidates the real-time guarantee.

Parameters

const TDesC8 &aValue

A reference to the descriptor containing the property new value.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Write Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not a byte-array (binary) type; KErrNoMemory, if memory allocation is required, and there is insufficient available. KMaxPropertySize, if the property is larger than KErrTooBig.


Set(const TDesC16 &)

IMPORT_C TInt Set(const TDesC16 &aValue);

Description

Sets the text property

The function publishes the attached new text property value, and any pending subscriptions for this property are completed.

The implementation guarantees that this call has a bounded response time only if the new property value requires no more storage space than is currently allocated. If more memory needs to be allocated, then this invalidates the real-time guarantee.

Parameters

const TDesC16 &aValue

A reference to the descriptor containing the property new value.

Return value

TInt

KErrNone, if successful; KErrPermissionDenied, if the caller process doesn't pass the Write Policy; KErrNotFound, if the property has not been defined; KErrArgument, if the property is not a byte-array (binary) type; KErrNoMemory, if memory allocation is required, and there is insufficient available. KMaxPropertySize, if the property is larger than KErrTooBig.

[Top]


Member enumerations


Enum anonymous

n/a

Description

The largest supported property value, in bytes, for byte-array (binary) types and text types.

KMaxPropertySize


Enum anonymous

n/a

Description

The largest supported property value, in bytes, for large byte-array (binary) types and large text types.

KMaxLargePropertySize


Enum TType

TType

Description

Property type attribute.

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.

EText

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.

ELargeText

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

Bitmask for TType values coded within TInt attributes.