BufferModesCollection Class

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A collection of BufferModeSettings objects. This class cannot be inherited.

public ref class BufferModesCollection sealed : System::Configuration::ConfigurationElementCollection

[System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.BufferModeSettings))]
public sealed class BufferModesCollection : System.Configuration.ConfigurationElementCollection

[<System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.BufferModeSettings))>]
type BufferModesCollection = class
    inherit ConfigurationElementCollection

Public NotInheritable Class BufferModesCollection
Inherits ConfigurationElementCollection

Inheritance: Object

ConfigurationElement

ConfigurationElementCollection
BufferModesCollection

Attributes: ConfigurationCollectionAttribute

Examples

The following code example shows how to use the BufferModesCollection type. This code example is part of a larger example provided for the HealthMonitoringSection class.


// Add a BufferModeSettings object to the BufferModes collection property.
BufferModeSettings bufferModeSetting = new BufferModeSettings("Error Log", 
    1024, 256, 512, new TimeSpan(0, 30, 0), new TimeSpan(0, 5, 0), 2);
bufferModeSetting.Name = "Operations Notification";
bufferModeSetting.MaxBufferSize = 128;
bufferModeSetting.MaxBufferThreads = 1;
bufferModeSetting.MaxFlushSize = 24;
bufferModeSetting.RegularFlushInterval = TimeSpan.MaxValue;
bufferModeSetting.UrgentFlushInterval = TimeSpan.Parse("00:01:00");
bufferModeSetting.UrgentFlushThreshold = 1;
healthMonitoringSection.BufferModes.Add(bufferModeSetting);

// Add a BufferModeSettings object to the BufferModes collection property.
healthMonitoringSection.BufferModes.Add(new BufferModeSettings("Error Log", 
    1024, 256, 512, new TimeSpan(0, 30, 0), new TimeSpan(0, 5, 0), 2));

// Display contents of the BufferModes collection property
Console.WriteLine("BufferModes Collection contains {0} values:", 
    healthMonitoringSection.BufferModes.Count);

// Display all elements.
for (System.Int32 i = 0; i < healthMonitoringSection.BufferModes.Count; i++)
{
bufferModeSetting = healthMonitoringSection.BufferModes[i];
string name = bufferModeSetting.Name;
int maxBufferSize = bufferModeSetting.MaxBufferSize;
int maxBufferThreads = bufferModeSetting.MaxBufferThreads;
int maxFlushSize = bufferModeSetting.MaxFlushSize;
TimeSpan regularFlushInterval = bufferModeSetting.RegularFlushInterval;
TimeSpan urgentFlushInterval = bufferModeSetting.UrgentFlushInterval;
int urgentFlushThreshold = bufferModeSetting.UrgentFlushThreshold;
    string item = "Name='" + name + "', MaxBufferSize =  '" + maxBufferSize + 
        "', MaxBufferThreads =  '" + maxBufferThreads +
        "', MaxFlushSize =  '" + maxFlushSize + 
        "', RegularFlushInterval =  '" + regularFlushInterval +
        "', UrgentFlushInterval =  '" + urgentFlushInterval + 
        "', UrgentFlushThreshold =  '" + urgentFlushThreshold + "'";
    Console.WriteLine("  Item {0}: {1}", i, item);
}

// Get a named BufferMode
bufferModeSetting = healthMonitoringSection.BufferModes["Error Log"];

// Remove a BufferModeSettings object from the BufferModes collection property.
healthMonitoringSection.BufferModes.Remove("Error Log");

// Clear all BufferModeSettings object from the BufferModes collection property.
healthMonitoringSection.BufferModes.Clear();


' Add a BufferModeSettings object to the BufferModes collection property.
Dim bufferModeSetting As BufferModeSettings = new BufferModeSettings("Error Log", _
    1024, 256, 512, new TimeSpan(0, 30, 0), new TimeSpan(0, 5, 0), 2)
bufferModeSetting.Name = "Operations Notification"
bufferModeSetting.MaxBufferSize = 128
bufferModeSetting.MaxBufferThreads = 1
bufferModeSetting.MaxFlushSize = 24
bufferModeSetting.RegularFlushInterval = TimeSpan.MaxValue
bufferModeSetting.UrgentFlushInterval = TimeSpan.Parse("00:01:00")
bufferModeSetting.UrgentFlushThreshold = 1
healthMonitoringSection.BufferModes.Add(bufferModeSetting)

' Add a BufferModeSettings object to the BufferModes collection property.
healthMonitoringSection.BufferModes.Add(new BufferModeSettings("Error Log", _
    1024, 256, 512, new TimeSpan(0, 30, 0), new TimeSpan(0, 5, 0), 2))

' Display contents of the BufferModes collection property
Console.WriteLine("BufferModes Collection contains {0} values:",  _
    healthMonitoringSection.BufferModes.Count)

