(SPAuditEventType, String, String) del método SPAudit.WriteAuditEvent

Artículo
05/13/2015

Escribe un registro acerca de un evento en la base de datos de SharePoint.

Espacio de nombres: Microsoft.SharePoint
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
Public Function WriteAuditEvent ( _
    eventId As SPAuditEventType, _
    eventSource As String, _
    xmlData As String _
) As Boolean
'Uso
Dim instance As SPAudit
Dim eventId As SPAuditEventType
Dim eventSource As String
Dim xmlData As String
Dim returnValue As Boolean

returnValue = instance.WriteAuditEvent(eventId, _
    eventSource, xmlData)

public bool WriteAuditEvent(
    SPAuditEventType eventId,
    string eventSource,
    string xmlData
)

Parámetros

eventId
Tipo: Microsoft.SharePoint.SPAuditEventType

El tipo de evento que se está grabando.

eventSource
Tipo: System.String

El nombre de la aplicación que llama.

xmlData
Tipo: System.String

La información sobre el evento.

Valor devuelto

Tipo: System.Boolean
true en todos los casos.

Comentarios

Use este método para escribir los registros de tipos de eventos personalizados o versiones personalizadas de los tipos de evento existentes. Pase Custom para eventID al escribir un evento personalizado. (Si tiene más de un tipo de evento personalizado y desea distinguirlos de los informes de auditoría, utilice la sobrecarga de WriteAuditEvent(String, String, String) del método). Cuando el evento es similar a uno de los objetos SPAuditEventType existente y desea que incluyen en los informes de auditoría de ese tipo de evento, pase el valor adecuado SPAuditEventType para eventID.

Pasar el nombre de la solución de SharePoint como eventSource. De forma opcional, puede pasar hasta 4.000 caracteres de información adicional sobre el evento como xmlData.

Puede utilizar cualquier esquema XML que desea aplicar formato xmlData, o puede usar XML no definido. Sin embargo, cuando incluye datos que son básicamente el mismo que los datos del evento que SharePoint Foundation se utiliza en sus eventos integrados, leer y procesar los registros de la base de datos es más fácil si usa las mismas etiquetas. Por ejemplo, si los datos de evento hace referencia a un objeto que no sea aquel en el que se ha generado el evento, use el patrón <RelatedItem><Id>GUID_of_other_object</Id><Relationship>some_relationship</Relationship></RelatedItem>, que es similar a qué SharePoint Foundation se usa para los eventos de ChildDelete . Vea el tema de SPAuditEntry.EventData para obtener más información sobre el XML de etiquetas que SharePoint Foundation usa.

Ejemplos

El ejemplo siguiente ( Item-Level Auditing with SharePoint Server 2007) muestra este método en uso.

SPList oList = oSiteCollection.Lists[new Guid(ListId)];
SPListItem oListItem = oList.Items.GetItemById(Convert.ToInt32(ItemId));
oListItem.Audit.WriteAuditEvent(SPAuditEventType.Custom, 
                           "CustomViewAuditEvent",  // SoureName
                           "<myXml>MyData</myXml>"  // Any arbitrary XML data
                           );

Dim oList As SPList = oSiteCollection.Lists(New Guid(ListId))
Dim oListItem As SPListItem = oList.Items.GetItemById(Convert.ToInt32(ItemId))
oListItem.Audit.WriteAuditEvent(SPAuditEventType.Custom, "CustomViewAuditEvent", "<myXml>MyData</myXml>") ' Any arbitrary XML data -  SoureName