![Symbian Developer Library](../../../../a_stock/images/mainheading.gif)
![]() |
![]() |
|
class CLogEvent : public CBase;
Encapsulates the details of an event.
Where time is used, it must be specified as UTC rather than local time.
CBase
-
Base class for all classes to be instantiated on the heap.
CLogEvent
- Encapsulates the details of an event.
Defined in CLogEvent
:
ClearFlags(TLogFlags)
Clears the specified flags for this event.Contact()const
Gets the contact ID associated with the event.CopyL(const CLogEvent &)
Makes a copy of the specified log event.Data()const
Gets event specific data.Description()const
Gets the human readable name describing the event type.Direction()const
Gets the direction of the call represented by this event. The direction of a cal...Duration()const
Gets the duration of the event.DurationType()const
Gets the duration type.EventType()const
Gets the type of this log event. Event types are identified by a UID.ExternalizeL(RWriteStream &)const
Flags()const
Gets the flags set for this event.Id()const
Gets the unique event ID associated with this log event.InternalizeL(RReadStream &)
Link()const
Gets the link value.NewL()
Creates a new log event detail object.Number()const
Gets the phone number associated with the event.RemoteParty()const
Gets the remote party associated with this event.SetContact(TLogContactItemId)
Sets the contact ID associated with the event.SetDataL(RReadStream &,TInt)
Sets event specific data from the specified stream.SetDataL(const TDesC8 &)
Sets event specific data.SetDescription(const TDesC &)
SetDirection(const TDesC &)
Sets the direction of the call represented by this event. The direction of a cal...SetDuration(TLogDuration)
Sets the duration of the event.SetDurationType(TLogDurationType)
Sets the duration type. This applies meaning to the idea of a duration.SetEventType(TUid)
Sets the type of this log event. Event types are identified by a UID.SetFlags(TLogFlags)
Sets the specified flags for this event.SetId(TLogId)
Sets the unique event ID.SetLink(TLogLink)
Sets the link value.SetNumber(const TDesC &)
Sets the phone number associated with this event. This is used when the number c...SetRemoteParty(const TDesC &)
Sets the remote party associated with this event. This describes the destination...SetStatus(const TDesC &)
Sets the delivery status of this event.SetSubject(const TDesC &)
Sets the subject of this event.SetTime(const TTime &)
Sets the UTC time that this event was created.Status()const
Gets the delivery status of this event.Subject()const
Gets the subject of this event.Time()const
Gets the UTC time that this event was created.~CLogEvent()
Frees all resources owned by the log event detail object. Inherited from CBase
:
Delete(CBase *)
Deletes the specified object.Extension_(TUint,TAny *&,TAny *)
Extension function operator new(TUint)
Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TAny *)
Initialises the object to binary zeroes.operator new(TUint,TLeave)
Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TLeave,TUint)
Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TUint)
Allocates the object from the heap and then initialises its contents to binary z...IMPORT_C static CLogEvent* NewL();
Creates a new log event detail object.
|
inline TLogId Id() const;
Gets the unique event ID associated with this log event.
Unique event IDs are allocated by the Log Engine when an event is added to the log.
|
CLogClient::GetEvent(CLogEvent &,TRequestStatus &)
Gets the details of the specified event. This is an asynchronous request.CLogClient::AddEvent(CLogEvent &,TRequestStatus &)
Adds an event to the log database. This is an asynchronous request.CLogClient::ChangeEvent(const CLogEvent &,TRequestStatus &)
Changes the details of an existing event. This is an asynchronous request.CLogClient::DeleteEvent(TLogId,TRequestStatus &)
Deletes the event with the specified unique event ID, from the main event log.inline void SetId(TLogId aId);
Sets the unique event ID.
|
inline TUid EventType() const;
Gets the type of this log event. Event types are identified by a UID.
|
CLogEvent::Description()const
Gets the human readable name describing the event type.inline void SetEventType(TUid aId);
Sets the type of this log event. Event types are identified by a UID.
|
CLogEvent::Description()const
Gets the human readable name describing the event type.inline const TDesC& RemoteParty() const;
Gets the remote party associated with this event.
|
inline void SetRemoteParty(const TDesC &aRemote);
Sets the remote party associated with this event. This describes the destination of an outgoing event or the source of an incoming event.
The remote party is represented by a string.
The string is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxRemoteLength. If the length of the specified descriptor is greater than KLogMaxRemoteLength, then the data is truncated.
|
inline const TDesC& Direction() const;
Gets the direction of the call represented by this event. The direction of a call means incoming, outgoing etc.
The direction is represented by a string.
|
inline void SetDirection(const TDesC &aDirection);
Sets the direction of the call represented by this event. The direction of a call means incoming, outgoing etc.
The direction is represented by a string. Standard strings are available in the log wrapper resource file and can be accessed through the resource IDs: R_LOG_DIR_IN, R_LOG_DIR_OUT, R_LOG_DIR_IN_ALT, R_LOG_DIR_OUT_ALT, R_LOG_DIR_FETCHED and R_LOG_DIR_MISSED.
The string is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxDirectionLength. If the length of the specified descriptor is greater than KLogMaxDirectionLength, then the data is truncated.
|
CLogClient::GetString(TDes &,TInt)const
Gets a standard string from the specified resource in logwrap.dll resource file.inline const TTime& Time() const;
Gets the UTC time that this event was created.
|
inline void SetTime(const TTime &aTime);
Sets the UTC time that this event was created.
Note that this field is used when ordering events in a view; changing this value may change the position of the event in a view.
|
inline TLogDurationType DurationType() const;
Gets the duration type.
This applies meaning to the idea of a duration.
The duration type is implemented as a UI variant-specific enumeration. The following duration types are generic: KLogDurationNone, KLogDurationValid and KLogDurationData.
|
inline void SetDurationType(TLogDurationType aDurationType);
Sets the duration type. This applies meaning to the idea of a duration.
|
inline TLogDuration Duration() const;
Gets the duration of the event.
|
inline void SetDuration(TLogDuration aDuration);
Sets the duration of the event.
|
inline const TDesC& Status() const;
Gets the delivery status of this event.
|
inline void SetStatus(const TDesC &aStatus);
Sets the delivery status of this event.
The delivery status is represented by a string. Standard strings are available in the log wrapper resource file and can be accessed through the resource IDs: R_LOG_DEL_PENDING, R_LOG_DEL_SENT, R_LOG_DEL_FAILED, R_LOG_DEL_NONE, R_LOG_DEL_DONE and R_LOG_DEL_NOT_SENT.
The string is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxStatusLength. If the length of the specified descriptor is greater than KLogMaxStatusLength, then the data is truncated.
|
CLogClient::GetString(TDes &,TInt)const
Gets a standard string from the specified resource in logwrap.dll resource file.inline const TDesC& Subject() const;
Gets the subject of this event.
|
inline void SetSubject(const TDesC &aSubject);
Sets the subject of this event.
The subject is represented by a string.
The string is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxSubjectLength. If the length of the specified descriptor is greater than KLogMaxSubjectLength, then the data is truncated.
|
inline const TDesC& Number() const;
Gets the phone number associated with the event.
|
inline void SetNumber(const TDesC &aNumber);
Sets the phone number associated with this event. This is used when the number cannot be stored in any other field.
The number is specified as a string and is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxNumberLength. If the length of the specified descriptor is greater than KLogMaxNumberLength, then the number is truncated.
|
inline TLogContactItemId Contact() const;
Gets the contact ID associated with the event.
|
inline void SetContact(TLogContactItemId aContact);
Sets the contact ID associated with the event.
|
inline TLogLink Link() const;
Gets the link value.
|
inline void SetLink(TLogLink aLink);
Sets the link value.
The link can be used to relate this event to an entity in another application. For example, it can be used to associate the event with the call ID or the message ID for emails and faxes.
|
inline const TDesC& Description() const;
Gets the human readable name describing the event type.
Note that this is set automatically by the Log Engine.
|
inline void SetDescription(const TDesC &aDescription);
|
inline TLogFlags Flags() const;
Gets the flags set for this event.
|
inline void SetFlags(TLogFlags aFlags);
Sets the specified flags for this event.
The function does not change any of the other flag bit settings.
Only the low order 4 bits are stored in the Log Engine Database; the constant KLogFlagsMask can be used as a mask.
|
inline void ClearFlags(TLogFlags aFlags);
Clears the specified flags for this event.
The function does not change any of the other flag bit settings.
The constant KLogFlagsMask may be used to clear all the flags in an event.
|
inline const TDesC8& Data() const;
Gets event specific data.
|
IMPORT_C void SetDataL(RReadStream &aStream, TInt aLen);
Sets event specific data from the specified stream.
The data can be used for any purpose. The data is copied into a heap descriptor allocated by this function; the amount of data is only limited by the available memory.
|
IMPORT_C void SetDataL(const TDesC8 &aData);
Sets event specific data.
The data can be used for any purpose. The data is copied into a heap descriptor allocated by this function; the amount of data is only limited by the available memory.
|
IMPORT_C void CopyL(const CLogEvent &aEvent);
Makes a copy of the specified log event.
|
IMPORT_C void ExternalizeL(RWriteStream &aStream) const;
|