SPAuditEntry.EventData property

Gets data, in XML markup, that is specific to the type of event identified in the Event property.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public ReadOnly Property EventData As String
    Get
'Usage
Dim instance As SPAuditEntry
Dim value As String

value = instance.EventData

public string EventData { get; }

Property value

Type: System.String
A String that holds XML markup providing data that is specific to the type of event that the SPAuditEntry object represents.

Remarks

For custom events that you create, you can use any XML schema. (Or you can use an undefined XML format.) For more information about the event data of custom events, refer to WriteAuditEvent. The data for custom events must not exceed 4000 characters. (Some system events produce more than 4000 characters of event data.)

Some of the built-in events in SharePoint Foundation put data into the EventData property as shown in the following table. The ToString method wraps the value of this property in <EventData></EventData> tags. Note that if the data is logically divisible, it has internal XML markup as well. If the data consists of a single data point (as is the case, for example, with the Copy event), it generally does not have internal XML markup. However, if the same type of data appears as part of complex data in another event's EventData, it has the same XML markup even when it is the sole data point. For example, part of the ChildMove event is marked with <NewName>; so this same markup appears on the data for the Move event even though the new name is the sole data point.

For built-in events not listed here,EventDataisa null reference (Nothing in Visual Basic)and is not included in the string returned byToString. Line breaks have been added for readability. The actual value of the property has no line breaks or white space.

Examples

The following example (from Item-Level Auditing with SharePoint Server 2007) shows this property in use.

foreach (SPAuditEntry oAuditEntry in collAuditEntries)  {
  if (oAuditEntry.SourceName == "CustomViewAuditEvent") {
    string strMyXml = oAuditEntry.EventData;
    // process custom event
  }
}

Dim oAuditQuery As New SPAuditQuery(oSiteCollection)
oAuditQuery.RestrictToListItem(item)
Dim collAuditEntries As SPAuditEntryCollection = oSiteCollection.Audit.GetEntries(oAuditQuery)

For Each oAuditEntry As SPAuditEntry In collAuditEntries
  ' get info from audit log
Next oAuditEntry

See also

Reference

SPAuditEntry class

SPAuditEntry members

Microsoft.SharePoint namespace

Other resources

Item-Level Auditing with SharePoint Server 2007