SPAudit.WriteAuditEvent - Méthode (SPAuditEventType, String, String)

Article
05/12/2015

Écrit un enregistrement sur un événement dans la base de données SharePoint.

Espace de noms : Microsoft.SharePoint
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Function WriteAuditEvent ( _
    eventId As SPAuditEventType, _
    eventSource As String, _
    xmlData As String _
) As Boolean
'Utilisation
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
)

Paramètres

eventId
Type : Microsoft.SharePoint.SPAuditEventType

Le type d'événement enregistré.

eventSource
Type : System.String

Le nom de l'application appelante.

xmlData
Type : System.String

Les informations relatives à l'événement.

Valeur renvoyée

Type : System.Boolean
true dans tous les cas.

Remarques

Utilisez cette méthode pour écrire des enregistrements de types d'événements personnalisés ou des versions personnalisées de types d'événements existants. Passer Custom pour eventID lorsque vous écrivez un événement personnalisé. (Si vous avez plus d'un type d'événement personnalisé et que vous voulez distinguer dans les rapports d'audit, utilisez la surcharge de la méthode de le WriteAuditEvent(String, String, String) .) Lors de votre événement semblable à l'un des objets existants SPAuditEventType et qu'il est inclus dans les rapports d'audit de ce type d'événement, vous passez la valeur appropriée de SPAuditEventType de eventID.

Passez le nom de votre solution SharePoint en tant que eventSource. Le cas échéant, passer jusqu'à 4000 caractères de plus d'informations sur l'événement en tant que xmlData.

Vous pouvez utiliser n'importe quel schéma XML que vous souhaitez mettre en forme xmlData, ou vous pouvez utiliser XML non défini. Toutefois, lorsque vous incluez des données sont essentiellement le même que les données d'événement qui SharePoint Foundation utilise dans ses événements intégrées, la lecture et le traitement des enregistrements de votre base de données est plus facile si vous utilisez les mêmes balises. Par exemple, si vos données d'événement fait référence à un objet autre que celui sur lequel l'événement a été déclenché, utiliser le modèle <RelatedItem><Id>GUID_of_other_object</Id><Relationship>some_relationship</Relationship></RelatedItem>, qui est semblable à ce que SharePoint Foundation utilise pour les événements ChildDelete . Pour voir la rubrique SPAuditEntry.EventData pour plus d'informations sur le code XML des balises qui SharePoint Foundation utilise.

Exemples

L'exemple suivant ( Item-Level Auditing with SharePoint Server 2007) illustre cette méthode en cours d'utilisation.

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