SPAudit.WriteAuditEvent method (SPAuditEventType, String, String)

Artigo
05/12/2015

Grava um registro de um evento para o banco de dados do SharePoint.

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

Syntax

'Declaração
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
Type: Microsoft.SharePoint.SPAuditEventType

O tipo de evento a ser registrado.

eventSource
Type: System.String

O nome do aplicativo de chamada.

xmlData
Type: System.String

As informações sobre o evento.

Valor retornado

Type: System.Boolean
true em todos os casos.

Comentários

Use esse método para gravar registros de tipos de evento personalizado ou versões personalizadas dos tipos de eventos existentes. Passe Custom para eventID quando você estiver escrevendo um evento personalizado. (Se você tiver mais de um tipo de evento personalizado e você desejar para diferenciá-los em relatórios de auditoria, use a sobrecarga de WriteAuditEvent(String, String, String) do método). Ao seu evento é semelhante a um dos objetos SPAuditEventType existente e deseja que ele incluído nos relatórios de auditoria desse tipo de evento, passa o valor apropriado de SPAuditEventType para eventID.

Passe o nome da solução do SharePoint como eventSource. Opcionalmente, passe até 4000 caracteres de informações adicionais sobre o evento, como xmlData.

Você pode usar qualquer esquema XML que você deseja formatar xmlDataou você pode usar XML indefinido. No entanto, quando você está incluindo dados que são essencialmente os mesmos que os dados de evento que SharePoint Foundation usa em seus eventos internos, ler e processar os registros do banco de dados é mais fácil se você usar as mesmas marcas. Por exemplo, se seus dados de evento se refere a um objeto diferente em que o evento foi gerado, use o padrão <RelatedItem><Id>GUID_of_other_object</Id><Relationship>some_relationship</Relationship></RelatedItem>, que é semelhante ao que SharePoint Foundation usa para eventos de ChildDelete . Consulte o tópico para SPAuditEntry.EventData para obter mais informações sobre o XML marcas que SharePoint Foundation usa.

Examples

O exemplo a seguir (da Item-Level Auditing with SharePoint Server 2007) mostra esse método em 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