TraceListenerCollection Class

 

Provides a thread-safe list of TraceListener objects.

Namespace:   System.Diagnostics
Assembly:  System (in System.dll)

System::Object
  System.Diagnostics::TraceListenerCollection

public ref class TraceListenerCollection : IList, ICollection, 
	IEnumerable

NameDescription
System_CAPS_pubpropertyCount

Gets the number of listeners in the list.

System_CAPS_pubpropertyItem[Int32]

Gets or sets the TraceListener at the specified index.

System_CAPS_pubpropertyItem[String^]

Gets the first TraceListener in the list with the specified name.

NameDescription
System_CAPS_pubmethodAdd(TraceListener^)

Adds a TraceListener to the list.

System_CAPS_pubmethodAddRange(array<TraceListener^>^)

Adds an array of TraceListener objects to the list.

System_CAPS_pubmethodAddRange(TraceListenerCollection^)

Adds the contents of another TraceListenerCollection to the list.

System_CAPS_pubmethodClear()

Clears all the listeners from the list.

System_CAPS_pubmethodContains(TraceListener^)

Checks whether the list contains the specified listener.

System_CAPS_pubmethodCopyTo(array<TraceListener^>^, Int32)

Copies a section of the current TraceListenerCollection list to the specified array at the specified index.

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Gets an enumerator for this list.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIndexOf(TraceListener^)

Gets the index of the specified listener.

System_CAPS_pubmethodInsert(Int32, TraceListener^)

Inserts the listener at the specified index.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRemove(String^)

Removes from the collection the first TraceListener with the specified name.

System_CAPS_pubmethodRemove(TraceListener^)

Removes from the collection the specified TraceListener.

System_CAPS_pubmethodRemoveAt(Int32)

Removes from the collection the TraceListener at the specified index.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection::CopyTo(Array^, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Copies a section of the current TraceListenerCollection to the specified array of TraceListener objects.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList::Add(Object^)

This API supports the product infrastructure and is not intended to be used directly from your code. Adds a trace listener to the TraceListenerCollection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList::Contains(Object^)

This API supports the product infrastructure and is not intended to be used directly from your code. Determines whether the TraceListenerCollection contains a specific object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList::IndexOf(Object^)

This API supports the product infrastructure and is not intended to be used directly from your code. Determines the index of a specific object in the TraceListenerCollection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList::Insert(Int32, Object^)

This API supports the product infrastructure and is not intended to be used directly from your code. Inserts a TraceListener object at the specified position in the TraceListenerCollection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList::Remove(Object^)

This API supports the product infrastructure and is not intended to be used directly from your code. Removes an object from the TraceListenerCollection.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection::IsSynchronized

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether access to the TraceListenerCollection is synchronized (thread safe).

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection::SyncRoot

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an object that can be used to synchronize access to the TraceListenerCollection.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList::IsFixedSize

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the TraceListenerCollection has a fixed size.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList::IsReadOnly

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the TraceListenerCollection is read-only

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList::Item[Int32]

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the TraceListener at the specified index in the TraceListenerCollection.

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

The TraceListenerCollection list is used to specify the output listeners for the Trace::Listeners and the Debug::Listeners collections. You cannot create an instance of this class.

This list is thread-safe, however the methods used to access the list and the enumerator do not take synchronization locks. Instead, the collection is copied, the copy is modified, and a reference is set to the copy of the collection. Methods like Add, Remove, and Clear modify the elements in the collection.

The TraceListenerCollection class provides the Count property for information about the list. It also provides the following methods: Contains, GetEnumerator, IndexOf.

This class also provides the following methods to modify the list: Add, Clear, Insert, and Remove. The CopyTo method copies a part of the list to an array. The RemoveAt method deletes the list member at a specified index number.

The following example creates a TextWriterTraceListener that writes to the console screen. The code then adds the new listener to the Trace::Listeners.

// Create a ConsoletTraceListener and add it to the trace listeners.
#if defined(TRACE)
ConsoleTraceListener^ myWriter = gcnew ConsoleTraceListener( );
Trace::Listeners->Add( myWriter );
#endif

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: