• Article

TransSynchronizationAgent.ComErrorCollection Property

Gets a collection of errors that are generated by the replication agent.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Replication (in Microsoft.SqlServer.Replication.dll)

Syntax

'Declaration
Public Overridable ReadOnly Property ComErrorCollection As IEnumerable
    Get
'Usage
Dim instance As TransSynchronizationAgent
Dim value As IEnumerable

value = instance.ComErrorCollection

public virtual IEnumerable ComErrorCollection { get; }

public:
virtual property IEnumerable^ ComErrorCollection {
    IEnumerable^ get ();
}

abstract ComErrorCollection : IEnumerable
override ComErrorCollection : IEnumerable

function get ComErrorCollection () : IEnumerable

Property Value

Type: System.Collections.IEnumerable
A IEnumerable collection of ComErrorRecord objects.

Implements

ITransSynchronizationAgent.ComErrorCollection

Remarks

To view all agent errors, you must iterate through the collection of ComErrorRecord objects.

Examples

The following example shows how to iterate through the returned error collection after an agent run.

[C#]

foreach (ComErrorRecord errorRecord in agent.ComErrorCollection)
    {
      WriteLog("[ERROR: " + errorRecord.ErrorNumber + 
          errorRecord.Description + "]");
    }