Share via

EventInfoCollection Class

  • Article

SQL Server Foundation Class collection class for EventInfo objects.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcCollection<EventInfo, EventInfo.Key, Package>
    Microsoft.SqlServer.Management.Sdk.Sfc.SfcCollatedDictionaryCollection<EventInfo, EventInfo.Key, Package>
      Microsoft.SqlServer.Management.XEvent.EventInfoCollection

Namespace:  Microsoft.SqlServer.Management.XEvent
Assembly:  Microsoft.SqlServer.Management.XEvent (in Microsoft.SqlServer.Management.XEvent.dll)

Syntax

'Declaration
Public NotInheritable Class EventInfoCollection _
    Inherits SfcCollatedDictionaryCollection(Of EventInfo, EventInfo.Key, Package)
'Usage
Dim instance As EventInfoCollection

public sealed class EventInfoCollection : SfcCollatedDictionaryCollection<EventInfo, EventInfo.Key, Package>

public ref class EventInfoCollection sealed : public SfcCollatedDictionaryCollection<EventInfo^, EventInfo.Key^, Package^>

[<SealedAttribute>]
type EventInfoCollection =  
    class 
        inherit SfcCollatedDictionaryCollection<EventInfo, EventInfo.Key, Package>
    end

public final class EventInfoCollection extends SfcCollatedDictionaryCollection<EventInfo, EventInfo.Key, Package>

The EventInfoCollection type exposes the following members.

Properties

  Name Description
Public property Ascending Gets or sets a value indicating whether to sort in ascending order. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)
Public property Count Gets the number of elements contained in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)
Protected property Initialized Gets a value indicating whether the collection has been initialized. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public property IsReadOnly Gets a value indicating whether the collection is read-only. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)
Public property IsSynchronized Gets or sets a value indicating whether access to the collection is synchronized (thread safe). Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public property Item[K] Gets the item specified by the key. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public property Item[String] Gets the EventInfo object with the specified name.
Protected property Parent Gets or sets the type of the parent object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public property SyncRoot Gets or sets an object that can be used to synchronize access to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)

Top

Methods

  Name Description
Public method Add Adds the specified object to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public method Clear Removes all items from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)
Public method Contains(T) Determines whether the collection contains the specified object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)
Public method Contains(String) Determines whether the collection contains the Event object specified by the name parameter.
Public method CopyTo(array<T[], Int32) Copies the elements from the collection to the specified array, starting at the specified array index. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)
Public method CopyTo(Array, Int32) Copies the elements from the collection to the specified array, starting at the specified array index. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public method Equals (Inherited from Object.)
Public method GetEnumerator Returns an enumerator that can iterate through the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Refresh() Refreshes the collection by creating new and merging existing objects and properties in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public method Refresh(Boolean) Refreshes the collection by creating new and merging existing objects and properties in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public method Remove Removes the specified object from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)
Protected method RemoveInternal Marks the specified object for removal. The state of the object is set to ToBeDropped. The object will be removed when the parent is altered or dropped. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Protected method Rename Renames the specified object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Public method ToString (Inherited from Object.)
Public method TryGetValue Gets the value associated with the specified key. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IComparer<K>.Compare Do not reference this member directly in your code. It supports the SQL Server infrastructure. Compares two keys. (Inherited from SfcCollatedDictionaryCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate property IListSource.ContainsListCollection Gets a value indicating whether the collection is a collection of IList objects. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Gets an enumerator that can iterate the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method IListSource.GetList Returns an IList object that can be bound to a data source from an object that does not implement the IList interface. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.Add Adds the specified object to the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.AddShadow Adds the specified object to the shadow collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate property ISfcCollection.Count Gets the number of items contained in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.EnsureInitialized Initializes the collection from the server. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.FinishMerge Swaps the new collection for the old collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.GetCollectionElementNameImpl Gets the URN suffix for elements in the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.GetElementFactory Gets the factory that is used to instantiate objects for the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.GetExisting Uses the specified key to retrieve an existing item from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.GetObjectByKey Uses the specified key to retrieve an object from the collection. If a matching object is not found, the object is created, and added to the collection (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate property ISfcCollection.Initialized Gets or sets a value indicating whether the collection has been initialized. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate property ISfcCollection.Parent Gets the parent object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.PrepareMerge Prepares to merge fresh query results into the existing collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.Remove Removes the specified object from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.RemoveElement Removes the specified element from the collection. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)
Explicit interface implemetationPrivate method ISfcCollection.Rename Renames the specified object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcCollection<T, K, ParentT>.)

Top

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Management.XEvent Namespace