Class TSysAgentEvent

TSysAgentEvent

Support

Supported from 6.0

Description

Encapsulates a request for notification of a change to a state variable.

The request is constructed and passed to the System Agent through the standard client handle, a RSystemAgent object.

The class is used in an active object environment. Typically, a TSysAgentEvent object is owned by an active object and takes that active object's request status.

Defined in TSysAgentEvent:
SetRequestStatus(), SetUid(), State(), TSysAgentEvent(), Uid()

See also:

• RSystemAgent
• RSystemAgent::NotifyOnEvent()
• RSystemAgent::NotifyOnAnyEvent()
• CActive

TSysAgentEvent();

Description

Constructs the object, setting its request status pointer to NULL. Other member data is not initialised.

The request status can be set after construction by calling SetRequestStatus().

See also:

• TSysAgentEvent::SetRequestStatus()

TSysAgentEvent(TRequestStatus& aStatus);

Description

Constructs the object, taking a reference to a request status object.

The object's request status pointer is set to point to the specified request status object. The request status itself is not changed by this constructor.

Other member data is not initialised.

Parameters

TRequestStatus& aStatus The request status. Typically, this is provided by the owning active object.

void SetRequestStatus(TRequestStatus& aStatus);

Description

Sets the object's request status to refer to the specified request status object. The request status itself is not changed by this function.

Parameters

TRequestStatus& aStatus The request status.

Notes:

• Typically, the request status is belongs to an active object that owns this TSysAgentEvent object.

See also:

• TSysAgentEvent

void SetUid(TUid aUid);

Description

Sets the UID that identifies a state variable.

This is set before making a request for notification of a change to a specific state variable.

The standard set of UIDs are defined in sacls.h.

Parameters

TUid aUid The UID identifying a state variable.

See also:

• RSystemAgent::NotifyOnEvent()

TUid Uid();

Description

Gets the UID that identifies a state variable.

The UID is one of:

• the value set by a call to SetUid()

• the value set on successful completion of a request for notification of a change to any state variable.

Return value

TUid The UID identifying a state variable.

See also:

• RSystemAgent::NotifyOnAnyEvent()

TInt State();

Description

Gets the value of a state variable.

This value is set on successful completion of a request for notification of a change to any state variable. The state variable is identified by the UID that is also returned by the same request.

Return value

TInt The state variable.

Notes:

• The returned value is undefined if a request for notification is not yet complete.

See also:

• RSystemAgent::NotifyOnAnyEvent()