' Display all elements.
For i As System.Int32 = 0 To healthMonitoringSection.BufferModes.Count - 1
bufferModeSetting = healthMonitoringSection.BufferModes(i)
Dim name As String = bufferModeSetting.Name
Dim maxBufferSize As Integer = bufferModeSetting.MaxBufferSize
Dim maxBufferThreads As Integer = bufferModeSetting.MaxBufferThreads
Dim maxFlushSize As Integer = bufferModeSetting.MaxFlushSize
Dim regularFlushInterval As TimeSpan = bufferModeSetting.RegularFlushInterval
Dim urgentFlushInterval As TimeSpan = bufferModeSetting.UrgentFlushInterval
Dim urgentFlushThreshold As Integer = bufferModeSetting.UrgentFlushThreshold
    Dim item As String = "Name='" & name & "', MaxBufferSize =  '" & maxBufferSize & _
        "', MaxBufferThreads =  '" & maxBufferThreads & _
        "', MaxFlushSize =  '" & maxFlushSize & _
        "', RegularFlushInterval =  '" & regularFlushInterval.ToString() & _
        "', UrgentFlushInterval =  '" & urgentFlushInterval.ToString() & _
        "', UrgentFlushThreshold =  '" & urgentFlushThreshold & "'"
    Console.WriteLine("  Item {0}: {1}", i, item)
Next

' Get a named BufferMode
bufferModeSetting = healthMonitoringSection.BufferModes("Error Log")

' Remove a BufferModeSettings object from the BufferModes collection property.
healthMonitoringSection.BufferModes.Remove("Error Log")

' Clear all BufferModeSettings object from the BufferModes collection property.
healthMonitoringSection.BufferModes.Clear()

Remarks

The BufferModeSettings object is used to define roles for event providers such as Critical, Notification, Analysis, and Logging. Each role sets buffer mode events differently. For example, a Critical role keeps the MaxBufferSize, MaxFlushSize and UrgentFlushInterval properties small, whereas an Analysis role sets those properties to higher values.

Constructors

BufferModesCollection()

Initializes a new instance of the BufferModesCollection class.

Properties

AddElementName	Gets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ClearElementName	Gets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection)
CollectionType	Gets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
Count	Gets the number of elements in the collection. (Inherited from ConfigurationElementCollection)
CurrentConfiguration	Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement)
ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement)
ElementName	Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement)
EmitClear	Gets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection)
EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement)
HasContext	Gets a value that indicates whether the CurrentConfiguration property is `null`. (Inherited from ConfigurationElement)
IsSynchronized	Gets a value indicating whether access to the collection is synchronized. (Inherited from ConfigurationElementCollection)
Item[ConfigurationProperty]	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement)
Item[Int32]	Gets the BufferModeSettings object with the specified numeric index in the collection.
Item[String]	Gets the BufferModeSettings object based on the specified key in the collection.
LockAllAttributesExcept	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockAllElementsExcept	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockAttributes	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockElements	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockItem	Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement)
Properties	Gets the collection of properties. (Inherited from ConfigurationElement)
RemoveElementName	Gets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SyncRoot	Gets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
ThrowOnDuplicate	Gets a value indicating whether an attempt to add a duplicate ConfigurationElement to the ConfigurationElementCollection will cause an exception to be thrown. (Inherited from ConfigurationElementCollection)

Methods

Add(BufferModeSettings)	Adds a BufferModeSettings object to the collection.
BaseAdd(ConfigurationElement, Boolean)	Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection)
BaseAdd(ConfigurationElement)	Adds a configuration element to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)	Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection)
BaseClear()	Removes all configuration element objects from the collection. (Inherited from ConfigurationElementCollection)
BaseGet(Int32)	Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection)
BaseGet(Object)	Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection)
BaseGetAllKeys()	Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseGetKey(Int32)	Gets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)	Indicates the index of the specified ConfigurationElement. (Inherited from ConfigurationElementCollection)
BaseIsRemoved(Object)	Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseRemove(Object)	Removes a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection)
BaseRemoveAt(Int32)	Removes the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection)
Clear()	Removes all BufferModeSettings objects from the collection.
CopyTo(ConfigurationElement[], Int32)	Copies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection)
CreateNewElement()	When overridden in a derived class, creates a new ConfigurationElement. (Inherited from ConfigurationElementCollection)
CreateNewElement(String)	Creates a new ConfigurationElement when overridden in a derived class. (Inherited from ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
Equals(Object)	Compares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection)
GetElementKey(ConfigurationElement)	Gets the element key for a specified configuration element when overridden in a derived class. (Inherited from ConfigurationElementCollection)
GetEnumerator()	Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
GetHashCode()	Gets a unique value representing the ConfigurationElementCollection instance. (Inherited from ConfigurationElementCollection)
GetTransformedAssemblyString(String)	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement)
GetTransformedTypeString(String)	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Init()	Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement)
InitializeDefault()	Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement)
IsElementName(String)	Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)	Indicates whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
IsModified()	Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection)
IsReadOnly()	Indicates whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection)
ListErrors(IList)	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Causes the configuration system to throw an exception. (Inherited from ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)	Throws an exception when a required property is not found. (Inherited from ConfigurationElement)
PostDeserialize()	Called after deserialization. (Inherited from ConfigurationElement)
PreSerialize(XmlWriter)	Called before serialization. (Inherited from ConfigurationElement)
Remove(String)	Removes a BufferModeSettings object from the collection.
Reset(ConfigurationElement)	Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ResetModified()	Resets the value of the IsModified() property to `false` when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)	Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Sets a property to the specified value. (Inherited from ConfigurationElement)
SetReadOnly()	Sets the IsReadOnly() property for the ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Reverses the effect of merging configuration information from different levels of the configuration hierarchy. (Inherited from ConfigurationElementCollection)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the ConfigurationElementCollection to an array.

(Inherited from ConfigurationElementCollection)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to

Compartilhar via