SPAudit.WriteAuditEvent method (SPAuditEventType, String, String)

發行項
05/05/2015

將記錄寫入事件的相關 SharePoint 資料庫。

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

Syntax

'宣告
Public Function WriteAuditEvent ( _
    eventId As SPAuditEventType, _
    eventSource As String, _
    xmlData As String _
) As Boolean
'用途
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
)

參數

eventId
Type: Microsoft.SharePoint.SPAuditEventType

所記錄的事件類型。

eventSource
Type: System.String

呼叫的應用程式的名稱。

xmlData
Type: System.String

事件的相關資訊。

傳回值

Type: System.Boolean
在所有情況下true 。

備註

使用這個方法來撰寫自訂的事件類型的記錄或現有的事件類型的自訂版本。當您撰寫自訂的事件，請傳遞Custom的eventID 。(如果您有多個自訂的事件型別，而您想要區分它們的稽核報告中，使用WriteAuditEvent(String, String, String)方法的多載)。當您的事件類似的其中一個現有的SPAuditEventType物件，而您希望它包含在那種類型的事件的稽核報告時，傳遞適當的SPAuditEventType值為eventID。

傳遞 SharePoint 解決方案的名稱做為eventSource。(選擇性) 將當做xmlData，傳遞事件的額外資訊的多達 4000 個的字元。

您可以使用您想要格式化xmlData，任何 XML 結構描述，或者您可以使用未定義的 XML。不過，會包括在本質上是事件資料相同的資料時， SharePoint Foundation會使用它的內建事件，讀取中而且正在處理您的資料庫記錄容易得使用相同的標籤。例如，如果您的事件資料是指不在其上引發事件的物件，使用模式<RelatedItem><Id>GUID_of_other_object</Id><Relationship>some_relationship</Relationship></RelatedItem>，這是類似於何種SharePoint Foundation所使用的ChildDelete事件。如需更多有關 XML 標記的SharePoint Foundation ，請參閱「 SPAuditEntry.EventData 」主題使用。

Examples

下列範例 ( Item-Level Auditing with SharePoint Server 2007) 顯示此方法在使用中。

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