Downloads:
2,562
Downloads of v 0.2.0.14:
345
Last Update:
13 Jan 2015
Package Maintainer(s):
Software Author(s):
- Edward Wilde & Kevin Holditch
Tags:
- Software Specific:
- Software Site
- Software License
- Package Specific:
- Possible Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
crane
This is not the latest version of crane available.
- 1
- 2
- 3
0.2.0.14 | Updated: 13 Jan 2015
- Software Specific:
- Software Site
- Software License
- Package Specific:
- Possible Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
2,562
Downloads of v 0.2.0.14:
345
Maintainer(s):
Software Author(s):
- Edward Wilde & Kevin Holditch
crane 0.2.0.14
This is not the latest version of crane available.
Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by Edward Wilde & Kevin Holditch. The inclusion of Edward Wilde & Kevin Holditch trademark(s), if any, upon this webpage is solely to identify Edward Wilde & Kevin Holditch goods or services and not for commercial purposes.
- 1
- 2
- 3
Some Checks Have Failed or Are Not Yet Complete
Not All Tests Have Passed
Validation Testing Unknown
Verification Testing Unknown
Scan Testing Resulted in Flagged:
This package was submitted (and approved) prior to automated virus scanning integration into the package moderation processs.
We recommend clicking the "Details" link to make your own decision on installing this package.
Deployment Method: Individual Install, Upgrade, & Uninstall
To install crane, run the following command from the command line or from PowerShell:
To upgrade crane, run the following command from the command line or from PowerShell:
To uninstall crane, run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download crane --internalize --version=0.2.0.14 --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade crane -y --source="'INTERNAL REPO URL'" --version="'0.2.0.14'" [other options]
See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade crane -y --source="'INTERNAL REPO URL'" --version="'0.2.0.14'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install crane
win_chocolatey:
name: crane
version: '0.2.0.14'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'crane' do
action :install
source 'INTERNAL REPO URL'
version '0.2.0.14'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller crane
{
Name = "crane"
Version = "0.2.0.14"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'crane':
ensure => '0.2.0.14',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
This package was approved by moderator purity on 20 Jan 2015.
We hate writing build scripts and continuous integration (ci) templates every time we start a new project or when we work on a project that does not have them. I'm sure you do as well. This is where crane comes in. Invoke crane and it can build you a blank project, complete with a build or you can get crane to assemble you a build on an existing project. No more messing around for hours on a build server!
<?xml version="1.0"?>
<doc>
<assembly>
<name>Autofac</name>
</assembly>
<members>
<member name="T:Autofac.Core.AutoActivateService">
<summary>
Service used as a "flag" to indicate a particular component should be
automatically activated on container build.
</summary>
</member>
<member name="T:Autofac.Core.Service">
<summary>
Services are the lookup keys used to locate component instances.
</summary>
</member>
<member name="M:Autofac.Core.Service.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
</summary>
<returns>
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
</returns>
</member>
<member name="M:Autofac.Core.Service.op_Equality(Autofac.Core.Service,Autofac.Core.Service)">
<summary>
Implements the operator ==.
</summary>
<param name="left">The left operand.</param>
<param name="right">The right operand.</param>
<returns>The result of the operator.</returns>
</member>
<member name="M:Autofac.Core.Service.op_Inequality(Autofac.Core.Service,Autofac.Core.Service)">
<summary>
Implements the operator !=.
</summary>
<param name="left">The left operand.</param>
<param name="right">The right operand.</param>
<returns>The result of the operator.</returns>
</member>
<member name="M:Autofac.Core.Service.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
</summary>
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
<returns>
true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
</returns>
<exception cref="T:System.NullReferenceException">The <paramref name="obj"/> parameter is null.</exception>
</member>
<member name="M:Autofac.Core.Service.GetHashCode">
<summary>
Serves as a hash function for a particular type.
</summary>
<returns>
A hash code for the current <see cref="T:System.Object"/>.
</returns>
</member>
<member name="P:Autofac.Core.Service.Description">
<summary>
Gets a human-readable description of the service.
</summary>
<value>The description.</value>
</member>
<member name="M:Autofac.Core.AutoActivateService.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
</summary>
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
<returns>
<see langword="true"/> if the specified <see cref="T:System.Object"/> is not <see langword="null"/>
and is an <see cref="T:Autofac.Core.AutoActivateService"/>; otherwise, <see langword="false"/>.
</returns>
<remarks>
<para>
All services of this type are considered "equal."
</para>
</remarks>
</member>
<member name="M:Autofac.Core.AutoActivateService.GetHashCode">
<summary>
Serves as a hash function for a particular type.
</summary>
<returns>
A hash code for the current <see cref="T:System.Object"/>. Always <c>0</c> for this type.
</returns>
<remarks>
<para>
All services of this type are considered "equal" and use the same hash code.
</para>
</remarks>
</member>
<member name="P:Autofac.Core.AutoActivateService.Description">
<summary>
Gets the service description.
</summary>
<value>
Always returns <c>AutoActivate</c>.
</value>
</member>
<member name="T:Autofac.Builder.MetadataConfiguration`1">
<summary>
Used with the WithMetadata configuration method to
associate key-value pairs with an <see cref="T:Autofac.Core.IComponentRegistration"/>.
</summary>
<typeparam name="TMetadata">Interface with properties whose names correspond to
the property keys.</typeparam>
<remarks>This feature was suggested by OJ Reeves (@TheColonial).</remarks>
</member>
<member name="M:Autofac.Builder.MetadataConfiguration`1.For``1(System.Linq.Expressions.Expression{System.Func{`0,``0}},``0)">
<summary>
Set one of the property values.
</summary>
<typeparam name="TProperty">The type of the property.</typeparam>
<param name="propertyAccessor">An expression that accesses the property to set.</param>
<param name="value">The property value to set.</param>
</member>
<member name="T:Autofac.Core.Activators.Reflection.MostParametersConstructorSelectorResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.MostParametersConstructorSelectorResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.MostParametersConstructorSelectorResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.MostParametersConstructorSelectorResources.UnableToChooseFromMultipleConstructors">
<summary>
Looks up a localized string similar to Cannot choose between multiple constructors with equal length {0} on type '{1}'. Select the constructor explicitly, with the UsingConstructor() configuration method, when the component is registered..
</summary>
</member>
<member name="T:Autofac.Core.DependencyResolutionExceptionResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.DependencyResolutionExceptionResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.DependencyResolutionExceptionResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.DependencyResolutionExceptionResources.MessageNestingFormat">
<summary>
Looks up a localized string similar to {0} ---> {1} (See inner exception for details.).
</summary>
</member>
<member name="T:Autofac.Core.Lifetime.MatchingScopeLifetimeTags">
<summary>
Well-known tags used in setting up matching lifetime scopes.
</summary>
</member>
<member name="F:Autofac.Core.Lifetime.MatchingScopeLifetimeTags.RequestLifetimeScopeTag">
<summary>
Tag used in setting up per-request lifetime scope registrations
(e.g., per-HTTP-request or per-API-request).
</summary>
</member>
<member name="T:Autofac.Core.Registration.IModuleRegistrar">
<summary>
Interface providing fluent syntax for chaining module registrations.
</summary>
</member>
<member name="M:Autofac.Core.Registration.IModuleRegistrar.RegisterModule(Autofac.Core.IModule)">
<summary>
Add a module to the container.
</summary>
<param name="module">The module to add.</param>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="T:Autofac.Core.Registration.ModuleRegistrar">
<summary>
Basic implementation of the <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/>
interface allowing registration of modules into a <see cref="T:Autofac.ContainerBuilder"/>
in a fluent format.
</summary>
</member>
<member name="F:Autofac.Core.Registration.ModuleRegistrar._builder">
<summary>
The <see cref="T:Autofac.ContainerBuilder"/> into which registrations will be made.
</summary>
</member>
<member name="M:Autofac.Core.Registration.ModuleRegistrar.#ctor(Autofac.ContainerBuilder)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.Registration.ModuleRegistrar"/> class.
</summary>
<param name="builder">
The <see cref="T:Autofac.ContainerBuilder"/> into which registrations will be made.
</param>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="builder"/> is <see langword="null"/>.
</exception>
</member>
<member name="M:Autofac.Core.Registration.ModuleRegistrar.RegisterModule(Autofac.Core.IModule)">
<summary>
Add a module to the container.
</summary>
<param name="module">The module to add.</param>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="module"/> is <see langword="null"/>.
</exception>
</member>
<member name="T:Autofac.Features.LazyDependencies.LazyWithMetadataRegistrationSource">
<summary>
Support the <c>System.Lazy<T, TMetadata></c>
types automatically whenever type T is registered with the container.
Metadata values come from the component registration's metadata.
When a dependency of a lazy type is used, the instantiation of the underlying
component will be delayed until the Value property is first accessed.
</summary>
</member>
<member name="T:Autofac.Core.IRegistrationSource">
<summary>
Allows registrations to be made on-the-fly when unregistered
services are requested (lazy registrations.)
</summary>
</member>
<member name="M:Autofac.Core.IRegistrationSource.RegistrationsFor(Autofac.Core.Service,System.Func{Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.IComponentRegistration}})">
<summary>
Retrieve registrations for an unregistered service, to be used
by the container.
</summary>
<param name="service">The service that was requested.</param>
<param name="registrationAccessor">A function that will return existing registrations for a service.</param>
<returns>Registrations providing the service.</returns>
<remarks>
If the source is queried for service s, and it returns a component that implements both s and s', then it
will not be queried again for either s or s'. This means that if the source can return other implementations
of s', it should return these, plus the transitive closure of other components implementing their
additional services, along with the implementation of s. It is not an error to return components
that do not implement <paramref name="service"/>.
</remarks>
</member>
<member name="P:Autofac.Core.IRegistrationSource.IsAdapterForIndividualComponents">
<summary>
Gets whether the registrations provided by this source are 1:1 adapters on top
of other components (I.e. like Meta, Func or Owned.)
</summary>
</member>
<member name="T:Autofac.Features.LazyDependencies.LazyWithMetadataRegistrationSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.LazyDependencies.LazyWithMetadataRegistrationSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.LazyDependencies.LazyWithMetadataRegistrationSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.LazyDependencies.LazyWithMetadataRegistrationSourceResources.LazyWithMetadataRegistrationSourceDescription">
<summary>
Looks up a localized string similar to Lazy<T, TMetadata> Support.
</summary>
</member>
<member name="T:Autofac.Features.Metadata.MetadataViewProviderResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.Metadata.MetadataViewProviderResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.Metadata.MetadataViewProviderResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.Metadata.MetadataViewProviderResources.InvalidViewImplementation">
<summary>
Looks up a localized string similar to The type '{0}' cannot be used as a metadata view. A metadata view must be a concrete class with a parameterless or dictionary constructor..
</summary>
</member>
<member name="P:Autofac.Features.Metadata.MetadataViewProviderResources.MissingMetadata">
<summary>
Looks up a localized string similar to Export metadata for '{0}' is missing and no default value was supplied..
</summary>
</member>
<member name="T:Autofac.Features.Metadata.Meta`2">
<summary>
Provides a value along with metadata describing the value.
</summary>
<typeparam name="T">The type of the value.</typeparam>
<typeparam name="TMetadata">An interface to which metadata values can be bound.</typeparam>
</member>
<member name="M:Autofac.Features.Metadata.Meta`2.#ctor(`0,`1)">
<summary>
Create a new instance.
</summary>
<param name="value">The value described by the instance.</param>
<param name="metadata">The metadata describing the value.</param>
</member>
<member name="P:Autofac.Features.Metadata.Meta`2.Value">
<summary>
The value described by <see cref="P:Autofac.Features.Metadata.Meta`2.Metadata"/>.
</summary>
</member>
<member name="P:Autofac.Features.Metadata.Meta`2.Metadata">
<summary>
Metadata describing the value.
</summary>
</member>
<member name="T:Autofac.Features.Metadata.StronglyTypedMetaRegistrationSource">
<summary>
Support the <see cref="T:Autofac.Features.Metadata.Meta`2"/>
types automatically whenever type T is registered with the container.
Metadata values come from the component registration's metadata.
</summary>
</member>
<member name="T:Autofac.Core.Activators.Reflection.DefaultConstructorFinder">
<summary>
Finds constructors that match a finder function.
</summary>
</member>
<member name="T:Autofac.Core.Activators.Reflection.IConstructorFinder">
<summary>
Find suitable constructors from which to select.
</summary>
</member>
<member name="M:Autofac.Core.Activators.Reflection.IConstructorFinder.FindConstructors(System.Type)">
<summary>
Finds suitable constructors on the target type.
</summary>
<param name="targetType">Type to search for constructors.</param>
<returns>Suitable constructors.</returns>
</member>
<member name="M:Autofac.Core.Activators.Reflection.DefaultConstructorFinder.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.Activators.Reflection.DefaultConstructorFinder"/> class.
</summary>
<remarks>
Default to selecting all public constructors.
</remarks>
</member>
<member name="M:Autofac.Core.Activators.Reflection.DefaultConstructorFinder.#ctor(System.Func{System.Type,System.Reflection.ConstructorInfo[]})">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.Activators.Reflection.DefaultConstructorFinder"/> class.
</summary>
<param name="finder">The finder function.</param>
</member>
<member name="M:Autofac.Core.Activators.Reflection.DefaultConstructorFinder.FindConstructors(System.Type)">
<summary>
Finds suitable constructors on the target type.
</summary>
<param name="targetType">Type to search for constructors.</param>
<returns>Suitable constructors.</returns>
</member>
<member name="T:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSourceExtensions">
<summary>
Extension methods for configuring the <see cref="T:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource"/>.
</summary>
</member>
<member name="M:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSourceExtensions.WithRegistrationsAs(Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource,System.Action{Autofac.Builder.IRegistrationBuilder{System.Object,Autofac.Builder.ConcreteReflectionActivatorData,Autofac.Builder.SingleRegistrationStyle}})">
<summary>
Fluent method for setting the registration configuration on <see cref="T:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource"/>.
</summary>
<param name="source">The registration source to configure.</param>
<param name="configurationAction">A configuration action that will run on any registration provided by the source.</param>
<returns>
The <paramref name="source"/> with the registration configuration set.
</returns>
</member>
<member name="T:Autofac.ModuleRegistrationExtensions">
<summary>
Extension methods for registering <see cref="T:Autofac.Core.IModule"/> instances with a container.
</summary>
</member>
<member name="M:Autofac.ModuleRegistrationExtensions.RegisterAssemblyModules(Autofac.ContainerBuilder,System.Reflection.Assembly[])">
<summary>
Registers modules found in an assembly.
</summary>
<param name="builder">The builder to register the modules with.</param>
<param name="assemblies">The assemblies from which to register modules.</param>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="builder"/> is <see langword="null"/>.
</exception>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="M:Autofac.ModuleRegistrationExtensions.RegisterAssemblyModules(Autofac.Core.Registration.IModuleRegistrar,System.Reflection.Assembly[])">
<summary>
Registers modules found in an assembly.
</summary>
<param name="registrar">The module registrar that will make the registrations into the container.</param>
<param name="assemblies">The assemblies from which to register modules.</param>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="registrar"/> is <see langword="null"/>.
</exception>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="M:Autofac.ModuleRegistrationExtensions.RegisterAssemblyModules``1(Autofac.ContainerBuilder,System.Reflection.Assembly[])">
<summary>
Registers modules found in an assembly.
</summary>
<param name="builder">The builder to register the modules with.</param>
<param name="assemblies">The assemblies from which to register modules.</param>
<typeparam name="TModule">The type of the module to add.</typeparam>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="builder"/> is <see langword="null"/>.
</exception>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="M:Autofac.ModuleRegistrationExtensions.RegisterAssemblyModules``1(Autofac.Core.Registration.IModuleRegistrar,System.Reflection.Assembly[])">
<summary>
Registers modules found in an assembly.
</summary>
<param name="registrar">The module registrar that will make the registrations into the container.</param>
<param name="assemblies">The assemblies from which to register modules.</param>
<typeparam name="TModule">The type of the module to add.</typeparam>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="registrar"/> is <see langword="null"/>.
</exception>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="M:Autofac.ModuleRegistrationExtensions.RegisterAssemblyModules(Autofac.ContainerBuilder,System.Type,System.Reflection.Assembly[])">
<summary>
Registers modules found in an assembly.
</summary>
<param name="builder">The builder to register the modules with.</param>
<param name="moduleType">The <see cref="T:System.Type"/> of the module to add.</param>
<param name="assemblies">The assemblies from which to register modules.</param>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="builder"/> or <paramref name="moduleType"/> is <see langword="null"/>.
</exception>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="M:Autofac.ModuleRegistrationExtensions.RegisterAssemblyModules(Autofac.Core.Registration.IModuleRegistrar,System.Type,System.Reflection.Assembly[])">
<summary>
Registers modules found in an assembly.
</summary>
<param name="registrar">The module registrar that will make the registrations into the container.</param>
<param name="moduleType">The <see cref="T:System.Type"/> of the module to add.</param>
<param name="assemblies">The assemblies from which to register modules.</param>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="registrar"/> or <paramref name="moduleType"/> is <see langword="null"/>.
</exception>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="M:Autofac.ModuleRegistrationExtensions.RegisterModule``1(Autofac.ContainerBuilder)">
<summary>
Add a module to the container.
</summary>
<param name="builder">The builder to register the module with.</param>
<typeparam name="TModule">The module to add.</typeparam>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="builder"/> is <see langword="null"/>.
</exception>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="M:Autofac.ModuleRegistrationExtensions.RegisterModule``1(Autofac.Core.Registration.IModuleRegistrar)">
<summary>
Add a module to the container.
</summary>
<param name="registrar">The module registrar that will make the registration into the container.</param>
<typeparam name="TModule">The module to add.</typeparam>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="registrar"/> is <see langword="null"/>.
</exception>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="M:Autofac.ModuleRegistrationExtensions.RegisterModule(Autofac.ContainerBuilder,Autofac.Core.IModule)">
<summary>
Add a module to the container.
</summary>
<param name="builder">The builder to register the module with.</param>
<param name="module">The module to add.</param>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="builder"/> or <paramref name="module"/> is <see langword="null"/>.
</exception>
<returns>
The <see cref="T:Autofac.Core.Registration.IModuleRegistrar"/> to allow
additional chained module registrations.
</returns>
</member>
<member name="T:Autofac.ModuleResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.ModuleResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.ModuleResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.ModuleResources.ThisAssemblyUnavailable">
<summary>
Looks up a localized string similar to Module.ThisAssembly is only available in modules that inherit directly from Module..
</summary>
</member>
<member name="T:Autofac.Features.LazyDependencies.LazyRegistrationSource">
<summary>
Support the <see cref="T:System.Lazy`1"/>
type automatically whenever type T is registered with the container.
When a dependency of a lazy type is used, the instantiation of the underlying
component will be delayed until the Value property is first accessed.
</summary>
</member>
<member name="T:Autofac.Features.GeneratedFactories.FactoryGenerator">
<summary>
Generates context-bound closures that represent factories from
a set of heuristics based on delegate type signatures.
</summary>
</member>
<member name="M:Autofac.Features.GeneratedFactories.FactoryGenerator.#ctor(System.Type,Autofac.Core.Service,Autofac.Features.GeneratedFactories.ParameterMapping)">
<summary>
Create a factory generator.
</summary>
<param name="service">The service that will be activated in
order to create the products of the factory.</param>
<param name="delegateType">The delegate to provide as a factory.</param>
<param name="parameterMapping">The parameter mapping mode to use.</param>
</member>
<member name="M:Autofac.Features.GeneratedFactories.FactoryGenerator.#ctor(System.Type,Autofac.Core.IComponentRegistration,Autofac.Features.GeneratedFactories.ParameterMapping)">
<summary>
Create a factory generator.
</summary>
<param name="productRegistration">The component that will be activated in
order to create the products of the factory.</param>
<param name="delegateType">The delegate to provide as a factory.</param>
<param name="parameterMapping">The parameter mapping mode to use.</param>
</member>
<member name="M:Autofac.Features.GeneratedFactories.FactoryGenerator.GenerateFactory(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Generates a factory delegate that closes over the provided context.
</summary>
<param name="context">The context in which the factory will be used.</param>
<param name="parameters">Parameters provided to the resolve call for the factory itself.</param>
<returns>A factory delegate that will work within the context.</returns>
</member>
<member name="M:Autofac.Features.GeneratedFactories.FactoryGenerator.GenerateFactory``1(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Generates a factory delegate that closes over the provided context.
</summary>
<param name="context">The context in which the factory will be used.</param>
<param name="parameters">Parameters provided to the resolve call for the factory itself.</param>
<returns>A factory delegate that will work within the context.</returns>
</member>
<member name="T:Autofac.Builder.ConcreteReflectionActivatorData">
<summary>
Reflection activator data for concrete types.
</summary>
</member>
<member name="T:Autofac.Builder.ReflectionActivatorData">
<summary>
Builder for reflection-based activators.
</summary>
</member>
<member name="M:Autofac.Builder.ReflectionActivatorData.#ctor(System.Type)">
<summary>
Specify a reflection activator for the given type.
</summary>
<param name="implementer">Type that will be activated.</param>
</member>
<member name="P:Autofac.Builder.ReflectionActivatorData.ImplementationType">
<summary>
Get the implementation type.
</summary>
</member>
<member name="P:Autofac.Builder.ReflectionActivatorData.ConstructorFinder">
<summary>
The constructor finder for the registration.
</summary>
</member>
<member name="P:Autofac.Builder.ReflectionActivatorData.ConstructorSelector">
<summary>
The constructor selector for the registration.
</summary>
</member>
<member name="P:Autofac.Builder.ReflectionActivatorData.ConfiguredParameters">
<summary>
The explicitly bound constructor parameters.
</summary>
</member>
<member name="P:Autofac.Builder.ReflectionActivatorData.ConfiguredProperties">
<summary>
The explicitly bound properties.
</summary>
</member>
<member name="T:Autofac.Builder.IConcreteActivatorData">
<summary>
Activator data that can provide an IInstanceActivator instance.
</summary>
</member>
<member name="P:Autofac.Builder.IConcreteActivatorData.Activator">
<summary>
The instance activator based on the provided data.
</summary>
</member>
<member name="M:Autofac.Builder.ConcreteReflectionActivatorData.#ctor(System.Type)">
<summary>
Specify a reflection activator for the given type.
</summary>
<param name="implementer">Type that will be activated.</param>
</member>
<member name="P:Autofac.Builder.ConcreteReflectionActivatorData.Activator">
<summary>
The instance activator based on the provided data.
</summary>
</member>
<member name="T:Autofac.Builder.ContainerBuildOptions">
<summary>
Parameterises the construction of a container by a <see cref="T:Autofac.ContainerBuilder"/>.
</summary>
</member>
<member name="F:Autofac.Builder.ContainerBuildOptions.None">
<summary>
No options - the default behavior for container building.
</summary>
</member>
<member name="F:Autofac.Builder.ContainerBuildOptions.ExcludeDefaultModules">
<summary>
Prevents inclusion of standard modules like support for
relationship types including <see cref="T:System.Collections.Generic.IEnumerable`1"/> etc.
</summary>
</member>
<member name="F:Autofac.Builder.ContainerBuildOptions.IgnoreStartableComponents">
<summary>
Does not call <see cref="M:Autofac.IStartable.Start"/> on components implementing
this interface (useful for module testing.)
</summary>
</member>
<member name="T:Autofac.Builder.IRegistrationBuilder`3">
<summary>
Data structure used to construct registrations.
</summary>
<typeparam name="TLimit">The most specific type to which instances of the registration
can be cast.</typeparam>
<typeparam name="TActivatorData">Activator builder type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style type.</typeparam>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.ExternallyOwned">
<summary>
Configure the component so that instances are never disposed by the container.
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.OwnedByLifetimeScope">
<summary>
Configure the component so that instances that support IDisposable are
disposed by the container (default.)
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerDependency">
<summary>
Configure the component so that every dependent component or call to Resolve()
gets a new, unique instance (default.)
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.SingleInstance">
<summary>
Configure the component so that every dependent component or call to Resolve()
gets the same, shared instance.
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerLifetimeScope">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a single ILifetimeScope gets the same, shared instance. Dependent components in
different lifetime scopes will get different instances.
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerMatchingLifetimeScope(System.Object[])">
<summary>
Configure the component so that every dependent component or call to Resolve() within
a ILifetimeScope tagged with any of the provided tags value gets the same, shared instance.
Dependent components in lifetime scopes that are children of the tagged scope will
share the parent's instance. If no appropriately tagged scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<param name="lifetimeScopeTag">Tag applied to matching lifetime scopes.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerOwned``1">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a ILifetimeScope created by an owned instance gets the same, shared instance.
Dependent components in lifetime scopes that are children of the owned instance scope will
share the parent's instance. If no appropriate owned instance scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<typeparam name="TService">Service type.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerOwned(System.Type)">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a ILifetimeScope created by an owned instance gets the same, shared instance.
Dependent components in lifetime scopes that are children of the owned instance scope will
share the parent's instance. If no appropriate owned instance scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<param name="serviceType">Service type.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerOwned``1(System.Object)">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a ILifetimeScope created by an owned instance gets the same, shared instance.
Dependent components in lifetime scopes that are children of the owned instance scope will
share the parent's instance. If no appropriate owned instance scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<typeparam name="TService">The service type provided by the component.</typeparam>
<param name="serviceKey">Key to associate with the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerOwned(System.Object,System.Type)">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a ILifetimeScope created by an owned instance gets the same, shared instance.
Dependent components in lifetime scopes that are children of the owned instance scope will
share the parent's instance. If no appropriate owned instance scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<param name="serviceKey">Key to associate with the component.</param>
<param name="serviceType">The service type provided by the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.As``1">
<summary>
Configure the services that the component will provide. The generic parameter(s) to As()
will be exposed as TypedService instances.
</summary>
<typeparam name="TService">Service type.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.As``2">
<summary>
Configure the services that the component will provide. The generic parameter(s) to As()
will be exposed as TypedService instances.
</summary>
<typeparam name="TService1">Service type.</typeparam>
<typeparam name="TService2">Service type.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.As``3">
<summary>
Configure the services that the component will provide. The generic parameter(s) to As()
will be exposed as TypedService instances.
</summary>
<typeparam name="TService1">Service type.</typeparam>
<typeparam name="TService2">Service type.</typeparam>
<typeparam name="TService3">Service type.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.As(System.Type[])">
<summary>
Configure the services that the component will provide.
</summary>
<param name="services">Service types to expose.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.As(Autofac.Core.Service[])">
<summary>
Configure the services that the component will provide.
</summary>
<param name="services">Services to expose.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.Named(System.String,System.Type)">
<summary>
Provide a textual name that can be used to retrieve the component.
</summary>
<param name="serviceName">Named service to associate with the component.</param>
<param name="serviceType">The service type provided by the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.Named``1(System.String)">
<summary>
Provide a textual name that can be used to retrieve the component.
</summary>
<param name="serviceName">Named service to associate with the component.</param>
<typeparam name="TService">The service type provided by the component.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.Keyed(System.Object,System.Type)">
<summary>
Provide a key that can be used to retrieve the component.
</summary>
<param name="serviceKey">Key to associate with the component.</param>
<param name="serviceType">The service type provided by the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.Keyed``1(System.Object)">
<summary>
Provide a key that can be used to retrieve the component.
</summary>
<param name="serviceKey">Key to associate with the component.</param>
<typeparam name="TService">The service type provided by the component.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.OnPreparing(System.Action{Autofac.Core.PreparingEventArgs})">
<summary>
Add a handler for the Preparing event. This event allows manipulating of the parameters
that will be provided to the component.
</summary>
<param name="handler">The event handler.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.OnActivating(System.Action{Autofac.Core.IActivatingEventArgs{`0}})">
<summary>
Add a handler for the Activating event.
</summary>
<param name="handler">The event handler.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.OnActivated(System.Action{Autofac.Core.IActivatedEventArgs{`0}})">
<summary>
Add a handler for the Activated event.
</summary>
<param name="handler">The event handler.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.PropertiesAutowired(Autofac.PropertyWiringOptions)">
<summary>
Configure the component so that any properties whose types are registered in the
container will be wired to instances of the appropriate service.
</summary>
<param name="options">Set wiring options such as circular dependency wiring support.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.WithMetadata(System.String,System.Object)">
<summary>
Associates data with the component.
</summary>
<param name="key">Key by which the data can be located.</param>
<param name="value">The data value.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.WithMetadata(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})">
<summary>
Associates data with the component.
</summary>
<param name="properties">The extended properties to associate with the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.IRegistrationBuilder`3.WithMetadata``1(System.Action{Autofac.Builder.MetadataConfiguration{``0}})">
<summary>
Associates data with the component.
</summary>
<typeparam name="TMetadata">A type with properties whose names correspond to the
property names to configure.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="P:Autofac.Builder.IRegistrationBuilder`3.ActivatorData">
<summary>
The activator data.
</summary>
</member>
<member name="P:Autofac.Builder.IRegistrationBuilder`3.RegistrationStyle">
<summary>
The registration style.
</summary>
</member>
<member name="P:Autofac.Builder.IRegistrationBuilder`3.RegistrationData">
<summary>
The registration data.
</summary>
</member>
<member name="T:Autofac.Core.Registration.CopyOnWriteRegistry">
<summary>
Delegates registration lookups to a specified registry. When write operations are applied,
initialises a new 'writeable' registry.
</summary>
<remarks>
Safe for concurrent access by multiple readers. Write operations are single-threaded.
</remarks>
</member>
<member name="T:Autofac.Core.IComponentRegistry">
<summary>
Provides component registrations according to the services they provide.
</summary>
</member>
<member name="M:Autofac.Core.IComponentRegistry.TryGetRegistration(Autofac.Core.Service,Autofac.Core.IComponentRegistration@)">
<summary>
Attempts to find a default registration for the specified service.
</summary>
<param name="service">The service to look up.</param>
<param name="registration">The default registration for the service.</param>
<returns>True if a registration exists.</returns>
</member>
<member name="M:Autofac.Core.IComponentRegistry.IsRegistered(Autofac.Core.Service)">
<summary>
Determines whether the specified service is registered.
</summary>
<param name="service">The service to test.</param>
<returns>True if the service is registered.</returns>
</member>
<member name="M:Autofac.Core.IComponentRegistry.Register(Autofac.Core.IComponentRegistration)">
<summary>
Register a component.
</summary>
<param name="registration">The component registration.</param>
</member>
<member name="M:Autofac.Core.IComponentRegistry.Register(Autofac.Core.IComponentRegistration,System.Boolean)">
<summary>
Register a component.
</summary>
<param name="registration">The component registration.</param>
<param name="preserveDefaults">If true, existing defaults for the services provided by the
component will not be changed.</param>
</member>
<member name="M:Autofac.Core.IComponentRegistry.RegistrationsFor(Autofac.Core.Service)">
<summary>
Selects from the available registrations after ensuring that any
dynamic registration sources that may provide <paramref name="service"/>
have been invoked.
</summary>
<param name="service">The service for which registrations are sought.</param>
<returns>Registrations supporting <paramref name="service"/>.</returns>
</member>
<member name="M:Autofac.Core.IComponentRegistry.AddRegistrationSource(Autofac.Core.IRegistrationSource)">
<summary>
Add a registration source that will provide registrations on-the-fly.
</summary>
<param name="source">The source to register.</param>
</member>
<member name="P:Autofac.Core.IComponentRegistry.Registrations">
<summary>
Enumerate the registered components.
</summary>
</member>
<member name="E:Autofac.Core.IComponentRegistry.Registered">
<summary>
Fired whenever a component is registered - either explicitly or via a
<see cref="T:Autofac.Core.IRegistrationSource"/>.
</summary>
</member>
<member name="P:Autofac.Core.IComponentRegistry.Sources">
<summary>
Gets the registration sources that are used by the registry.
</summary>
</member>
<member name="P:Autofac.Core.IComponentRegistry.HasLocalComponents">
<summary>
True if the registry contains its own components; false if it is forwarding
registrations from another external registry.
</summary>
<remarks>This property is used when walking up the scope tree looking for
registrations for a new customised scope. (See issue 336.)</remarks>
</member>
<member name="E:Autofac.Core.IComponentRegistry.RegistrationSourceAdded">
<summary>
Fired when an <see cref="T:Autofac.Core.IRegistrationSource"/> is added to the registry.
</summary>
</member>
<member name="T:Autofac.Features.Variance.ContravariantRegistrationSource">
<summary>
Enables contravariant <code>Resolve()</code> for interfaces that have a single contravariant ('in') parameter.
</summary>
<example>
interface IHandler<in TCommand>
{
void Handle(TCommand command);
}
class Command { }
class DerivedCommand : Command { }
class CommandHandler : IHandler<Command> { ... }
var builder = new ContainerBuilder();
builder.RegisterSource(new ContravariantRegistrationSource());
builder.RegisterType<CommandHandler>();
var container = builder.Build();
// Source enables this line, even though IHandler<Command> is the
// actual registered type.
var handler = container.Resolve<IHandler<DerivedCommand>>();
handler.Handle(new DerivedCommand());
</example>
</member>
<member name="M:Autofac.Features.Variance.ContravariantRegistrationSource.RegistrationsFor(Autofac.Core.Service,System.Func{Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.IComponentRegistration}})">
<summary>
Retrieve registrations for an unregistered service, to be used
by the container.
</summary>
<param name="service">The service that was requested.</param>
<param name="registrationAccessor">A function that will return existing registrations for a service.</param>
<returns>Registrations providing the service.</returns>
<remarks>
If the source is queried for service s, and it returns a component that implements both s and s', then it
will not be queried again for either s or s'. This means that if the source can return other implementations
of s', it should return these, plus the transitive closure of other components implementing their
additional services, along with the implementation of s. It is not an error to return components
that do not implement <paramref name="service"/>.
</remarks>
</member>
<member name="P:Autofac.Features.Variance.ContravariantRegistrationSource.IsAdapterForIndividualComponents">
<summary>
Gets whether the registrations provided by this source are 1:1 adapters on top
of other components (I.e. like Meta, Func or Owned.)
</summary>
</member>
<member name="T:Autofac.PropertyWiringOptions">
<summary>
Options that can be applied when autowiring properties on a component. (Multiple options can
be specified using bitwise 'or' - e.g. AllowCircularDependencies | PreserveSetValues.
</summary>
</member>
<member name="F:Autofac.PropertyWiringOptions.None">
<summary>
Default behavior. Circular dependencies are not allowed; existing non-default
property values are overwritten.
</summary>
</member>
<member name="F:Autofac.PropertyWiringOptions.AllowCircularDependencies">
<summary>
Allows property-property and property-constructor circular dependency wiring.
This flag moves property wiring from the Activating to the Activated event.
</summary>
</member>
<member name="F:Autofac.PropertyWiringOptions.PreserveSetValues">
<summary>
If specified, properties that already have a non-default value will be left
unchanged in the wiring operation.
</summary>
</member>
<member name="T:Autofac.Builder.RegistrationBuilder">
<summary>
Static factory methods to simplify the creation and handling of IRegistrationBuilder{L,A,R}.
</summary>
<example>
To create an <see cref="T:Autofac.Core.IComponentRegistration"/> for a specific type, use:
<code>
var cr = RegistrationBuilder.ForType(t).CreateRegistration();
</code>
The full builder syntax is supported:
<code>
var cr = RegistrationBuilder.ForType(t).Named("foo").ExternallyOwned().CreateRegistration();
</code>
</example>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder.ForDelegate``1(System.Func{Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},``0})">
<summary>
Creates a registration builder for the provided delegate.
</summary>
<typeparam name="T">Instance type returned by delegate.</typeparam>
<param name="delegate">Delegate to register.</param>
<returns>A registration builder.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder.ForDelegate(System.Type,System.Func{Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Object})">
<summary>
Creates a registration builder for the provided delegate.
</summary>
<param name="delegate">Delegate to register.</param>
<param name="limitType">Most specific type return value of delegate can be cast to.</param>
<returns>A registration builder.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder.ForType``1">
<summary>
Creates a registration builder for the provided type.
</summary>
<typeparam name="TImplementer">Implementation type to register.</typeparam>
<returns>A registration builder.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder.ForType(System.Type)">
<summary>
Creates a registration builder for the provided type.
</summary>
<param name="implementationType">Implementation type to register.</param>
<returns>A registration builder.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder.CreateRegistration``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2})">
<summary>
Create an <see cref="T:Autofac.Core.IComponentRegistration"/> from a <see cref="T:Autofac.Builder.RegistrationBuilder"/>.
(There is no need to call
this method when registering components through a <see cref="T:Autofac.ContainerBuilder"/>.)
</summary>
<remarks>
When called on the result of one of the <see cref="T:Autofac.ContainerBuilder"/> methods,
the returned registration will be different from the one the builder itself registers
in the container.
</remarks>
<example>
<code>
var registration = RegistrationBuilder.ForType<Foo>().CreateRegistration();
</code>
</example>
<typeparam name="TLimit"></typeparam>
<typeparam name="TActivatorData"></typeparam>
<typeparam name="TSingleRegistrationStyle"></typeparam>
<param name="builder">The registration builder.</param>
<returns>An IComponentRegistration.</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="builder"/> is <see langword="null"/>.
</exception>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder.CreateRegistration(System.Guid,Autofac.Builder.RegistrationData,Autofac.Core.IInstanceActivator,System.Collections.Generic.IEnumerable{Autofac.Core.Service})">
<summary>
Create an IComponentRegistration from data.
</summary>
<param name="id">Id of the registration.</param>
<param name="data">Registration data.</param>
<param name="activator">Activator.</param>
<param name="services">Services provided by the registration.</param>
<returns>An IComponentRegistration.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder.CreateRegistration(System.Guid,Autofac.Builder.RegistrationData,Autofac.Core.IInstanceActivator,System.Collections.Generic.IEnumerable{Autofac.Core.Service},Autofac.Core.IComponentRegistration)">
<summary>
Create an IComponentRegistration from data.
</summary>
<param name="id">Id of the registration.</param>
<param name="data">Registration data.</param>
<param name="activator">Activator.</param>
<param name="services">Services provided by the registration.</param>
<param name="target">Optional; target registration.</param>
<returns>An IComponentRegistration.</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="activator"/> or <paramref name="data"/> is <see langword="null"/>.
</exception>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder.RegisterSingleComponent``3(Autofac.Core.IComponentRegistry,Autofac.Builder.IRegistrationBuilder{``0,``1,``2})">
<summary>
Register a component in the component registry. This helper method is necessary
in order to execute OnRegistered hooks and respect PreserveDefaults.
</summary>
<remarks>Hoping to refactor this out.</remarks>
<typeparam name="TLimit"></typeparam>
<typeparam name="TActivatorData"></typeparam>
<typeparam name="TSingleRegistrationStyle"></typeparam>
<param name="cr">Component registry to make registration in.</param>
<param name="builder">Registration builder with data for new registration.</param>
</member>
<member name="T:Autofac.Builder.RegistrationBuilderResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationBuilderResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationBuilderResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationBuilderResources.ComponentDoesNotSupportService">
<summary>
Looks up a localized string similar to The type '{0}' is not assignable to service '{1}'..
</summary>
</member>
<member name="T:Autofac.Builder.RegistrationExtensions">
<summary>
Adds registration syntax for less commonly-used features.
</summary>
<remarks>
These features are in this namespace because they will remain accessible to
applications originally written against Autofac 1.4. In Autofac 2, this functionality
is implicitly provided and thus making explicit registrations is rarely necessary.
</remarks>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.RegisterGeneratedFactory(Autofac.ContainerBuilder,System.Type)">
<summary>
Registers a factory delegate.
</summary>
<param name="builder">Container builder.</param>
<param name="delegateType">Factory type to generate.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<remarks>Factory delegates are provided automatically in Autofac 2,
and this method is generally not required.</remarks>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.RegisterGeneratedFactory(Autofac.ContainerBuilder,System.Type,Autofac.Core.Service)">
<summary>
Registers a factory delegate.
</summary>
<param name="builder">Container builder.</param>
<param name="delegateType">Factory type to generate.</param>
<param name="service">The service that the delegate will return instances of.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<remarks>Factory delegates are provided automatically in Autofac 2, and
this method is generally not required.</remarks>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.RegisterGeneratedFactory``1(Autofac.ContainerBuilder,Autofac.Core.Service)">
<summary>
Registers a factory delegate.
</summary>
<typeparam name="TDelegate">The type of the delegate.</typeparam>
<param name="builder">Container builder.</param>
<param name="service">The service that the delegate will return instances of.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<remarks>Factory delegates are provided automatically in Autofac 2,
and this method is generally not required.</remarks>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.RegisterGeneratedFactory``1(Autofac.ContainerBuilder)">
<summary>
Registers a factory delegate.
</summary>
<typeparam name="TDelegate">The type of the delegate.</typeparam>
<param name="builder">Container builder.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<remarks>Factory delegates are provided automatically in Autofac 2,
and this method is generally not required.</remarks>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.NamedParameterMapping``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2})">
<summary>
Changes the parameter mapping mode of the supplied delegate type to match
parameters by name.
</summary>
<typeparam name="TDelegate">Factory delegate type</typeparam>
<typeparam name="TGeneratedFactoryActivatorData">Activator data type</typeparam>
<typeparam name="TSingleRegistrationStyle">Registration style</typeparam>
<param name="registration">Registration to change parameter mapping mode of.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="registration"/> is <see langword="null"/>.
</exception>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.PositionalParameterMapping``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2})">
<summary>
Changes the parameter mapping mode of the supplied delegate type to match
parameters by position.
</summary>
<typeparam name="TDelegate">Factory delegate type</typeparam>
<typeparam name="TGeneratedFactoryActivatorData">Activator data type</typeparam>
<typeparam name="TSingleRegistrationStyle">Registration style</typeparam>
<param name="registration">Registration to change parameter mapping mode of.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="registration"/> is <see langword="null"/>.
</exception>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.TypedParameterMapping``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2})">
<summary>
Changes the parameter mapping mode of the supplied delegate type to match
parameters by type.
</summary>
<typeparam name="TDelegate">Factory delegate type</typeparam>
<typeparam name="TGeneratedFactoryActivatorData">Activator data type</typeparam>
<typeparam name="TSingleRegistrationStyle">Registration style</typeparam>
<param name="registration">Registration to change parameter mapping mode of.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="registration"/> is <see langword="null"/>.
</exception>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.RegisterCollection(Autofac.ContainerBuilder,System.String,System.Type)">
<summary>
Registers the type as a collection. If no services or names are specified, the
default services will be IList<T>, ICollection<T>, and IEnumerable<T>
</summary>
<param name="elementType">The type of the collection elements.</param>
<param name="builder">Container builder.</param>
<param name="collectionName">A unique name for the collection that can be passed to MemberOf().</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<remarks>Collections are provided automatically in Autofac 2,
and this method is generally not required.</remarks>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.RegisterCollection``1(Autofac.ContainerBuilder,System.String)">
<summary>
Registers the type as a collection. If no services or names are specified, the
default services will be IList<T>, ICollection<T>, and IEnumerable<T>
</summary>
<typeparam name="T">The type of the collection elements.</typeparam>
<param name="builder">Container builder.</param>
<param name="collectionName">A unique name for the collection that can be passed to MemberOf().</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<remarks>Collections are provided automatically in Autofac 2,
and this method is generally not required.</remarks>
</member>
<member name="M:Autofac.Builder.RegistrationExtensions.MemberOf``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.String)">
<summary>
Include the element explicitly in a collection configured using RegisterCollection.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TSingleRegistrationStyle">Registration style.</typeparam>
<typeparam name="TActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to export.</param>
<param name="collectionName">The collection name, as passed to RegisterCollection.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="T:Autofac.ContainerBuilderResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.ContainerBuilderResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.ContainerBuilderResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.ContainerBuilderResources.BuildCanOnlyBeCalledOnce">
<summary>
Looks up a localized string similar to Build() or Update() can only be called once on a ContainerBuilder..
</summary>
</member>
<member name="P:Autofac.ContainerBuilderResources.ErrorAutoActivating">
<summary>
Looks up a localized string similar to An error occurred while attempting to automatically activate registration '{0}'. See the inner exception for information on the source of the failure..
</summary>
</member>
<member name="T:Autofac.Core.Activators.Delegate.DelegateActivatorResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Delegate.DelegateActivatorResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Delegate.DelegateActivatorResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Delegate.DelegateActivatorResources.NullFromActivationDelegateFor">
<summary>
Looks up a localized string similar to A delegate registered to create instances of '{0}' returned null..
</summary>
</member>
<member name="T:Autofac.Core.Activators.Reflection.ConstructorParameterBindingResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ConstructorParameterBindingResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ConstructorParameterBindingResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ConstructorParameterBindingResources.BoundConstructor">
<summary>
Looks up a localized string similar to Bound constructor '{0}'..
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ConstructorParameterBindingResources.CannotInstantitate">
<summary>
Looks up a localized string similar to The binding cannot be instantiated..
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ConstructorParameterBindingResources.ExceptionDuringInstantiation">
<summary>
Looks up a localized string similar to An exception was thrown while invoking the constructor '{0}' on type '{1}'..
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ConstructorParameterBindingResources.NonBindableConstructor">
<summary>
Looks up a localized string similar to Cannot resolve parameter '{1}' of constructor '{0}'..
</summary>
</member>
<member name="T:Autofac.Core.Activators.Reflection.DefaultValueParameter">
<summary>
Provides parameters that have a default value, set with an optional parameter
declaration in C# or VB.
</summary>
</member>
<member name="T:Autofac.Core.Parameter">
<summary>
Used in order to provide a value to a constructor parameter or property on an instance
being created by the container.
</summary>
<remarks>
Not all parameters can be applied to all sites.
</remarks>
</member>
<member name="M:Autofac.Core.Parameter.CanSupplyValue(System.Reflection.ParameterInfo,Autofac.IComponentContext,System.Func{System.Object}@)">
<summary>
Returns true if the parameter is able to provide a value to a particular site.
</summary>
<param name="pi">Constructor, method, or property-mutator parameter.</param>
<param name="context">The component context in which the value is being provided.</param>
<param name="valueProvider">If the result is true, the valueProvider parameter will
be set to a function that will lazily retrieve the parameter value. If the result is false,
will be set to null.</param>
<returns>True if a value can be supplied; otherwise, false.</returns>
</member>
<member name="M:Autofac.Core.Activators.Reflection.DefaultValueParameter.CanSupplyValue(System.Reflection.ParameterInfo,Autofac.IComponentContext,System.Func{System.Object}@)">
<summary>
Returns true if the parameter is able to provide a value to a particular site.
</summary>
<param name="pi">Constructor, method, or property-mutator parameter.</param>
<param name="context">The component context in which the value is being provided.</param>
<param name="valueProvider">If the result is true, the valueProvider parameter will
be set to a function that will lazily retrieve the parameter value. If the result is false,
will be set to null.</param>
<returns>True if a value can be supplied; otherwise, false.</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="pi"/> is <see langword="null"/>.
</exception>
</member>
<member name="T:Autofac.Core.ContainerResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.ContainerResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.ContainerResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.ContainerResources.SelfRegistrationCannotBeActivated">
<summary>
Looks up a localized string similar to The container's self-registration of context interfaces should never be activated as it is hard-wired into the LifetimeScope class..
</summary>
</member>
<member name="T:Autofac.Core.Diagnostics.IContainerAwareComponent">
<summary>
Marks a module as container-aware (for the purposes of attaching to diagnostic events.)
</summary>
</member>
<member name="M:Autofac.Core.Diagnostics.IContainerAwareComponent.SetContainer(Autofac.IContainer)">
<summary>
Initialise the module with the container into which it is being registered.
</summary>
<param name="container">The container.</param>
</member>
<member name="T:Autofac.Core.IActivatedEventArgs`1">
<summary>
Fired when the activation process for a new instance is complete.
</summary>
</member>
<member name="P:Autofac.Core.IActivatedEventArgs`1.Context">
<summary>
The context in which the activation occurred.
</summary>
</member>
<member name="P:Autofac.Core.IActivatedEventArgs`1.Component">
<summary>
The component providing the instance.
</summary>
</member>
<member name="P:Autofac.Core.IActivatedEventArgs`1.Parameters">
<summary>
The paramters provided when resolved.
</summary>
</member>
<member name="P:Autofac.Core.IActivatedEventArgs`1.Instance">
<summary>
The instance that will be used to satisfy the request.
</summary>
</member>
<member name="T:Autofac.Core.IActivatingEventArgs`1">
<summary>
Fired after the construction of an instance but before that instance
is shared with any other or any members are invoked on it.
</summary>
</member>
<member name="M:Autofac.Core.IActivatingEventArgs`1.ReplaceInstance(System.Object)">
<summary>
The instance can be replaced if needed, e.g. by an interface proxy.
</summary>
<param name="instance">The object to use instead of the activated instance.</param>
</member>
<member name="P:Autofac.Core.IActivatingEventArgs`1.Context">
<summary>
The context in which the activation occurred.
</summary>
</member>
<member name="P:Autofac.Core.IActivatingEventArgs`1.Component">
<summary>
The component providing the instance.
</summary>
</member>
<member name="P:Autofac.Core.IActivatingEventArgs`1.Instance">
<summary>
The instance that will be used to satisfy the request.
</summary>
</member>
<member name="P:Autofac.Core.IActivatingEventArgs`1.Parameters">
<summary>
The parameters supplied to the activator.
</summary>
</member>
<member name="T:Autofac.Core.IServiceWithType">
<summary>
Interface supported by services that carry type information.
</summary>
</member>
<member name="M:Autofac.Core.IServiceWithType.ChangeType(System.Type)">
<summary>
Return a new service of the same kind, but carrying
<paramref name="newType"/> as the <see cref="P:Autofac.Core.IServiceWithType.ServiceType"/>.
</summary>
<param name="newType">The new service type.</param>
<returns>A new service with the service type.</returns>
</member>
<member name="P:Autofac.Core.IServiceWithType.ServiceType">
<summary>
Gets the type of the service.
</summary>
<value>The type of the service.</value>
</member>
<member name="T:Autofac.Core.KeyedService">
<summary>
Identifies a service using a key in addition to its type.
</summary>
</member>
<member name="M:Autofac.Core.KeyedService.#ctor(System.Object,System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.KeyedService"/> class.
</summary>
<param name="serviceKey">Key of the service.</param>
<param name="serviceType">Type of the service.</param>
</member>
<member name="M:Autofac.Core.KeyedService.Equals(Autofac.Core.KeyedService)">
<summary>
Indicates whether the current object is equal to another object of the same type.
</summary>
<param name="other">An object to compare with this object.</param>
<returns>
true if the current object is equal to the <paramref name="other" /> parameter; otherwise, false.
</returns>
</member>
<member name="M:Autofac.Core.KeyedService.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
</summary>
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
<returns>
true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
</returns>
<exception cref="T:System.NullReferenceException">The <paramref name="obj"/> parameter is null.</exception>
</member>
<member name="M:Autofac.Core.KeyedService.GetHashCode">
<summary>
Serves as a hash function for a particular type.
</summary>
<returns>
A hash code for the current <see cref="T:System.Object"/>.
</returns>
</member>
<member name="M:Autofac.Core.KeyedService.ChangeType(System.Type)">
<summary>
Return a new service of the same kind, but carrying
<paramref name="newType"/> as the <see cref="P:Autofac.Core.KeyedService.ServiceType"/>.
</summary>
<param name="newType">The new service type.</param>
<returns>A new service with the service type.</returns>
</member>
<member name="P:Autofac.Core.KeyedService.ServiceKey">
<summary>
Gets or sets the key of the service.
</summary>
<value>The key of the service.</value>
</member>
<member name="P:Autofac.Core.KeyedService.ServiceType">
<summary>
Gets the type of the service.
</summary>
<value>The type of the service.</value>
</member>
<member name="P:Autofac.Core.KeyedService.Description">
<summary>
Gets a human-readable description of the service.
</summary>
<value>The description.</value>
</member>
<member name="T:Autofac.Core.Lifetime.LifetimeScopeBeginningEventArgs">
<summary>
Describes when a lifetime scope is beginning.
</summary>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScopeBeginningEventArgs.#ctor(Autofac.ILifetimeScope)">
<summary>
Create an instance of the <see cref="T:Autofac.Core.Lifetime.LifetimeScopeBeginningEventArgs"/> class.
</summary>
<param name="lifetimeScope">The lifetime scope that is beginning.</param>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScopeBeginningEventArgs.LifetimeScope">
<summary>
The lifetime scope that is beginning.
</summary>
</member>
<member name="T:Autofac.Core.Lifetime.LifetimeScopeEndingEventArgs">
<summary>
Describes when a lifetime scope is ending.
</summary>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScopeEndingEventArgs.#ctor(Autofac.ILifetimeScope)">
<summary>
Create an instance of the <see cref="T:Autofac.Core.Lifetime.LifetimeScopeEndingEventArgs"/> class.
</summary>
<param name="lifetimeScope">The lifetime scope that is ending.</param>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScopeEndingEventArgs.LifetimeScope">
<summary>
The lifetime scope that is ending.
</summary>
</member>
<member name="T:Autofac.Core.Lifetime.LifetimeScopeResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScopeResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScopeResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScopeResources.ScopeIsDisposed">
<summary>
Looks up a localized string similar to Instances cannot be resolved and nested lifetimes cannot be created from this LifetimeScope as it has already been disposed..
</summary>
</member>
<member name="T:Autofac.Core.RegistrationSourceAddedEventArgs">
<summary>
Fired when an <see cref="T:Autofac.Core.IRegistrationSource"/> is added to the registry.
</summary>
</member>
<member name="M:Autofac.Core.RegistrationSourceAddedEventArgs.#ctor(Autofac.Core.IComponentRegistry,Autofac.Core.IRegistrationSource)">
<summary>
Construct an instance of the <see cref="T:Autofac.Core.RegistrationSourceAddedEventArgs"/> class.
</summary>
<param name="componentRegistry">The registry to which the source was added.</param>
<param name="registrationSource">The source that was added.</param>
<exception cref="T:System.ArgumentNullException"></exception>
</member>
<member name="P:Autofac.Core.RegistrationSourceAddedEventArgs.RegistrationSource">
<summary>
The registry to which the source was added.
</summary>
</member>
<member name="P:Autofac.Core.RegistrationSourceAddedEventArgs.ComponentRegistry">
<summary>
The source that was added.
</summary>
</member>
<member name="T:Autofac.Core.Resolving.IInstanceLookup">
<summary>
Represents the process of finding a component during a resolve operation.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.IInstanceLookup.ComponentRegistration">
<summary>
The component for which an instance is to be looked up.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.IInstanceLookup.ActivationScope">
<summary>
The scope in which the instance will be looked up.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.IInstanceLookup.Parameters">
<summary>
The parameters provided for new instance creation.
</summary>
</member>
<member name="E:Autofac.Core.Resolving.IInstanceLookup.InstanceLookupEnding">
<summary>
Raised when the lookup phase of the operation is ending.
</summary>
</member>
<member name="E:Autofac.Core.Resolving.IInstanceLookup.CompletionBeginning">
<summary>
Raised when the completion phase of an instance lookup operation begins.
</summary>
</member>
<member name="E:Autofac.Core.Resolving.IInstanceLookup.CompletionEnding">
<summary>
Raised when the completion phase of an instance lookup operation ends.
</summary>
</member>
<member name="T:Autofac.Core.Resolving.InstanceLookupCompletionBeginningEventArgs">
<summary>
Raised when the completion phase of an instance lookup operation begins.
</summary>
</member>
<member name="M:Autofac.Core.Resolving.InstanceLookupCompletionBeginningEventArgs.#ctor(Autofac.Core.Resolving.IInstanceLookup)">
<summary>
Create an instance of the <see cref="T:Autofac.Core.Resolving.InstanceLookupCompletionBeginningEventArgs"/> class.
</summary>
<param name="instanceLookup">The instance lookup that is beginning the completion phase.</param>
</member>
<member name="P:Autofac.Core.Resolving.InstanceLookupCompletionBeginningEventArgs.InstanceLookup">
<summary>
The instance lookup operation that is beginning the completion phase.
</summary>
</member>
<member name="T:Autofac.Core.Resolving.InstanceLookupCompletionEndingEventArgs">
<summary>
Raised when the completion phase of an instance lookup operation ends.
</summary>
</member>
<member name="M:Autofac.Core.Resolving.InstanceLookupCompletionEndingEventArgs.#ctor(Autofac.Core.Resolving.IInstanceLookup)">
<summary>
Create an instance of the <see cref="T:Autofac.Core.Resolving.InstanceLookupCompletionEndingEventArgs"/> class.
</summary>
<param name="instanceLookup">The instance lookup that is ending the completion phase.</param>
</member>
<member name="P:Autofac.Core.Resolving.InstanceLookupCompletionEndingEventArgs.InstanceLookup">
<summary>
The instance lookup operation that is ending the completion phase.
</summary>
</member>
<member name="T:Autofac.Core.Resolving.InstanceLookupEndingEventArgs">
<summary>
Fired when an instance is looked up.
</summary>
</member>
<member name="M:Autofac.Core.Resolving.InstanceLookupEndingEventArgs.#ctor(Autofac.Core.Resolving.IInstanceLookup,System.Boolean)">
<summary>
Create an instance of the <see cref="T:Autofac.Core.Resolving.InstanceLookupBeginningEventArgs"/> class.
</summary>
<param name="instanceLookup">The instance lookup that is ending.</param>
<param name="newInstanceActivated">True if a new instance was created as part of the operation.</param>
</member>
<member name="P:Autofac.Core.Resolving.InstanceLookupEndingEventArgs.NewInstanceActivated">
<summary>
True if a new instance was created as part of the operation.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.InstanceLookupEndingEventArgs.InstanceLookup">
<summary>
The instance lookup operation that is ending.
</summary>
</member>
<member name="T:Autofac.Core.Resolving.InstanceLookupBeginningEventArgs">
<summary>
Fired when instance lookup is complete.
</summary>
</member>
<member name="M:Autofac.Core.Resolving.InstanceLookupBeginningEventArgs.#ctor(Autofac.Core.Resolving.IInstanceLookup)">
<param name="instanceLookup">The instance lookup that is ending.</param>
</member>
<member name="P:Autofac.Core.Resolving.InstanceLookupBeginningEventArgs.InstanceLookup">
<summary>
The instance lookup operation that is beginning.
</summary>
</member>
<member name="T:Autofac.Core.Resolving.ResolveOperationBeginningEventArgs">
<summary>
Describes the commencement of a new resolve operation.
</summary>
</member>
<member name="M:Autofac.Core.Resolving.ResolveOperationBeginningEventArgs.#ctor(Autofac.Core.Resolving.IResolveOperation)">
<summary>
Create an instance of the <see cref="T:Autofac.Core.Resolving.ResolveOperationBeginningEventArgs"/> class.
</summary>
<param name="resolveOperation">The resolve operation that is beginning.</param>
</member>
<member name="P:Autofac.Core.Resolving.ResolveOperationBeginningEventArgs.ResolveOperation">
<summary>
The resolve operation that is beginning.
</summary>
</member>
<member name="T:Autofac.Core.Registration.ComponentRegistrationLifetimeDecorator">
<summary>
Wraps a component registration, switching its lifetime.
</summary>
</member>
<member name="T:Autofac.Util.Disposable">
<summary>
Base class for disposable objects.
</summary>
</member>
<member name="M:Autofac.Util.Disposable.Dispose">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
</member>
<member name="M:Autofac.Util.Disposable.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="P:Autofac.Util.Disposable.IsDisposed">
<summary>
Returns true if the current instance has been disposed; otherwise false;
</summary>
</member>
<member name="T:Autofac.Core.IComponentRegistration">
<summary>
Describes a logical component within the container.
</summary>
</member>
<member name="M:Autofac.Core.IComponentRegistration.RaisePreparing(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter}@)">
<summary>
Called by the container when an instance is required.
</summary>
<param name="context">The context in which the instance will be activated.</param>
<param name="parameters">Parameters for activation. These may be modified by the event handler.</param>
</member>
<member name="M:Autofac.Core.IComponentRegistration.RaiseActivating(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Object@)">
<summary>
Called by the container once an instance has been constructed.
</summary>
<param name="context">The context in which the instance was activated.</param>
<param name="parameters">The parameters supplied to the activator.</param>
<param name="instance">The instance.</param>
</member>
<member name="M:Autofac.Core.IComponentRegistration.RaiseActivated(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Object)">
<summary>
Called by the container once an instance has been fully constructed, including
any requested objects that depend on the instance.
</summary>
<param name="context">The context in which the instance was activated.</param>
<param name="parameters">The parameters supplied to the activator.</param>
<param name="instance">The instance.</param>
</member>
<member name="P:Autofac.Core.IComponentRegistration.Id">
<summary>
A unique identifier for this component (shared in all sub-contexts.)
This value also appears in Services.
</summary>
</member>
<member name="P:Autofac.Core.IComponentRegistration.Activator">
<summary>
The activator used to create instances.
</summary>
</member>
<member name="P:Autofac.Core.IComponentRegistration.Lifetime">
<summary>
The lifetime associated with the component.
</summary>
</member>
<member name="P:Autofac.Core.IComponentRegistration.Sharing">
<summary>
Whether the component instances are shared or not.
</summary>
</member>
<member name="P:Autofac.Core.IComponentRegistration.Ownership">
<summary>
Whether the instances of the component should be disposed by the container.
</summary>
</member>
<member name="P:Autofac.Core.IComponentRegistration.Services">
<summary>
The services provided by the component.
</summary>
</member>
<member name="P:Autofac.Core.IComponentRegistration.Metadata">
<summary>
Additional data associated with the component.
</summary>
</member>
<member name="P:Autofac.Core.IComponentRegistration.Target">
<summary>
The component registration upon which this registration is based.
</summary>
</member>
<member name="E:Autofac.Core.IComponentRegistration.Preparing">
<summary>
Fired when a new instance is required. The instance can be
provided in order to skip the regular activator, by setting the Instance property in
the provided event arguments.
</summary>
</member>
<member name="E:Autofac.Core.IComponentRegistration.Activating">
<summary>
Fired when a new instance is being activated. The instance can be
wrapped or switched at this time by setting the Instance property in
the provided event arguments.
</summary>
</member>
<member name="E:Autofac.Core.IComponentRegistration.Activated">
<summary>
Fired when the activation process for a new instance is complete.
</summary>
</member>
<member name="T:Autofac.Core.Registration.ComponentRegistrationResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistrationResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistrationResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistrationResources.ToStringFormat">
<summary>
Looks up a localized string similar to Activator = {0}, Services = [{1}], Lifetime = {2}, Sharing = {3}, Ownership = {4}.
</summary>
</member>
<member name="T:Autofac.Core.Registration.ExternalRegistrySource">
<summary>
Pulls registrations from another component registry.
Excludes most auto-generated registrations - currently has issues with
collection registrations.
</summary>
</member>
<member name="M:Autofac.Core.Registration.ExternalRegistrySource.#ctor(Autofac.Core.IComponentRegistry)">
<summary>
Create an external registry source that draws components from
<paramref name="registry"/>.
</summary>
<param name="registry">Component registry to pull registrations from.</param>
</member>
<member name="M:Autofac.Core.Registration.ExternalRegistrySource.RegistrationsFor(Autofac.Core.Service,System.Func{Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.IComponentRegistration}})">
<summary>
Retrieve registrations for an unregistered service, to be used
by the container.
</summary>
<param name="service">The service that was requested.</param>
<param name="registrationAccessor">A function that will return existing registrations for a service.</param>
<returns>Registrations providing the service.</returns>
</member>
<member name="P:Autofac.Core.Registration.ExternalRegistrySource.IsAdapterForIndividualComponents">
<summary>
In this case because the components that are adapted do not come from the same
logical scope, we must return false to avoid duplicating them.
</summary>
</member>
<member name="T:Autofac.Core.Registration.ScopeRestrictedRegistry">
<summary>
Switches components with a RootScopeLifetime (singletons) with
decorators exposing MatchingScopeLifetime targeting the specified scope.
</summary>
</member>
<member name="T:Autofac.Core.Registration.ComponentRegistry">
<summary>
Maps services onto the components that provide them.
</summary>
<remarks>
The component registry provides services directly from components,
and also uses <see cref="T:Autofac.Core.IRegistrationSource"/> to generate components
on-the-fly or as adapters for other components. A component registry
is normally used through a <see cref="T:Autofac.ContainerBuilder"/>, and not
directly by application code.
</remarks>
</member>
<member name="F:Autofac.Core.Registration.ComponentRegistry._synchRoot">
<summary>
Protects instance variables from concurrent access.
</summary>
</member>
<member name="F:Autofac.Core.Registration.ComponentRegistry._dynamicRegistrationSources">
<summary>
External registration sources.
</summary>
</member>
<member name="F:Autofac.Core.Registration.ComponentRegistry._registrations">
<summary>
All registrations.
</summary>
</member>
<member name="F:Autofac.Core.Registration.ComponentRegistry._serviceInfo">
<summary>
Keeps track of the status of registered services.
</summary>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistry.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistry.TryGetRegistration(Autofac.Core.Service,Autofac.Core.IComponentRegistration@)">
<summary>
Attempts to find a default registration for the specified service.
</summary>
<param name="service">The service to look up.</param>
<param name="registration">The default registration for the service.</param>
<returns>True if a registration exists.</returns>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistry.IsRegistered(Autofac.Core.Service)">
<summary>
Determines whether the specified service is registered.
</summary>
<param name="service">The service to test.</param>
<returns>True if the service is registered.</returns>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistry.Register(Autofac.Core.IComponentRegistration)">
<summary>
Register a component.
</summary>
<param name="registration">The component registration.</param>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistry.Register(Autofac.Core.IComponentRegistration,System.Boolean)">
<summary>
Register a component.
</summary>
<param name="registration">The component registration.</param>
<param name="preserveDefaults">If true, existing defaults for the services provided by the
component will not be changed.</param>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistry.RegistrationsFor(Autofac.Core.Service)">
<summary>
Selects from the available registrations after ensuring that any
dynamic registration sources that may provide <paramref name="service"/>
have been invoked.
</summary>
<param name="service">The service for which registrations are sought.</param>
<returns>Registrations supporting <paramref name="service"/>.</returns>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistry.AddRegistrationSource(Autofac.Core.IRegistrationSource)">
<summary>
Add a registration source that will provide registrations on-the-fly.
</summary>
<param name="source">The source to register.</param>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistry.Registrations">
<summary>
Enumerate the registered components.
</summary>
</member>
<member name="E:Autofac.Core.Registration.ComponentRegistry.Registered">
<summary>
Fired whenever a component is registered - either explicitly or via a
<see cref="T:Autofac.Core.IRegistrationSource"/>.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistry.Sources">
<summary>
Gets the registration sources that are used by the registry.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistry.HasLocalComponents">
<summary>
True if the registry contains its own components; false if it is forwarding
registrations from another external registry.
</summary>
<remarks>This property is used when walking up the scope tree looking for
registrations for a new customised scope. (See issue 336.)</remarks>
</member>
<member name="E:Autofac.Core.Registration.ComponentRegistry.RegistrationSourceAdded">
<summary>
Fired when an <see cref="T:Autofac.Core.IRegistrationSource"/> is added to the registry.
</summary>
</member>
<member name="T:Autofac.Core.Registration.ServiceRegistrationInfo">
<summary>
Tracks the services known to the registry.
</summary>
</member>
<member name="F:Autofac.Core.Registration.ServiceRegistrationInfo._sourcesToQuery">
<summary>
Used for bookkeeping so that the same source is not queried twice (may be null.)
</summary>
</member>
<member name="M:Autofac.Core.Registration.ServiceRegistrationInfo.#ctor(Autofac.Core.Service)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.Registration.ServiceRegistrationInfo"/> class.
</summary>
<param name="service">The tracked service.</param>
</member>
<member name="P:Autofac.Core.Registration.ServiceRegistrationInfo.IsInitialized">
<summary>
The first time a service is requested, initialization (e.g. reading from sources)
happens. This value will then be set to true. Calling many methods on this type before
initialisation is an error.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ServiceRegistrationInfo.Implementations">
<summary>
The known implementations.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ServiceRegistrationInfo.IsRegistered">
<summary>
True if any implementations are known.
</summary>
</member>
<member name="T:Autofac.Core.Registration.ServiceRegistrationInfoResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ServiceRegistrationInfoResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ServiceRegistrationInfoResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ServiceRegistrationInfoResources.NotDuringInitialization">
<summary>
Looks up a localized string similar to The operation is only valid during initialization..
</summary>
</member>
<member name="P:Autofac.Core.Registration.ServiceRegistrationInfoResources.NotInitialized">
<summary>
Looks up a localized string similar to The operation is not valid until the object is initialized..
</summary>
</member>
<member name="T:Autofac.Core.Resolving.ComponentActivationResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.ComponentActivationResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.ComponentActivationResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.ComponentActivationResources.ActivationAlreadyExecuted">
<summary>
Looks up a localized string similar to The activation has already been executed..
</summary>
</member>
<member name="T:Autofac.Core.Resolving.ResolveOperationEndingEventArgs">
<summary>
Describes the commencement of a new resolve operation.
</summary>
</member>
<member name="M:Autofac.Core.Resolving.ResolveOperationEndingEventArgs.#ctor(Autofac.Core.Resolving.IResolveOperation,System.Exception)">
<summary>
Create an instance of the <see cref="T:Autofac.Core.Resolving.ResolveOperationBeginningEventArgs"/> class.
</summary>
<param name="resolveOperation">The resolve operation that is ending.</param>
<param name="exception">If included, the exception causing the operation to end; otherwise, null.</param>
</member>
<member name="P:Autofac.Core.Resolving.ResolveOperationEndingEventArgs.Exception">
<summary>
The exception causing the operation to end, or null.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.ResolveOperationEndingEventArgs.ResolveOperation">
<summary>
The resolve operation that is ending.
</summary>
</member>
<member name="T:Autofac.Core.ServiceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.ServiceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.ServiceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.ServiceResources.MustOverrideEquals">
<summary>
Looks up a localized string similar to Subclasses of Autofac.Service must override Object.Equals().
</summary>
</member>
<member name="P:Autofac.Core.ServiceResources.MustOverrideGetHashCode">
<summary>
Looks up a localized string similar to Subclasses of Autofac.Service must override Object.GetHashCode().
</summary>
</member>
<member name="T:Autofac.Features.Collections.CollectionRegistrationSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.Collections.CollectionRegistrationSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.Collections.CollectionRegistrationSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.Collections.CollectionRegistrationSourceResources.CollectionRegistrationSourceDescription">
<summary>
Looks up a localized string similar to Collection Support (Arrays and Generic Collection Interfaces).
</summary>
</member>
<member name="T:Autofac.Features.LazyDependencies.LazyRegistrationSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.LazyDependencies.LazyRegistrationSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.LazyDependencies.LazyRegistrationSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.LazyDependencies.LazyRegistrationSourceResources.LazyRegistrationSourceDescription">
<summary>
Looks up a localized string similar to Lazy<T> Support.
</summary>
</member>
<member name="T:Autofac.Features.LightweightAdapters.LightweightAdapterActivatorData">
<summary>
Describes the basic requirements for generating a lightweight adapter.
</summary>
</member>
<member name="M:Autofac.Features.LightweightAdapters.LightweightAdapterActivatorData.#ctor(Autofac.Core.Service,System.Func{Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Object,System.Object})">
<summary>
Create an instance of <see cref="T:Autofac.Features.LightweightAdapters.LightweightAdapterActivatorData"/>.
</summary>
<param name="fromService">The service that will be adapted from.</param>
<param name="adapter">The adapter function.</param>
</member>
<member name="P:Autofac.Features.LightweightAdapters.LightweightAdapterActivatorData.Adapter">
<summary>
The adapter function.
</summary>
</member>
<member name="P:Autofac.Features.LightweightAdapters.LightweightAdapterActivatorData.FromService">
<summary>
The service to be adapted from.
</summary>
</member>
<member name="T:Autofac.Features.LightweightAdapters.LightweightAdapterRegistrationSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.LightweightAdapters.LightweightAdapterRegistrationSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.LightweightAdapters.LightweightAdapterRegistrationSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.LightweightAdapters.LightweightAdapterRegistrationSourceResources.AdapterFromToDescription">
<summary>
Looks up a localized string similar to Lightweight Adapter from {0} to {1}.
</summary>
</member>
<member name="P:Autofac.Features.LightweightAdapters.LightweightAdapterRegistrationSourceResources.FromAndToMustDiffer">
<summary>
Looks up a localized string similar to The service {0} cannot be both the adapter's from and to parameters - these must differ..
</summary>
</member>
<member name="T:Autofac.Features.Collections.CollectionRegistrationExtensions">
<summary>
Internal implementation of the RegisterCollection/MemberOf-style collection feature.
</summary>
</member>
<member name="T:Autofac.Builder.DynamicRegistrationStyle">
<summary>
Registration style for dynamic registrations.
</summary>
</member>
<member name="T:Autofac.Features.GeneratedFactories.GeneratedFactoryActivatorData">
<summary>
Data used to create factory activators.
</summary>
</member>
<member name="M:Autofac.Features.GeneratedFactories.GeneratedFactoryActivatorData.#ctor(System.Type,Autofac.Core.Service)">
<summary>
Create a new GeneratedFactoryActivatorData
</summary>
<param name="delegateType">The type of the factory.</param>
<param name="productService">The service used to provide the products of the factory.</param>
</member>
<member name="P:Autofac.Features.GeneratedFactories.GeneratedFactoryActivatorData.ParameterMapping">
<summary>
Determines how the parameters of the delegate type are passed on
to the generated Resolve() call as Parameter objects.
For Func-based delegates, this defaults to ByType. Otherwise, the
parameters will be mapped by name.
</summary>
</member>
<member name="P:Autofac.Features.GeneratedFactories.GeneratedFactoryActivatorData.Activator">
<summary>
Activator data that can provide an IInstanceActivator instance.
</summary>
</member>
<member name="T:Autofac.Builder.IHideObjectMembers">
<summary>
Hides standard Object members to make fluent interfaces
easier to read.
Based on blog post by @kzu here:
http://www.clariusconsulting.net/blogs/kzu/archive/2008/03/10/58301.aspx
</summary>
</member>
<member name="M:Autofac.Builder.IHideObjectMembers.GetType">
<summary>
Standard System.Object member.
</summary>
<returns>Standard result.</returns>
</member>
<member name="M:Autofac.Builder.IHideObjectMembers.GetHashCode">
<summary>
Standard System.Object member.
</summary>
<returns>Standard result.</returns>
</member>
<member name="M:Autofac.Builder.IHideObjectMembers.ToString">
<summary>
Standard System.Object member.
</summary>
<returns>Standard result.</returns>
</member>
<member name="M:Autofac.Builder.IHideObjectMembers.Equals(System.Object)">
<summary>
Standard System.Object member.
</summary>
<param name="other">The other.</param>
<returns>Standard result.</returns>
</member>
<member name="T:Autofac.Features.GeneratedFactories.ParameterMapping">
<summary>
Determines how the parameters of the delegate type are passed on
to the generated Resolve() call as Parameter objects.
</summary>
</member>
<member name="F:Autofac.Features.GeneratedFactories.ParameterMapping.Adaptive">
<summary>
Chooses parameter mapping based on the factory type.
For Func-based factories this is equivalent to ByType, for all
others ByName will be used.
</summary>
</member>
<member name="F:Autofac.Features.GeneratedFactories.ParameterMapping.ByName">
<summary>
Pass the parameters supplied to the delegate through to the
underlying registration as NamedParameters based on the parameter
names in the delegate type's formal argument list.
</summary>
</member>
<member name="F:Autofac.Features.GeneratedFactories.ParameterMapping.ByType">
<summary>
Pass the parameters supplied to the delegate through to the
underlying registration as TypedParameters based on the parameter
types in the delegate type's formal argument list.
</summary>
</member>
<member name="F:Autofac.Features.GeneratedFactories.ParameterMapping.ByPosition">
<summary>
Pass the parameters supplied to the delegate through to the
underlying registration as PositionalParameters based on the parameter
indices in the delegate type's formal argument list.
</summary>
</member>
<member name="T:Autofac.Features.Indexed.IIndex`2">
<summary>
Provides components by lookup operations via an index (key) type.
</summary>
<typeparam name="TKey">The type of the index.</typeparam>
<typeparam name="TValue">The service provided by the indexed components.</typeparam>
<example>
Retrieving a value given a key:
<code>
IIndex<AccountType, IRenderer> accountRenderers = // ...
var renderer = accountRenderers[AccountType.User];
</code>
</example>
</member>
<member name="M:Autofac.Features.Indexed.IIndex`2.TryGetValue(`0,`1@)">
<summary>
Get the value associated with <paramref name="key"/> if any is available.
</summary>
<param name="key">The key to look up.</param>
<param name="value">The retrieved value.</param>
<returns>True if a value associated with the key exists.</returns>
</member>
<member name="P:Autofac.Features.Indexed.IIndex`2.Item(`0)">
<summary>
Get the value associated with <paramref name="key"/>.
</summary>
<param name="key">The value to retrieve.</param>
<returns>The associated value.</returns>
</member>
<member name="M:Autofac.Features.Indexed.KeyedServiceIndex`2.#ctor(Autofac.IComponentContext)">
<summary></summary>
</member>
<member name="M:Autofac.Features.Indexed.KeyedServiceIndex`2.TryGetValue(`0,`1@)">
<summary></summary>
</member>
<member name="P:Autofac.Features.Indexed.KeyedServiceIndex`2.Item(`0)">
<summary></summary>
</member>
<member name="T:Autofac.Features.Metadata.MetaRegistrationSource">
<summary>
Support the <see cref="T:Autofac.Features.Metadata.Meta`1"/>
types automatically whenever type T is registered with the container.
Metadata values come from the component registration's metadata.
</summary>
</member>
<member name="T:Autofac.Features.Metadata.Meta`1">
<summary>
Provides a value along with a dictionary of metadata describing the value.
</summary>
<typeparam name="T">The type of the value.</typeparam>
</member>
<member name="M:Autofac.Features.Metadata.Meta`1.#ctor(`0,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Create a new instance.
</summary>
<param name="value">The value described by the instance.</param>
<param name="metadata">The metadata describing the value.</param>
</member>
<member name="P:Autofac.Features.Metadata.Meta`1.Value">
<summary>
The value described by <see cref="P:Autofac.Features.Metadata.Meta`1.Metadata"/>.
</summary>
</member>
<member name="P:Autofac.Features.Metadata.Meta`1.Metadata">
<summary>
Metadata describing the value.
</summary>
</member>
<member name="T:Autofac.Features.Metadata.MetaRegistrationSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.Metadata.MetaRegistrationSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.Metadata.MetaRegistrationSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.Metadata.MetaRegistrationSourceResources.MetaRegistrationSourceDescription">
<summary>
Looks up a localized string similar to Meta<T> Support.
</summary>
</member>
<member name="P:Autofac.Features.Metadata.MetaRegistrationSourceResources.StronglyTypedMetaRegistrationSourceDescription">
<summary>
Looks up a localized string similar to Meta<T, TMetadata> Support.
</summary>
</member>
<member name="T:Autofac.Features.OpenGenerics.OpenGenericDecoratorActivatorDataResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericDecoratorActivatorDataResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericDecoratorActivatorDataResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericDecoratorActivatorDataResources.DecoratedServiceIsNotOpenGeneric">
<summary>
Looks up a localized string similar to The service '{0}' is not an open generic type..
</summary>
</member>
<member name="T:Autofac.Features.OpenGenerics.OpenGenericRegistrationSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericRegistrationSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericRegistrationSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericRegistrationSourceResources.OpenGenericRegistrationSourceDescription">
<summary>
Looks up a localized string similar to {0} providing {1}.
</summary>
</member>
<member name="T:Autofac.Features.OpenGenerics.OpenGenericDecoratorActivatorData">
<summary>
Describes the activator for an open generic decorator.
</summary>
</member>
<member name="M:Autofac.Features.OpenGenerics.OpenGenericDecoratorActivatorData.#ctor(System.Type,Autofac.Core.IServiceWithType)">
<summary>
Construct an <see cref="T:Autofac.Features.OpenGenerics.OpenGenericDecoratorActivatorData"/>.
</summary>
<param name="implementer">The decorator type.</param>
<param name="fromService">The open generic service type to decorate.</param>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericDecoratorActivatorData.FromService">
<summary>
The open generic service type to decorate.
</summary>
</member>
<member name="T:Autofac.Features.OpenGenerics.OpenGenericDecoratorRegistrationSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericDecoratorRegistrationSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericDecoratorRegistrationSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericDecoratorRegistrationSourceResources.FromAndToMustDiffer">
<summary>
Looks up a localized string similar to The service {0} cannot be both the adapter's from and to parameters - these must differ..
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericDecoratorRegistrationSourceResources.OpenGenericDecoratorRegistrationSourceImplFromTo">
<summary>
Looks up a localized string similar to Open Generic Decorator {0} from {1} to {2}.
</summary>
</member>
<member name="T:Autofac.Features.OpenGenerics.OpenGenericRegistrationExtensionsResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericRegistrationExtensionsResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericRegistrationExtensionsResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericRegistrationExtensionsResources.ImplementorMustBeOpenGenericType">
<summary>
Looks up a localized string similar to The type {0} is not an open generic type definition..
</summary>
</member>
<member name="T:Autofac.Features.OpenGenerics.OpenGenericServiceBinderResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericServiceBinderResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericServiceBinderResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericServiceBinderResources.ImplementorDoesntImplementService">
<summary>
Looks up a localized string similar to The type '{0}' does not implement the interface '{1}'..
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericServiceBinderResources.ImplementorMustBeOpenGenericTypeDefinition">
<summary>
Looks up a localized string similar to The implementation type '{0}' is not an open generic type definition..
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericServiceBinderResources.InterfaceIsNotImplemented">
<summary>
Looks up a localized string similar to The implementation type '{0}' does not support the interface '{1}'..
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericServiceBinderResources.ServiceTypeMustBeOpenGenericTypeDefinition">
<summary>
Looks up a localized string similar to The service '{0}' is not an open generic type definition..
</summary>
</member>
<member name="P:Autofac.Features.OpenGenerics.OpenGenericServiceBinderResources.TypesAreNotConvertible">
<summary>
Looks up a localized string similar to The service '{1}' is not assignable from implementation type '{0}'..
</summary>
</member>
<member name="T:Autofac.Features.OwnedInstances.OwnedInstanceRegistrationSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.OwnedInstances.OwnedInstanceRegistrationSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.OwnedInstances.OwnedInstanceRegistrationSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.OwnedInstances.OwnedInstanceRegistrationSourceResources.OwnedInstanceRegistrationSourceDescription">
<summary>
Looks up a localized string similar to Owned<T> Support.
</summary>
</member>
<member name="T:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource">
<summary>
Provides registrations on-the-fly for any concrete type not already registered with
the container.
</summary>
</member>
<member name="M:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource"/> class.
</summary>
</member>
<member name="M:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource.#ctor(System.Func{System.Type,System.Boolean})">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource"/> class.
</summary>
<param name="predicate">A predicate that selects types the source will register.</param>
</member>
<member name="M:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource.RegistrationsFor(Autofac.Core.Service,System.Func{Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.IComponentRegistration}})">
<summary>
Retrieve registrations for an unregistered service, to be used
by the container.
</summary>
<param name="service">The service that was requested.</param>
<param name="registrationAccessor">A function that will return existing registrations for a service.</param>
<returns>Registrations providing the service.</returns>
</member>
<member name="M:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
</summary>
<returns>
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="P:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource.IsAdapterForIndividualComponents">
<summary>
Gets whether the registrations provided by this source are 1:1 adapters on top
of other components (I.e. like Meta, Func or Owned.)
</summary>
</member>
<member name="P:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSource.RegistrationConfiguration">
<summary>
Gets or sets an expression used to configure generated registrations.
</summary>
<value>
A <see cref="T:System.Action`1"/> that can be used to modify the behavior
of registrations that are generated by this source.
</value>
</member>
<member name="T:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.ResolveAnything.AnyConcreteTypeNotAlreadyRegisteredSourceResources.AnyConcreteTypeNotAlreadyRegisteredSourceDescription">
<summary>
Looks up a localized string similar to "Resolve Anything" Support.
</summary>
</member>
<member name="T:Autofac.Features.Scanning.ScanningActivatorData">
<summary>
Activation data for types located by scanning assemblies.
</summary>
</member>
<member name="M:Autofac.Features.Scanning.ScanningActivatorData.#ctor">
<summary>
Create an instance of <see cref="T:Autofac.Features.Scanning.ScanningActivatorData"/>.
</summary>
</member>
<member name="P:Autofac.Features.Scanning.ScanningActivatorData.Filters">
<summary>
The filters applied to the types from the scanned assembly.
</summary>
</member>
<member name="P:Autofac.Features.Scanning.ScanningActivatorData.ConfigurationActions">
<summary>
Additional actions to be performed on the concrete type registrations.
</summary>
</member>
<member name="P:Autofac.Features.Scanning.ScanningActivatorData.PostScanningCallbacks">
<summary>
Actions to be called once the scanning operation is complete.
</summary>
</member>
<member name="T:Autofac.Core.ActivatedEventArgs`1">
<summary>
Fired when the activation process for a new instance is complete.
</summary>
</member>
<member name="M:Autofac.Core.ActivatedEventArgs`1.#ctor(Autofac.IComponentContext,Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},`0)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.ActivatedEventArgs`1"/> class.
</summary>
<param name="context">The context.</param>
<param name="component">The component.</param>
<param name="parameters">The parameters.</param>
<param name="instance">The instance.</param>
</member>
<member name="P:Autofac.Core.ActivatedEventArgs`1.Context">
<summary>
The context in which the activation occurred.
</summary>
</member>
<member name="P:Autofac.Core.ActivatedEventArgs`1.Component">
<summary>
The component providing the instance.
</summary>
</member>
<member name="P:Autofac.Core.ActivatedEventArgs`1.Parameters">
<summary>
The paramters provided when resolved.
</summary>
</member>
<member name="P:Autofac.Core.ActivatedEventArgs`1.Instance">
<summary>
The instance that will be used to satisfy the request.
</summary>
</member>
<member name="T:Autofac.Core.ActivatingEventArgs`1">
<summary>
Fired after the construction of an instance but before that instance
is shared with any other or any members are invoked on it.
</summary>
</member>
<member name="M:Autofac.Core.ActivatingEventArgs`1.#ctor(Autofac.IComponentContext,Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},`0)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.ActivatedEventArgs`1"/> class.
</summary>
<param name="context">The context.</param>
<param name="component">The component.</param>
<param name="parameters">The parameters.</param>
<param name="instance">The instance.</param>
</member>
<member name="M:Autofac.Core.ActivatingEventArgs`1.ReplaceInstance(System.Object)">
<summary>
The instance can be replaced if needed, e.g. by an interface proxy.
</summary>
<param name="instance">The object to use instead of the activated instance.</param>
</member>
<member name="P:Autofac.Core.ActivatingEventArgs`1.Context">
<summary>
The context in which the activation occurred.
</summary>
</member>
<member name="P:Autofac.Core.ActivatingEventArgs`1.Component">
<summary>
The component providing the instance.
</summary>
</member>
<member name="P:Autofac.Core.ActivatingEventArgs`1.Instance">
<summary>
The instance that will be used to satisfy the request.
</summary>
<remarks>
The instance can be replaced if needed, e.g. by an interface proxy.
</remarks>
</member>
<member name="P:Autofac.Core.ActivatingEventArgs`1.Parameters">
<summary>
The parameters supplied to the activator.
</summary>
</member>
<member name="T:Autofac.Core.Activators.Delegate.DelegateActivator">
<summary>
Activate instances using a delegate.
</summary>
</member>
<member name="T:Autofac.Core.Activators.InstanceActivator">
<summary>
Base class for instance activators.
</summary>
</member>
<member name="M:Autofac.Core.Activators.InstanceActivator.#ctor(System.Type)">
<summary>
Create an instance activator that will return instances compatible
with <paramref name="limitType"/>.
</summary>
<param name="limitType">Most derived type to which instances can be cast.</param>
</member>
<member name="M:Autofac.Core.Activators.InstanceActivator.ToString">
<summary>
Gets a string representation of the activator.
</summary>
<returns>A string describing the activator.</returns>
</member>
<member name="P:Autofac.Core.Activators.InstanceActivator.LimitType">
<summary>
The most specific type that the component instances are known to be castable to.
</summary>
</member>
<member name="T:Autofac.Core.IInstanceActivator">
<summary>
Activates component instances.
</summary>
</member>
<member name="M:Autofac.Core.IInstanceActivator.ActivateInstance(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Activate an instance in the provided context.
</summary>
<param name="context">Context in which to activate instances.</param>
<param name="parameters">Parameters to the instance.</param>
<returns>The activated instance.</returns>
<remarks>
The context parameter here should probably be ILifetimeScope in order to reveal Disposer,
but will wait until implementing a concrete use case to make the decision
</remarks>
</member>
<member name="P:Autofac.Core.IInstanceActivator.LimitType">
<summary>
The most specific type that the component instances are known to be castable to.
</summary>
</member>
<member name="M:Autofac.Core.Activators.Delegate.DelegateActivator.#ctor(System.Type,System.Func{Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Object})">
<summary>
Create a delegate activator.
</summary>
<param name="limitType">The most specific type to which activated instances can be cast.</param>
<param name="activationFunction">Activation delegate.</param>
</member>
<member name="M:Autofac.Core.Activators.Delegate.DelegateActivator.ActivateInstance(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Activate an instance in the provided context.
</summary>
<param name="context">Context in which to activate instances.</param>
<param name="parameters">Parameters to the instance.</param>
<returns>The activated instance.</returns>
<remarks>
The context parameter here should probably be ILifetimeScope in order to reveal Disposer,
but will wait until implementing a concrete use case to make the decision
</remarks>
</member>
<member name="T:Autofac.Core.Activators.ProvidedInstance.ProvidedInstanceActivator">
<summary>
Provides a pre-constructed instance.
</summary>
</member>
<member name="M:Autofac.Core.Activators.ProvidedInstance.ProvidedInstanceActivator.#ctor(System.Object)">
<summary>
Provide the specified instance.
</summary>
<param name="instance">The instance to provide.</param>
</member>
<member name="M:Autofac.Core.Activators.ProvidedInstance.ProvidedInstanceActivator.ActivateInstance(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Activate an instance in the provided context.
</summary>
<param name="context">Context in which to activate instances.</param>
<param name="parameters">Parameters to the instance.</param>
<returns>The activated instance.</returns>
<remarks>
The context parameter here should probably be ILifetimeScope in order to reveal Disposer,
but will wait until implementing a concrete use case to make the decision
</remarks>
</member>
<member name="M:Autofac.Core.Activators.ProvidedInstance.ProvidedInstanceActivator.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="P:Autofac.Core.Activators.ProvidedInstance.ProvidedInstanceActivator.DisposeInstance">
<summary>
Determines whether the activator disposes the instance that it holds.
Necessary because otherwise instances that are never resolved will never be
disposed.
</summary>
</member>
<member name="T:Autofac.Core.Activators.ProvidedInstance.ProvidedInstanceActivatorResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Activators.ProvidedInstance.ProvidedInstanceActivatorResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.ProvidedInstance.ProvidedInstanceActivatorResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.ProvidedInstance.ProvidedInstanceActivatorResources.InstanceAlreadyActivated">
<summary>
Looks up a localized string similar to The provided instance has already been used in an activation request. Did you combine a provided instance with non-root/single-instance lifetime/sharing?.
</summary>
</member>
<member name="T:Autofac.Core.Activators.Reflection.AutowiringParameter">
<summary>
Supplies values based on the target parameter type.
</summary>
</member>
<member name="M:Autofac.Core.Activators.Reflection.AutowiringParameter.CanSupplyValue(System.Reflection.ParameterInfo,Autofac.IComponentContext,System.Func{System.Object}@)">
<summary>
Returns true if the parameter is able to provide a value to a particular site.
</summary>
<param name="pi">Constructor, method, or property-mutator parameter.</param>
<param name="context">The component context in which the value is being provided.</param>
<param name="valueProvider">If the result is true, the valueProvider parameter will
be set to a function that will lazily retrieve the parameter value. If the result is false,
will be set to null.</param>
<returns>True if a value can be supplied; otherwise, false.</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="pi"/> or <paramref name="context"/> is <see langword="null"/>.
</exception>
</member>
<member name="T:Autofac.Core.Activators.Reflection.ConstructorParameterBinding">
<summary>
Binds a constructor to the parameters that will be used when it is invoked.
</summary>
</member>
<member name="M:Autofac.Core.Activators.Reflection.ConstructorParameterBinding.#ctor(System.Reflection.ConstructorInfo,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},Autofac.IComponentContext)">
<summary>
Construct a new ConstructorParameterBinding.
</summary>
<param name="ci">ConstructorInfo to bind.</param>
<param name="availableParameters">Available parameters.</param>
<param name="context">Context in which to construct instance.</param>
</member>
<member name="M:Autofac.Core.Activators.Reflection.ConstructorParameterBinding.Instantiate">
<summary>
Invoke the constructor with the parameter bindings.
</summary>
<returns>The constructed instance.</returns>
</member>
<member name="M:Autofac.Core.Activators.Reflection.ConstructorParameterBinding.ToString">
<summary>Returns a System.String that represents the current System.Object.</summary>
<returns>A System.String that represents the current System.Object.</returns>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ConstructorParameterBinding.TargetConstructor">
<summary>
The constructor on the target type. The actual constructor used
might differ, e.g. if using a dynamic proxy.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ConstructorParameterBinding.CanInstantiate">
<summary>
True if the binding is valid.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ConstructorParameterBinding.Description">
<summary>
Describes the constructor parameter binding.
</summary>
</member>
<member name="T:Autofac.Core.Activators.Reflection.IConstructorSelector">
<summary>
Selects the best constructor from a set of available constructors.
</summary>
</member>
<member name="M:Autofac.Core.Activators.Reflection.IConstructorSelector.SelectConstructorBinding(Autofac.Core.Activators.Reflection.ConstructorParameterBinding[])">
<summary>
Selects the best constructor from the available constructors.
</summary>
<param name="constructorBindings">Available constructors.</param>
<returns>The best constructor.</returns>
</member>
<member name="T:Autofac.Core.Activators.Reflection.MatchingSignatureConstructorSelector">
<summary>
Selects a constructor based on its signature.
</summary>
</member>
<member name="M:Autofac.Core.Activators.Reflection.MatchingSignatureConstructorSelector.#ctor(System.Type[])">
<summary>
Match constructors with the provided signature.
</summary>
<param name="signature">Signature to match.</param>
</member>
<member name="M:Autofac.Core.Activators.Reflection.MatchingSignatureConstructorSelector.SelectConstructorBinding(Autofac.Core.Activators.Reflection.ConstructorParameterBinding[])">
<summary>
Selects the best constructor from the available constructors.
</summary>
<param name="constructorBindings">Available constructors.</param>
<returns>The best constructor.</returns>
</member>
<member name="T:Autofac.Core.Activators.Reflection.MatchingSignatureConstructorSelectorResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.MatchingSignatureConstructorSelectorResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.MatchingSignatureConstructorSelectorResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.MatchingSignatureConstructorSelectorResources.AtLeastOneBindingRequired">
<summary>
Looks up a localized string similar to At least one binding must be provided in order to select a constructor..
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.MatchingSignatureConstructorSelectorResources.RequiredConstructorNotAvailable">
<summary>
Looks up a localized string similar to The required constructor on type '{0}' with signature '{1}' is unavailable..
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.MatchingSignatureConstructorSelectorResources.TooManyConstructorsMatch">
<summary>
Looks up a localized string similar to More than one constructor matches the signature '{0}'..
</summary>
</member>
<member name="T:Autofac.Core.Activators.Reflection.MostParametersConstructorSelector">
<summary>
Selects the constructor with the most parameters.
</summary>
</member>
<member name="M:Autofac.Core.Activators.Reflection.MostParametersConstructorSelector.SelectConstructorBinding(Autofac.Core.Activators.Reflection.ConstructorParameterBinding[])">
<summary>
Selects the best constructor from the available constructors.
</summary>
<param name="constructorBindings">Available constructors.</param>
<returns>The best constructor.</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException">A single unambiguous match could not be chosen.</exception>
</member>
<member name="T:Autofac.Core.Activators.Reflection.ReflectionActivator">
<summary>
Uses reflection to activate instances of a type.
</summary>
</member>
<member name="M:Autofac.Core.Activators.Reflection.ReflectionActivator.#ctor(System.Type,Autofac.Core.Activators.Reflection.IConstructorFinder,Autofac.Core.Activators.Reflection.IConstructorSelector,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Create an activator for the provided type.
</summary>
<param name="implementationType">Type to activate.</param>
<param name="constructorFinder">Constructor finder.</param>
<param name="constructorSelector">Constructor selector.</param>
<param name="configuredParameters">Parameters configured explicitly for this instance.</param>
<param name="configuredProperties">Properties configured explicitly for this instance.</param>
</member>
<member name="M:Autofac.Core.Activators.Reflection.ReflectionActivator.ActivateInstance(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Activate an instance in the provided context.
</summary>
<param name="context">Context in which to activate instances.</param>
<param name="parameters">Parameters to the instance.</param>
<returns>The activated instance.</returns>
<remarks>
The context parameter here should probably be ILifetimeScope in order to reveal Disposer,
but will wait until implementing a concrete use case to make the decision
</remarks>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ReflectionActivator.ConstructorFinder">
<summary>
The constructor finder.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ReflectionActivator.ConstructorSelector">
<summary>
The constructor selector.
</summary>
</member>
<member name="T:Autofac.Core.Activators.Reflection.ReflectionActivatorResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ReflectionActivatorResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ReflectionActivatorResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ReflectionActivatorResources.NoConstructorsAvailable">
<summary>
Looks up a localized string similar to No constructors on type '{0}' can be found with the constructor finder '{1}'..
</summary>
</member>
<member name="P:Autofac.Core.Activators.Reflection.ReflectionActivatorResources.NoConstructorsBindable">
<summary>
Looks up a localized string similar to None of the constructors found with '{0}' on type '{1}' can be invoked with the available services and parameters:{2}.
</summary>
</member>
<member name="T:Autofac.Core.ConstantParameter">
<summary>
Base class for parameters that provide a constant value.
</summary>
</member>
<member name="M:Autofac.Core.ConstantParameter.#ctor(System.Object,System.Predicate{System.Reflection.ParameterInfo})">
<summary>
Create a constant parameter that will apply to parameters matching
the supplied predicate.
</summary>
<param name="value"></param>
<param name="predicate"></param>
</member>
<member name="M:Autofac.Core.ConstantParameter.CanSupplyValue(System.Reflection.ParameterInfo,Autofac.IComponentContext,System.Func{System.Object}@)">
<summary>
Returns true if the parameter is able to provide a value to a particular site.
</summary>
<param name="pi">Constructor, method, or property-mutator parameter.</param>
<param name="context">The component context in which the value is being provided.</param>
<param name="valueProvider">If the result is true, the valueProvider parameter will
be set to a function that will lazily retrieve the parameter value. If the result is false,
will be set to null.</param>
<returns>True if a value can be supplied; otherwise, false.</returns>
</member>
<member name="P:Autofac.Core.ConstantParameter.Value">
<summary>
The value of the parameter.
</summary>
</member>
<member name="T:Autofac.Core.Container">
<summary>
Standard container implementation.
</summary>
</member>
<member name="T:Autofac.IContainer">
<summary>
Creates, wires dependencies and manages lifetime for a set of components.
Most instances of <see cref="T:Autofac.IContainer"/> are created
by a <see cref="T:Autofac.ContainerBuilder"/>.
</summary>
<example>
<code>
// See ContainerBuilder for the definition of the builder variable
using (var container = builder.Build())
{
var program = container.Resolve<Program>();
program.Run();
}
</code>
</example>
<remarks>
Most <see cref="T:Autofac.IContainer"/> functionality is provided by extension methods
on the inherited <see cref="T:Autofac.IComponentContext"/> interface.
</remarks>
<seealso cref="T:Autofac.ILifetimeScope"/>
<seealso cref="T:Autofac.IComponentContext"/>
<seealso cref="T:Autofac.ResolutionExtensions"/>
<seealso cref="T:Autofac.ContainerBuilder"/>
</member>
<member name="T:Autofac.ILifetimeScope">
<summary>
An <see cref="T:Autofac.ILifetimeScope"/> tracks the instantiation of component instances.
It defines a boundary in which instances are shared and configured.
Disposing an <see cref="T:Autofac.ILifetimeScope"/> will dispose the components that were
resolved through it.
</summary>
<example>
<code>
// See IContainer for definition of the container variable
using (var requestScope = container.BeginLifetimeScope())
{
// Note that handler is resolved from requestScope, not
// from the container:
var handler = requestScope.Resolve<IRequestHandler>();
handler.Handle(request);
// When requestScope is disposed, all resources used in processing
// the request will be released.
}
</code>
</example>
<remarks>
All long-running applications should resolve components via an
<see cref="T:Autofac.ILifetimeScope"/>. Choosing the duration of the lifetime is application-
specific. The standard Autofac WCF and ASP.NET/MVC integrations are already configured
to create and release <see cref="T:Autofac.ILifetimeScope"/>s as appropriate. For example, the
ASP.NET integration will create and release an <see cref="T:Autofac.ILifetimeScope"/> per HTTP
request.
Most <see cref="T:Autofac.ILifetimeScope"/> functionality is provided by extension methods
on the inherited <see cref="T:Autofac.IComponentContext"/> interface.
</remarks>
<seealso cref="T:Autofac.IContainer"/>
<seealso cref="T:Autofac.IComponentContext"/>
<seealso cref="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerMatchingLifetimeScope(System.Object[])"/>
<seealso cref="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerLifetimeScope"/>
<seealso cref="T:Autofac.Core.InstanceSharing"/>
<seealso cref="T:Autofac.Core.IComponentLifetime"/>
</member>
<member name="T:Autofac.IComponentContext">
<summary>
The context in which a service can be accessed or a component's
dependencies resolved. Disposal of a context will dispose any owned
components.
</summary>
</member>
<member name="M:Autofac.IComponentContext.ResolveComponent(Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Resolve an instance of the provided registration within the context.
</summary>
<param name="registration">The registration.</param>
<param name="parameters">Parameters for the instance.</param>
<returns>
The component instance.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="P:Autofac.IComponentContext.ComponentRegistry">
<summary>
Associates services with the components that provide them.
</summary>
</member>
<member name="M:Autofac.ILifetimeScope.BeginLifetimeScope">
<summary>
Begin a new nested scope. Component instances created via the new scope
will be disposed along with it.
</summary>
<returns>A new lifetime scope.</returns>
</member>
<member name="M:Autofac.ILifetimeScope.BeginLifetimeScope(System.Object)">
<summary>
Begin a new nested scope. Component instances created via the new scope
will be disposed along with it.
</summary>
<param name="tag">The tag applied to the <see cref="T:Autofac.ILifetimeScope"/>.</param>
<returns>A new lifetime scope.</returns>
</member>
<member name="M:Autofac.ILifetimeScope.BeginLifetimeScope(System.Action{Autofac.ContainerBuilder})">
<summary>
Begin a new nested scope, with additional components available to it.
Component instances created via the new scope
will be disposed along with it.
</summary>
<remarks>
The components registered in the sub-scope will be treated as though they were
registered in the root scope, i.e., SingleInstance() components will live as long
as the root scope.
</remarks>
<param name="configurationAction">Action on a <see cref="T:Autofac.ContainerBuilder"/>
that adds component registations visible only in the new scope.</param>
<returns>A new lifetime scope.</returns>
</member>
<member name="M:Autofac.ILifetimeScope.BeginLifetimeScope(System.Object,System.Action{Autofac.ContainerBuilder})">
<summary>
Begin a new nested scope, with additional components available to it.
Component instances created via the new scope
will be disposed along with it.
</summary>
<remarks>
The components registered in the sub-scope will be treated as though they were
registered in the root scope, i.e., SingleInstance() components will live as long
as the root scope.
</remarks>
<param name="tag">The tag applied to the <see cref="T:Autofac.ILifetimeScope"/>.</param>
<param name="configurationAction">Action on a <see cref="T:Autofac.ContainerBuilder"/>
that adds component registations visible only in the new scope.</param>
<returns>A new lifetime scope.</returns>
</member>
<member name="P:Autofac.ILifetimeScope.Disposer">
<summary>
The disposer associated with this <see cref="T:Autofac.ILifetimeScope"/>.
Component instances can be associated with it manually if required.
</summary>
<remarks>Typical usage does not require interaction with this member- it
is used when extending the container.</remarks>
</member>
<member name="P:Autofac.ILifetimeScope.Tag">
<summary>
The tag applied to the <see cref="T:Autofac.ILifetimeScope"/>.
</summary>
<remarks>Tags allow a level in the lifetime hierarchy to be identified.
In most applications, tags are not necessary.</remarks>
<seealso cref="M:Autofac.Builder.IRegistrationBuilder`3.InstancePerMatchingLifetimeScope(System.Object[])"/>
</member>
<member name="E:Autofac.ILifetimeScope.ChildLifetimeScopeBeginning">
<summary>
Fired when a new scope based on the current scope is beginning.
</summary>
</member>
<member name="E:Autofac.ILifetimeScope.CurrentScopeEnding">
<summary>
Fired when this scope is ending.
</summary>
</member>
<member name="E:Autofac.ILifetimeScope.ResolveOperationBeginning">
<summary>
Fired when a resolve operation is beginning in this scope.
</summary>
</member>
<member name="M:Autofac.Core.Container.#ctor">
<summary>
Create a new container.
</summary>
</member>
<member name="M:Autofac.Core.Container.BeginLifetimeScope">
<summary>
Begin a new sub-scope. Instances created via the sub-scope
will be disposed along with it.
</summary>
<returns>A new lifetime scope.</returns>
</member>
<member name="M:Autofac.Core.Container.BeginLifetimeScope(System.Object)">
<summary>
Begin a new sub-scope. Instances created via the sub-scope
will be disposed along with it.
</summary>
<param name="tag">The tag applied to the <see cref="T:Autofac.ILifetimeScope"/>.</param>
<returns>A new lifetime scope.</returns>
</member>
<member name="M:Autofac.Core.Container.BeginLifetimeScope(System.Action{Autofac.ContainerBuilder})">
<summary>
Begin a new nested scope, with additional components available to it.
Component instances created via the new scope
will be disposed along with it.
</summary>
<param name="configurationAction">Action on a <see cref="T:Autofac.ContainerBuilder"/>
that adds component registations visible only in the new scope.</param>
<returns>A new lifetime scope.</returns>
</member>
<member name="M:Autofac.Core.Container.BeginLifetimeScope(System.Object,System.Action{Autofac.ContainerBuilder})">
<summary>
Begin a new nested scope, with additional components available to it.
Component instances created via the new scope
will be disposed along with it.
</summary>
<param name="tag">The tag applied to the <see cref="T:Autofac.ILifetimeScope"/>.</param>
<param name="configurationAction">Action on a <see cref="T:Autofac.ContainerBuilder"/>
that adds component registations visible only in the new scope.</param>
<returns>A new lifetime scope.</returns>
</member>
<member name="M:Autofac.Core.Container.ResolveComponent(Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Resolve an instance of the provided registration within the context.
</summary>
<param name="registration">The registration.</param>
<param name="parameters">Parameters for the instance.</param>
<returns>
The component instance.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.Core.Container.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="M:Autofac.Core.Container.GetService(System.Type)">
<summary>
Gets the service object of the specified type.
</summary>
<param name="serviceType">An object that specifies the type of service object
to get.</param>
<returns>
A service object of type <paramref name="serviceType"/>.-or- null if there is
no service object of type <paramref name="serviceType"/>.
</returns>
</member>
<member name="P:Autofac.Core.Container.Disposer">
<summary>
The disposer associated with this container. Instances can be associated
with it manually if required.
</summary>
</member>
<member name="P:Autofac.Core.Container.Tag">
<summary>
Tag applied to the lifetime scope.
</summary>
<remarks>The tag applied to this scope and the contexts generated when
it resolves component dependencies.</remarks>
</member>
<member name="E:Autofac.Core.Container.ChildLifetimeScopeBeginning">
<summary>
Fired when a new scope based on the current scope is beginning.
</summary>
</member>
<member name="E:Autofac.Core.Container.CurrentScopeEnding">
<summary>
Fired when this scope is ending.
</summary>
</member>
<member name="E:Autofac.Core.Container.ResolveOperationBeginning">
<summary>
Fired when a resolve operation is beginning in this scope.
</summary>
</member>
<member name="P:Autofac.Core.Container.ComponentRegistry">
<summary>
Associates services with the components that provide them.
</summary>
</member>
<member name="T:Autofac.Core.DependencyResolutionException">
<summary>
Base exception type thrown whenever the dependency resolution process fails. This is a fatal
exception, as Autofac is unable to 'roll back' changes to components that may have already
been made during the operation. For example, 'on activated' handlers may have already been
fired, or 'single instance' components partially constructed.
</summary>
</member>
<member name="M:Autofac.Core.DependencyResolutionException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.DependencyResolutionException"/> class.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:Autofac.Core.DependencyResolutionException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.DependencyResolutionException"/> class.
</summary>
<param name="message">The message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="P:Autofac.Core.DependencyResolutionException.Message">
<summary>
Gets a message that describes the current exception.
</summary>
<value>
The error message that explains the reason for the exception, or an empty string("").
</value>
</member>
<member name="T:Autofac.Core.Disposer">
<summary>
Maintains a set of objects to dispose, and disposes them in the reverse order
from which they were added when the Disposer is itself disposed.
</summary>
</member>
<member name="T:Autofac.Core.IDisposer">
<summary>
Provided on an object that will dispose of other objects when it is
itself disposed.
</summary>
</member>
<member name="M:Autofac.Core.IDisposer.AddInstanceForDisposal(System.IDisposable)">
<summary>
Adds an object to the disposer. When the disposer is
disposed, so will the object be.
</summary>
<param name="instance">The instance.</param>
</member>
<member name="F:Autofac.Core.Disposer._items">
<summary>
Contents all implement IDisposable.
</summary>
</member>
<member name="M:Autofac.Core.Disposer.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="M:Autofac.Core.Disposer.AddInstanceForDisposal(System.IDisposable)">
<summary>
Adds an object to the disposer. When the disposer is
disposed, so will the object be.
</summary>
<param name="instance">The instance.</param>
</member>
<member name="T:Autofac.Core.IComponentLifetime">
<summary>
Locates the lifetime to which instances of a component should be attached.
</summary>
</member>
<member name="M:Autofac.Core.IComponentLifetime.FindScope(Autofac.Core.ISharingLifetimeScope)">
<summary>
Given the most nested scope visible within the resolve operation, find
the scope for the component.
</summary>
<param name="mostNestedVisibleScope">The most nested visible scope.</param>
<returns>The scope for the component.</returns>
</member>
<member name="T:Autofac.Core.IModule">
<summary>
Represents a set of components and related functionality
packaged together.
</summary>
</member>
<member name="M:Autofac.Core.IModule.Configure(Autofac.Core.IComponentRegistry)">
<summary>
Apply the module to the component registry.
</summary>
<param name="componentRegistry">Component registry to apply configuration to.</param>
</member>
<member name="T:Autofac.Core.InstanceOwnership">
<summary>
Determines when instances supporting IDisposable are disposed.
</summary>
</member>
<member name="F:Autofac.Core.InstanceOwnership.ExternallyOwned">
<summary>
The lifetime scope does not dispose the instances.
</summary>
</member>
<member name="F:Autofac.Core.InstanceOwnership.OwnedByLifetimeScope">
<summary>
The instances are disposed when the lifetime scope is disposed.
</summary>
</member>
<member name="T:Autofac.Core.InstanceSharing">
<summary>
Determines whether instances are shared within a lifetime scope.
</summary>
</member>
<member name="F:Autofac.Core.InstanceSharing.None">
<summary>
Each request for an instance will return a new object.
</summary>
</member>
<member name="F:Autofac.Core.InstanceSharing.Shared">
<summary>
Each request for an instance will return the same object.
</summary>
</member>
<member name="T:Autofac.Core.ISharingLifetimeScope">
<summary>
Defines a nested structure of lifetimes.
</summary>
</member>
<member name="M:Autofac.Core.ISharingLifetimeScope.GetOrCreateAndShare(System.Guid,System.Func{System.Object})">
<summary>
Try to retrieve an instance based on a GUID key. If the instance
does not exist, invoke <paramref name="creator"/> to create it.
</summary>
<param name="id">Key to look up.</param>
<param name="creator">Creation function.</param>
<returns>An instance.</returns>
</member>
<member name="P:Autofac.Core.ISharingLifetimeScope.RootLifetimeScope">
<summary>
The root of the sharing hierarchy.
</summary>
</member>
<member name="P:Autofac.Core.ISharingLifetimeScope.ParentLifetimeScope">
<summary>
The parent of this node of the hierarchy, or null.
</summary>
</member>
<member name="T:Autofac.Core.Lifetime.CurrentScopeLifetime">
<summary>
Attaches the instance's lifetime to the current lifetime scope.
</summary>
</member>
<member name="M:Autofac.Core.Lifetime.CurrentScopeLifetime.FindScope(Autofac.Core.ISharingLifetimeScope)">
<summary>
Given the most nested scope visible within the resolve operation, find
the scope for the component.
</summary>
<param name="mostNestedVisibleScope">The most nested visible scope.</param>
<returns>The scope for the component.</returns>
</member>
<member name="T:Autofac.Core.Lifetime.LifetimeScope">
<summary>
Lifetime scope implementation.
</summary>
</member>
<member name="F:Autofac.Core.Lifetime.LifetimeScope._synchRoot">
<summary>
Protects shared instances from concurrent access. Other members and the base class are threadsafe.
</summary>
</member>
<member name="F:Autofac.Core.Lifetime.LifetimeScope.RootTag">
<summary>
The tag applied to root scopes when no other tag is specified.
</summary>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.#ctor(Autofac.Core.IComponentRegistry,Autofac.Core.Lifetime.LifetimeScope,System.Object)">
<summary>
Create a lifetime scope for the provided components and nested beneath a parent.
</summary>
<param name="tag">The tag applied to the <see cref="T:Autofac.ILifetimeScope"/>.</param>
<param name="componentRegistry">Components used in the scope.</param>
<param name="parent">Parent scope.</param>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.#ctor(Autofac.Core.IComponentRegistry,System.Object)">
<summary>
Create a root lifetime scope for the provided components.
</summary>
<param name="tag">The tag applied to the <see cref="T:Autofac.ILifetimeScope"/>.</param>
<param name="componentRegistry">Components used in the scope.</param>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.#ctor(Autofac.Core.IComponentRegistry)">
<summary>
Create a root lifetime scope for the provided components.
</summary>
<param name="componentRegistry">Components used in the scope.</param>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.BeginLifetimeScope">
<summary>
Begin a new anonymous sub-scope. Instances created via the sub-scope
will be disposed along with it.
</summary>
<returns>A new lifetime scope.</returns>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.BeginLifetimeScope(System.Object)">
<summary>
Begin a new tagged sub-scope. Instances created via the sub-scope
will be disposed along with it.
</summary>
<param name="tag">The tag applied to the <see cref="T:Autofac.ILifetimeScope"/>.</param>
<returns>A new lifetime scope.</returns>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.BeginLifetimeScope(System.Action{Autofac.ContainerBuilder})">
<summary>
Begin a new anonymous sub-scope, with additional components available to it.
Component instances created via the new scope
will be disposed along with it.
</summary>
<param name="configurationAction">Action on a <see cref="T:Autofac.ContainerBuilder"/>
that adds component registations visible only in the new scope.</param>
<returns>A new lifetime scope.</returns>
<example>
IContainer cr = // ...
using (var lifetime = cr.BeginLifetimeScope(builder => {
builder.RegisterType<Foo>();
builder.RegisterType<Bar>().As<IBar>(); })
{
var foo = lifetime.Resolve<Foo>();
}
</example>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.BeginLifetimeScope(System.Object,System.Action{Autofac.ContainerBuilder})">
<summary>
Begin a new tagged sub-scope, with additional components available to it.
Component instances created via the new scope
will be disposed along with it.
</summary>
<param name="tag">The tag applied to the <see cref="T:Autofac.ILifetimeScope"/>.</param>
<param name="configurationAction">Action on a <see cref="T:Autofac.ContainerBuilder"/>
that adds component registations visible only in the new scope.</param>
<returns>A new lifetime scope.</returns>
<example>
IContainer cr = // ...
using (var lifetime = cr.BeginLifetimeScope("unitOfWork", builder => {
builder.RegisterType<Foo>();
builder.RegisterType<Bar>().As<IBar>(); })
{
var foo = lifetime.Resolve<Foo>();
}
</example>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.ResolveComponent(Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Resolve an instance of the provided registration within the context.
</summary>
<param name="registration">The registration.</param>
<param name="parameters">Parameters for the instance.</param>
<returns>
The component instance.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.GetOrCreateAndShare(System.Guid,System.Func{System.Object})">
<summary>
Try to retrieve an instance based on a GUID key. If the instance
does not exist, invoke <paramref name="creator"/> to create it.
</summary>
<param name="id">Key to look up.</param>
<param name="creator">Creation function.</param>
<returns>An instance.</returns>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="M:Autofac.Core.Lifetime.LifetimeScope.GetService(System.Type)">
<summary>
Gets the service object of the specified type.
</summary>
<param name="serviceType">An object that specifies the type of service object
to get.</param>
<returns>
A service object of type <paramref name="serviceType"/>.-or- null if there is
no service object of type <paramref name="serviceType"/>.
</returns>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScope.ParentLifetimeScope">
<summary>
The parent of this node of the hierarchy, or null.
</summary>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScope.RootLifetimeScope">
<summary>
The root of the sharing hierarchy.
</summary>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScope.Disposer">
<summary>
The disposer associated with this container. Instances can be associated
with it manually if required.
</summary>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScope.Tag">
<summary>
Tag applied to the lifetime scope.
</summary>
<remarks>The tag applied to this scope and the contexts generated when
it resolves component dependencies.</remarks>
</member>
<member name="P:Autofac.Core.Lifetime.LifetimeScope.ComponentRegistry">
<summary>
Associates services with the components that provide them.
</summary>
</member>
<member name="E:Autofac.Core.Lifetime.LifetimeScope.ChildLifetimeScopeBeginning">
<summary>
Fired when a new scope based on the current scope is beginning.
</summary>
</member>
<member name="E:Autofac.Core.Lifetime.LifetimeScope.CurrentScopeEnding">
<summary>
Fired when this scope is ending.
</summary>
</member>
<member name="E:Autofac.Core.Lifetime.LifetimeScope.ResolveOperationBeginning">
<summary>
Fired when a resolve operation is beginning in this scope.
</summary>
</member>
<member name="T:Autofac.Core.Lifetime.MatchingScopeLifetime">
<summary>
Attaches the component's lifetime to scopes matching a supplied expression.
</summary>
</member>
<member name="M:Autofac.Core.Lifetime.MatchingScopeLifetime.#ctor(System.Object[])">
<summary>
Match scopes by comparing tags for equality.
</summary>
<param name="lifetimeScopeTagsToMatch">The tags applied to matching scopes.</param>
</member>
<member name="M:Autofac.Core.Lifetime.MatchingScopeLifetime.FindScope(Autofac.Core.ISharingLifetimeScope)">
<summary>
Given the most nested scope visible within the resolve operation, find
the scope for the component.
</summary>
<param name="mostNestedVisibleScope">The most nested visible scope.</param>
<returns>The scope for the component.</returns>
</member>
<member name="T:Autofac.Core.Lifetime.MatchingScopeLifetimeResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Lifetime.MatchingScopeLifetimeResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Lifetime.MatchingScopeLifetimeResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Lifetime.MatchingScopeLifetimeResources.MatchingScopeNotFound">
<summary>
Looks up a localized string similar to No scope with a Tag matching '{0}' is visible from the scope in which the instance was requested. This generally indicates that a component registered as per-HTTP request is being requested by a SingleInstance() component (or a similar scenario.) Under the web integration always request dependencies from the DependencyResolver.Current or ILifetimeScopeProvider.RequestLifetime, never from the container itself..
</summary>
</member>
<member name="T:Autofac.Core.Lifetime.RootScopeLifetime">
<summary>
Attaches the component's lifetime to the root scope.
</summary>
</member>
<member name="M:Autofac.Core.Lifetime.RootScopeLifetime.FindScope(Autofac.Core.ISharingLifetimeScope)">
<summary>
Given the most nested scope visible within the resolve operation, find
the scope for the component.
</summary>
<param name="mostNestedVisibleScope">The most nested visible scope.</param>
<returns>The scope for the component.</returns>
</member>
<member name="T:Autofac.Core.NamedPropertyParameter">
<summary>
A property identified by name. When applied to a reflection-based
component, the name will be matched against property names.
</summary>
</member>
<member name="M:Autofac.Core.NamedPropertyParameter.#ctor(System.String,System.Object)">
<summary>
Create a <see cref="T:Autofac.Core.NamedPropertyParameter"/> with the specified constant value.
</summary>
<param name="name">The name of the property.</param>
<param name="value">The property value.</param>
</member>
<member name="P:Autofac.Core.NamedPropertyParameter.Name">
<summary>
The name of the property.
</summary>
</member>
<member name="T:Autofac.Core.PreparingEventArgs">
<summary>
Fired before the activation process to allow parameters to be changed or an alternative
instance to be provided.
</summary>
</member>
<member name="M:Autofac.Core.PreparingEventArgs.#ctor(Autofac.IComponentContext,Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.PreparingEventArgs"/> class.
</summary>
<param name="context">The context.</param>
<param name="component">The component.</param>
<param name="parameters">The parameters.</param>
</member>
<member name="P:Autofac.Core.PreparingEventArgs.Context">
<summary>
The context in which the activation is occurring.
</summary>
</member>
<member name="P:Autofac.Core.PreparingEventArgs.Component">
<summary>
The component providing the instance being activated.
</summary>
</member>
<member name="P:Autofac.Core.PreparingEventArgs.Parameters">
<summary>
The parameters supplied to the activator.
</summary>
</member>
<member name="T:Autofac.Core.Registration.ComponentNotRegisteredException">
<summary>
A service was requested that cannot be provided by the container. To avoid this exception, either register a component
to provide the required service, check for service registration using IsRegistered(), or use the ResolveOptional()
method to resolve an optional dependency.
</summary>
<remarks>This exception is fatal. See <see cref="T:Autofac.Core.DependencyResolutionException"/> for more information.</remarks>
</member>
<member name="M:Autofac.Core.Registration.ComponentNotRegisteredException.#ctor(Autofac.Core.Service)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/> class.
</summary>
<param name="service">The service.</param>
</member>
<member name="M:Autofac.Core.Registration.ComponentNotRegisteredException.#ctor(Autofac.Core.Service,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/> class.
</summary>
<param name="service">The service.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="T:Autofac.Core.Registration.ComponentNotRegisteredExceptionResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentNotRegisteredExceptionResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentNotRegisteredExceptionResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentNotRegisteredExceptionResources.Message">
<summary>
Looks up a localized string similar to The requested service '{0}' has not been registered. To avoid this exception, either register a component to provide the service, check for service registration using IsRegistered(), or use the ResolveOptional() method to resolve an optional dependency..
</summary>
</member>
<member name="T:Autofac.Core.ComponentRegisteredEventArgs">
<summary>
Information about the ocurrence of a component being registered
with a container.
</summary>
</member>
<member name="M:Autofac.Core.ComponentRegisteredEventArgs.#ctor(Autofac.Core.IComponentRegistry,Autofac.Core.IComponentRegistration)">
<summary>
Create a new instance with a valid container and component registration.
</summary>
<param name="registry">The container into which the registration
was made.</param>
<param name="componentRegistration">The component registration.</param>
</member>
<member name="P:Autofac.Core.ComponentRegisteredEventArgs.ComponentRegistry">
<summary>
The container into which the registration was made.
</summary>
</member>
<member name="P:Autofac.Core.ComponentRegisteredEventArgs.ComponentRegistration">
<summary>
The component registration.
</summary>
</member>
<member name="T:Autofac.Core.Registration.ComponentRegistration">
<summary>
Describes a logical component within the container.
</summary>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistration.#ctor(System.Guid,Autofac.Core.IInstanceActivator,Autofac.Core.IComponentLifetime,Autofac.Core.InstanceSharing,Autofac.Core.InstanceOwnership,System.Collections.Generic.IEnumerable{Autofac.Core.Service},System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Create a new component registration.
</summary>
<param name="id">Unique identifier for the component.</param>
<param name="activator">Activator used to activate instances.</param>
<param name="lifetime">Determines how the component will be associated with its lifetime.</param>
<param name="sharing">Whether the component is shared within its lifetime scope.</param>
<param name="ownership">Whether the component instances are disposed at the end of their lifetimes.</param>
<param name="services">Services the component provides.</param>
<param name="metadata">Data associated with the component.</param>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistration.#ctor(System.Guid,Autofac.Core.IInstanceActivator,Autofac.Core.IComponentLifetime,Autofac.Core.InstanceSharing,Autofac.Core.InstanceOwnership,System.Collections.Generic.IEnumerable{Autofac.Core.Service},System.Collections.Generic.IDictionary{System.String,System.Object},Autofac.Core.IComponentRegistration)">
<summary>
Create a new component registration.
</summary>
<param name="id">Unique identifier for the component.</param>
<param name="activator">Activator used to activate instances.</param>
<param name="lifetime">Determines how the component will be associated with its lifetime.</param>
<param name="sharing">Whether the component is shared within its lifetime scope.</param>
<param name="ownership">Whether the component instances are disposed at the end of their lifetimes.</param>
<param name="services">Services the component provides.</param>
<param name="metadata">Data associated with the component.</param>
<param name="target">The component registration upon which this registration is based.</param>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistration.RaisePreparing(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter}@)">
<summary>
Called by the container when an instance is required.
</summary>
<param name="context">The context in which the instance will be activated.</param>
<param name="parameters">Parameters for activation.</param>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistration.RaiseActivating(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Object@)">
<summary>
Called by the container once an instance has been constructed.
</summary>
<param name="context">The context in which the instance was activated.</param>
<param name="parameters">The parameters supplied to the activator.</param>
<param name="instance">The instance.</param>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistration.RaiseActivated(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Object)">
<summary>
Called by the container once an instance has been fully constructed, including
any requested objects that depend on the instance.
</summary>
<param name="context">The context in which the instance was activated.</param>
<param name="parameters">The parameters supplied to the activator.</param>
<param name="instance">The instance.</param>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistration.ToString">
<summary>
Describes the component in a human-readable form.
</summary>
<returns>A description of the component.</returns>
</member>
<member name="M:Autofac.Core.Registration.ComponentRegistration.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistration.Target">
<summary>
The component registration upon which this registration is based.
If this registration was created directly by the user, returns this.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistration.Id">
<summary>
A unique identifier for this component (shared in all sub-contexts.)
This value also appears in Services.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistration.Activator">
<summary>
The activator used to create instances.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistration.Lifetime">
<summary>
The lifetime associated with the component.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistration.Sharing">
<summary>
Whether the component instances are shared or not.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistration.Ownership">
<summary>
Whether the instances of the component should be disposed by the container.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistration.Services">
<summary>
The services provided by the component.
</summary>
</member>
<member name="P:Autofac.Core.Registration.ComponentRegistration.Metadata">
<summary>
Additional data associated with the component.
</summary>
</member>
<member name="E:Autofac.Core.Registration.ComponentRegistration.Preparing">
<summary>
Fired when a new instance is required. The instance can be
provided in order to skip the regular activator, by setting the Instance property in
the provided event arguments.
</summary>
</member>
<member name="E:Autofac.Core.Registration.ComponentRegistration.Activating">
<summary>
Fired when a new instance is being activated. The instance can be
wrapped or switched at this time by setting the Instance property in
the provided event arguments.
</summary>
</member>
<member name="E:Autofac.Core.Registration.ComponentRegistration.Activated">
<summary>
Fired when the activation process for a new instance is complete.
</summary>
</member>
<member name="F:Autofac.Core.Resolving.CircularDependencyDetector.MaxResolveDepth">
<summary>
Catch circular dependencies that are triggered by post-resolve processing (e.g. 'OnActivated')
</summary>
</member>
<member name="T:Autofac.Core.Resolving.CircularDependencyDetectorResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.CircularDependencyDetectorResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.CircularDependencyDetectorResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.CircularDependencyDetectorResources.CircularDependency">
<summary>
Looks up a localized string similar to Circular component dependency detected: {0}..
</summary>
</member>
<member name="P:Autofac.Core.Resolving.CircularDependencyDetectorResources.MaxDepthExceeded">
<summary>
Looks up a localized string similar to Probable circular dependency between factory-scoped components. Chain includes '{0}'.
</summary>
</member>
<member name="T:Autofac.Core.Resolving.IResolveOperation">
<summary>
An <see cref="T:Autofac.Core.Resolving.IResolveOperation"/> is a component context that sequences and monitors the multiple
activations that go into producing a single requested object graph.
</summary>
</member>
<member name="M:Autofac.Core.Resolving.IResolveOperation.GetOrCreateInstance(Autofac.Core.ISharingLifetimeScope,Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Get or create and share an instance of <paramref name="registration"/> in the <paramref name="currentOperationScope"/>.
</summary>
<param name="currentOperationScope">The scope in the hierarchy in which the operation will begin.</param>
<param name="registration">The component to resolve.</param>
<param name="parameters">Parameters for the component.</param>
<returns>The component instance.</returns>
</member>
<member name="E:Autofac.Core.Resolving.IResolveOperation.CurrentOperationEnding">
<summary>
Raised when the entire operation is complete.
</summary>
</member>
<member name="E:Autofac.Core.Resolving.IResolveOperation.InstanceLookupBeginning">
<summary>
Raised when an instance is looked up within the operation.
</summary>
</member>
<member name="T:Autofac.Core.Resolving.ResolveOperation">
<summary>
A <see cref="T:Autofac.Core.Resolving.ResolveOperation"/> is a component context that sequences and monitors the multiple
activations that go into producing a single requested object graph.
</summary>
</member>
<member name="M:Autofac.Core.Resolving.ResolveOperation.#ctor(Autofac.Core.ISharingLifetimeScope)">
<summary>
Create an instance of <see cref="T:Autofac.Core.Resolving.ResolveOperation"/> in the provided scope.
</summary>
<param name="mostNestedLifetimeScope">The most nested scope in which to begin the operation. The operation
can move upward to less nested scopes as components with wider sharing scopes are activated</param>
</member>
<member name="M:Autofac.Core.Resolving.ResolveOperation.ResolveComponent(Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Resolve an instance of the provided registration within the context.
</summary>
<param name="registration">The registration.</param>
<param name="parameters">Parameters for the instance.</param>
<returns>
The component instance.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.Core.Resolving.ResolveOperation.Execute(Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Execute the complete resolve operation.
</summary>
</member>
<member name="M:Autofac.Core.Resolving.ResolveOperation.GetOrCreateInstance(Autofac.Core.ISharingLifetimeScope,Autofac.Core.IComponentRegistration,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Continue building the object graph by instantiating <paramref name="registration"/> in the
current <paramref name="currentOperationScope"/>.
</summary>
<param name="currentOperationScope">The current scope of the operation.</param>
<param name="registration">The component to activate.</param>
<param name="parameters">The parameters for the component.</param>
<returns>The resolved instance.</returns>
<exception cref="T:System.ArgumentNullException"/>
</member>
<member name="P:Autofac.Core.Resolving.ResolveOperation.ComponentRegistry">
<summary>
Associates services with the components that provide them.
</summary>
</member>
<member name="T:Autofac.Core.Resolving.ResolveOperationResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.ResolveOperationResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.ResolveOperationResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.ResolveOperationResources.ExceptionDuringResolve">
<summary>
Looks up a localized string similar to An exception was thrown while executing a resolve operation. See the InnerException for details..
</summary>
</member>
<member name="P:Autofac.Core.Resolving.ResolveOperationResources.MaxDepthExceeded">
<summary>
Looks up a localized string similar to Probable circular dependency between factory-scoped components. Chain includes '{0}'.
</summary>
</member>
<member name="P:Autofac.Core.Resolving.ResolveOperationResources.TemporaryContextDisposed">
<summary>
Looks up a localized string similar to This resolve operation has already ended. When registering components using lambdas, the IComponentContext 'c' parameter to the lambda cannot be stored. Instead, either resolve IComponentContext again from 'c', or resolve a Func<> based factory to create subsequent components from..
</summary>
</member>
<member name="T:Autofac.Core.TypedService">
<summary>
Identifies a service according to a type to which it can be assigned.
</summary>
</member>
<member name="M:Autofac.Core.TypedService.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.TypedService"/> class.
</summary>
<param name="serviceType">Type of the service.</param>
</member>
<member name="M:Autofac.Core.TypedService.Equals(Autofac.Core.TypedService)">
<summary>
Indicates whether the current object is equal to another object of the same type.
</summary>
<param name="other">An object to compare with this object.</param>
<returns>
true if the current object is equal to the <paramref name="other" /> parameter; otherwise, false.
</returns>
</member>
<member name="M:Autofac.Core.TypedService.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
</summary>
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
<returns>
true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
</returns>
<exception cref="T:System.NullReferenceException">The <paramref name="obj"/> parameter is null.</exception>
</member>
<member name="M:Autofac.Core.TypedService.GetHashCode">
<summary>
Serves as a hash function for a particular type.
</summary>
<returns>
A hash code for the current <see cref="T:System.Object"/>.
</returns>
</member>
<member name="M:Autofac.Core.TypedService.ChangeType(System.Type)">
<summary>
Return a new service of the same kind, but carrying
<paramref name="newType"/> as the <see cref="P:Autofac.Core.TypedService.ServiceType"/>.
</summary>
<param name="newType">The new service type.</param>
<returns>A new service with the service type.</returns>
</member>
<member name="P:Autofac.Core.TypedService.ServiceType">
<summary>
Gets the type of the service.
</summary>
<value>The type of the service.</value>
</member>
<member name="P:Autofac.Core.TypedService.Description">
<summary>
Gets a human-readable description of the service.
</summary>
<value>The description.</value>
</member>
<member name="T:Autofac.Core.UniqueService">
<summary>
A handy unique service identifier type - all instances will be regarded as unequal.
</summary>
</member>
<member name="M:Autofac.Core.UniqueService.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.UniqueService"/> class.
</summary>
</member>
<member name="M:Autofac.Core.UniqueService.#ctor(System.Guid)">
<summary>
Initializes a new instance of the <see cref="T:Autofac.Core.UniqueService"/> class.
</summary>
<param name="id">The id.</param>
</member>
<member name="M:Autofac.Core.UniqueService.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
</summary>
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
<returns>
true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
</returns>
<exception cref="T:System.NullReferenceException">The <paramref name="obj"/> parameter is null.</exception>
</member>
<member name="M:Autofac.Core.UniqueService.GetHashCode">
<summary>
Serves as a hash function for a particular type.
</summary>
<returns>
A hash code for the current <see cref="T:System.Object"/>.
</returns>
</member>
<member name="P:Autofac.Core.UniqueService.Description">
<summary>
Provides a programmer-readable description of the identifying feature of the service.
</summary>
<value></value>
</member>
<member name="T:Autofac.Features.Collections.CollectionRegistrationSource">
<summary>
Registration source providing implicit collection/list/enumerable support.
</summary>
<remarks>
<para>
This registration source provides enumerable support to allow resolving
the set of all registered services of a given type.
</para>
<para>
What may not be immediately apparent is that it also means any time there
are no items of a particular type registered, it will always return an
empty set rather than <see langword="null" /> or throwing an exception.
This is by design.
</para>
<para>
Consider the [possibly majority] use case where you're resolving a set
of message handlers or event handlers from the container. If there aren't
any handlers, you want an empty set - not <see langword="null" /> or
an exception. It's valid to have no handlers registered.
</para>
<para>
This implicit support means other areas (like MVC support or manual
property injection) must take care to only request enumerable values they
expect to get something back for. In other words, "Don't ask the container
for something you don't expect to resolve."
</para>
</remarks>
</member>
<member name="M:Autofac.Features.Collections.CollectionRegistrationSource.RegistrationsFor(Autofac.Core.Service,System.Func{Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.IComponentRegistration}})">
<summary>
Retrieve registrations for an unregistered service, to be used
by the container.
</summary>
<param name="service">The service that was requested.</param>
<param name="registrationAccessor">A function that will return existing registrations for a service.</param>
<returns>Registrations providing the service.</returns>
</member>
<member name="T:Autofac.Features.OpenGenerics.OpenGenericRegistrationSource">
<summary>
Generates activators for open generic types.
</summary>
</member>
<member name="T:Autofac.Features.OwnedInstances.Owned`1">
<summary>
Represents a dependency that can be released by the dependent component.
</summary>
<typeparam name="T">The service provided by the dependency.</typeparam>
<remarks>
<para>
Autofac automatically provides instances of <see cref="T:Autofac.Features.OwnedInstances.Owned`1"/> whenever the
service <typeparamref name="T"/> is registered.
</para>
<para>
It is not necessary for <typeparamref name="T"/>, or the underlying component, to implement <see cref="T:System.IDisposable"/>.
Disposing of the <see cref="T:Autofac.Features.OwnedInstances.Owned`1"/> object is the correct way to handle cleanup of the dependency,
as this will dispose of any other components created indirectly as well.
</para>
<para>
When <see cref="T:Autofac.Features.OwnedInstances.Owned`1"/> is resolved, a new <see cref="T:Autofac.ILifetimeScope"/> is created for the
underlying <typeparamref name="T"/>, and tagged with the service matching <typeparamref name="T"/>,
generally a <see cref="T:Autofac.Core.TypedService"/>. This means that shared instances can be tied to this
scope by registering them as InstancePerMatchingLifetimeScope(new TypedService(typeof(T))).
</para>
</remarks>
<example>
The component D below is disposable and implements IService:
<code>
public class D : IService, IDisposable
{
// ...
}
</code>
The dependent component C can dispose of the D instance whenever required by taking a dependency on
<see cref="T:Autofac.Features.OwnedInstances.Owned`1"/>:
<code>
public class C
{
IService _service;
public C(Owned<IService> service)
{
_service = service;
}
void DoWork()
{
_service.Value.DoSomething();
}
void OnFinished()
{
_service.Dispose();
}
}
</code>
In general, rather than depending on <see cref="T:Autofac.Features.OwnedInstances.Owned`1"/> directly, components will depend on
System.Func<Owned<T>> in order to create and dispose of other components as required.
</example>
</member>
<member name="M:Autofac.Features.OwnedInstances.Owned`1.#ctor(`0,System.IDisposable)">
<summary>
Create an instance of <see cref="T:Autofac.Features.OwnedInstances.Owned`1"/>.
</summary>
<param name="value">The value representing the instance.</param>
<param name="lifetime">An IDisposable interface through which ownership can be released.</param>
</member>
<member name="M:Autofac.Features.OwnedInstances.Owned`1.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="P:Autofac.Features.OwnedInstances.Owned`1.Value">
<summary>
The owned value.
</summary>
</member>
<member name="T:Autofac.Features.OwnedInstances.OwnedInstanceRegistrationSource">
<summary>
Generates registrations for services of type <see cref="T:Autofac.Features.OwnedInstances.Owned`1"/> whenever the service
T is available.
</summary>
</member>
<member name="M:Autofac.Features.OwnedInstances.OwnedInstanceRegistrationSource.RegistrationsFor(Autofac.Core.Service,System.Func{Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.IComponentRegistration}})">
<summary>
Retrieve registrations for an unregistered service, to be used
by the container.
</summary>
<param name="service">The service that was requested.</param>
<param name="registrationAccessor">A function that will return existing registrations for a service.</param>
<returns>Registrations providing the service.</returns>
</member>
<member name="T:Autofac.IStartable">
<summary>
When implemented by a component, an instance of the component will be resolved
and started as soon as the container is built. Autofac will not call the Start()
method when subsequent instances are resolved. If this behavior is required, use
an <code>OnActivated()</code> event handler instead.
</summary>
<remarks>
For equivalent "Stop" functionality, implement <see cref="T:System.IDisposable"/>. Autofac
will always dispose a component before any of its dependencies (except in the presence
of circular dependencies, in which case the components in the cycle are disposed in
reverse-construction order.)
</remarks>
</member>
<member name="M:Autofac.IStartable.Start">
<summary>
Perform once-off startup processing.
</summary>
</member>
<member name="T:Autofac.Module">
<summary>
Base class for user-defined modules. Modules can add a set of releated components
to a container (<see cref="M:Autofac.Module.Load(Autofac.ContainerBuilder)"/>) or attach cross-cutting functionality
to other components (<see cref="M:Autofac.Module.AttachToComponentRegistration(Autofac.Core.IComponentRegistry,Autofac.Core.IComponentRegistration)"/>.
Modules are given special support in the XML configuration feature - see
http://code.google.com/p/autofac/wiki/StructuringWithModules.
</summary>
<remarks>Provides a user-friendly way to implement <see cref="T:Autofac.Core.IModule"/>
via <see cref="T:Autofac.ContainerBuilder"/>.</remarks>
<example>
Defining a module:
<code>
public class DataAccessModule : Module
{
public string ConnectionString { get; set; }
public override void Load(ContainerBuilder moduleBuilder)
{
moduleBuilder.RegisterGeneric(typeof(MyRepository<>))
.As(typeof(IRepository<>))
.InstancePerMatchingLifetimeScope(WebLifetime.Request);
moduleBuilder.Register(c => new MyDbConnection(ConnectionString))
.As<IDbConnection>()
.InstancePerMatchingLifetimeScope(WebLifetime.Request);
}
}
</code>
Using the module:
<code>
var builder = new ContainerBuilder();
builder.RegisterModule(new DataAccessModule { ConnectionString = "..." });
var container = builder.Build();
var customers = container.Resolve<IRepository<Customer>>();
</code>
</example>
</member>
<member name="M:Autofac.Module.Configure(Autofac.Core.IComponentRegistry)">
<summary>
Apply the module to the component registry.
</summary>
<param name="componentRegistry">Component registry to apply configuration to.</param>
</member>
<member name="M:Autofac.Module.Load(Autofac.ContainerBuilder)">
<summary>
Override to add registrations to the container.
</summary>
<remarks>
Note that the ContainerBuilder parameter is unique to this module.
</remarks>
<param name="builder">The builder through which components can be
registered.</param>
</member>
<member name="M:Autofac.Module.AttachToComponentRegistration(Autofac.Core.IComponentRegistry,Autofac.Core.IComponentRegistration)">
<summary>
Override to attach module-specific functionality to a
component registration.
</summary>
<remarks>This method will be called for all existing <i>and future</i> component
registrations - ordering is not important.</remarks>
<param name="componentRegistry">The component registry.</param>
<param name="registration">The registration to attach functionality to.</param>
</member>
<member name="M:Autofac.Module.AttachToRegistrationSource(Autofac.Core.IComponentRegistry,Autofac.Core.IRegistrationSource)">
<summary>
Override to perform module-specific processing on a registration source.
</summary>
<remarks>This method will be called for all existing <i>and future</i> sources
- ordering is not important.</remarks>
<param name="componentRegistry">The component registry into which the source was added.</param>
<param name="registrationSource">The registration source.</param>
</member>
<member name="P:Autofac.Module.ThisAssembly">
<summary>
The assembly in which the concrete module type is located. To avoid bugs whereby deriving from a module will
change the target assembly, this property can only be used by modules that inherit directly from
<see cref="T:Autofac.Module"/>.
</summary>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.ExternallyOwned">
<summary>
Configure the component so that instances are never disposed by the container.
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.OwnedByLifetimeScope">
<summary>
Configure the component so that instances that support IDisposable are
disposed by the container (default.)
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.InstancePerDependency">
<summary>
Configure the component so that every dependent component or call to Resolve()
gets a new, unique instance (default.)
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.SingleInstance">
<summary>
Configure the component so that every dependent component or call to Resolve()
gets the same, shared instance.
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.InstancePerLifetimeScope">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a single ILifetimeScope gets the same, shared instance. Dependent components in
different lifetime scopes will get different instances.
</summary>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.InstancePerMatchingLifetimeScope(System.Object[])">
<summary>
Configure the component so that every dependent component or call to Resolve() within
a ILifetimeScope tagged with any of the provided tags value gets the same, shared instance.
Dependent components in lifetime scopes that are children of the tagged scope will
share the parent's instance. If no appropriately tagged scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<param name="lifetimeScopeTag">Tag applied to matching lifetime scopes.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.InstancePerOwned``1">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a ILifetimeScope created by an owned instance gets the same, shared instance.
Dependent components in lifetime scopes that are children of the owned instance scope will
share the parent's instance. If no appropriate owned instance scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<typeparam name="TService">The service type provided by the component.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.InstancePerOwned(System.Type)">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a ILifetimeScope created by an owned instance gets the same, shared instance.
Dependent components in lifetime scopes that are children of the owned instance scope will
share the parent's instance. If no appropriate owned instance scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<param name="serviceType">The service type provided by the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.InstancePerOwned``1(System.Object)">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a ILifetimeScope created by an owned instance gets the same, shared instance.
Dependent components in lifetime scopes that are children of the owned instance scope will
share the parent's instance. If no appropriate owned instance scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<typeparam name="TService">The service type provided by the component.</typeparam>
<param name="serviceKey">Key to associate with the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.InstancePerOwned(System.Object,System.Type)">
<summary>
Configure the component so that every dependent component or call to Resolve()
within a ILifetimeScope created by an owned instance gets the same, shared instance.
Dependent components in lifetime scopes that are children of the owned instance scope will
share the parent's instance. If no appropriate owned instance scope can be found in the
hierarchy an <see cref="T:Autofac.Core.DependencyResolutionException"/> is thrown.
</summary>
<param name="serviceKey">Key to associate with the component.</param>
<param name="serviceType">The service type provided by the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.As``1">
<summary>
Configure the services that the component will provide. The generic parameter(s) to As()
will be exposed as TypedService instances.
</summary>
<typeparam name="TService">Service type.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.As``2">
<summary>
Configure the services that the component will provide. The generic parameter(s) to As()
will be exposed as TypedService instances.
</summary>
<typeparam name="TService1">Service type.</typeparam>
<typeparam name="TService2">Service type.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.As``3">
<summary>
Configure the services that the component will provide. The generic parameter(s) to As()
will be exposed as TypedService instances.
</summary>
<typeparam name="TService1">Service type.</typeparam>
<typeparam name="TService2">Service type.</typeparam>
<typeparam name="TService3">Service type.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.As(System.Type[])">
<summary>
Configure the services that the component will provide.
</summary>
<param name="services">Service types to expose.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.As(Autofac.Core.Service[])">
<summary>
Configure the services that the component will provide.
</summary>
<param name="services">Services to expose.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.Named(System.String,System.Type)">
<summary>
Provide a textual name that can be used to retrieve the component.
</summary>
<param name="serviceName">Named service to associate with the component.</param>
<param name="serviceType">The service type provided by the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.Named``1(System.String)">
<summary>
Provide a textual name that can be used to retrieve the component.
</summary>
<param name="serviceName">Named service to associate with the component.</param>
<typeparam name="TService">The service type provided by the component.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.Keyed(System.Object,System.Type)">
<summary>
Provide a key that can be used to retrieve the component.
</summary>
<param name="serviceKey">Key to associate with the component.</param>
<param name="serviceType">The service type provided by the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.Keyed``1(System.Object)">
<summary>
Provide a key that can be used to retrieve the component.
</summary>
<param name="serviceKey">Key to associate with the component.</param>
<typeparam name="TService">The service type provided by the component.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.OnPreparing(System.Action{Autofac.Core.PreparingEventArgs})">
<summary>
Add a handler for the Preparing event. This event allows manipulating of the parameters
that will be provided to the component.
</summary>
<param name="handler">The event handler.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.OnActivating(System.Action{Autofac.Core.IActivatingEventArgs{`0}})">
<summary>
Add a handler for the Activating event.
</summary>
<param name="handler">The event handler.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.OnActivated(System.Action{Autofac.Core.IActivatedEventArgs{`0}})">
<summary>
Add a handler for the Activated event.
</summary>
<param name="handler">The event handler.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.PropertiesAutowired(Autofac.PropertyWiringOptions)">
<summary>
Configure the component so that any properties whose types are registered in the
container will be wired to instances of the appropriate service.
</summary>
<param name="wiringFlags">Set wiring options such as circular dependency wiring support.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.WithMetadata(System.String,System.Object)">
<summary>
Associates data with the component.
</summary>
<param name="key">Key by which the data can be located.</param>
<param name="value">The data value.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.WithMetadata(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})">
<summary>
Associates data with the component.
</summary>
<param name="properties">The extended properties to associate with the component.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.Builder.RegistrationBuilder`3.WithMetadata``1(System.Action{Autofac.Builder.MetadataConfiguration{``0}})">
<summary>
Associates data with the component.
</summary>
<typeparam name="TMetadata">A type with properties whose names correspond to the
property names to configure.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="P:Autofac.Builder.RegistrationBuilder`3.ActivatorData">
<summary>
The activator data.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationBuilder`3.RegistrationStyle">
<summary>
The registration style.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationBuilder`3.RegistrationData">
<summary>
The registration data.
</summary>
</member>
<member name="T:Autofac.Builder.RegistrationData">
<summary>
Data common to all registrations made in the container, both direct (IComponentRegistration)
and dynamic (IRegistrationSource.)
</summary>
</member>
<member name="M:Autofac.Builder.RegistrationData.#ctor(Autofac.Core.Service)">
<summary>
Construct a RegistrationData instance.
</summary>
<param name="defaultService">The default service that will be used if no others
are added.</param>
</member>
<member name="M:Autofac.Builder.RegistrationData.AddServices(System.Collections.Generic.IEnumerable{Autofac.Core.Service})">
<summary>
Add multiple services for the registration, overriding the default.
</summary>
<param name="services">The services to add.</param>
<remarks>If an empty collection is specified, this will still
clear the default service.</remarks>
</member>
<member name="M:Autofac.Builder.RegistrationData.AddService(Autofac.Core.Service)">
<summary>
Add a service to the registration, overriding the default.
</summary>
<param name="service">The service to add.</param>
</member>
<member name="M:Autofac.Builder.RegistrationData.CopyFrom(Autofac.Builder.RegistrationData,System.Boolean)">
<summary>
Copies the contents of another RegistrationData object into this one.
</summary>
<param name="that">The data to copy.</param>
<param name="includeDefaultService">When true, the default service
will be changed to that of the other.</param>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="that"/> is <see langword="null"/>.
</exception>
</member>
<member name="M:Autofac.Builder.RegistrationData.ClearServices">
<summary>
Empties the configured services.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationData.Services">
<summary>
The services explicitly assigned to the component.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationData.Ownership">
<summary>
The instance ownership assigned to the component.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationData.Lifetime">
<summary>
The lifetime assigned to the component.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationData.Sharing">
<summary>
The sharing mode assigned to the component.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationData.Metadata">
<summary>
Extended properties assigned to the component.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationData.PreparingHandlers">
<summary>
Handlers for the Preparing event.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationData.ActivatingHandlers">
<summary>
Handlers for the Activating event.
</summary>
</member>
<member name="P:Autofac.Builder.RegistrationData.ActivatedHandlers">
<summary>
Handlers for the Activated event.
</summary>
</member>
<member name="T:Autofac.RegistrationExtensions">
<summary>
Adds registration syntax to the <see cref="T:Autofac.ContainerBuilder"/> type.
</summary>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterComponent(Autofac.ContainerBuilder,Autofac.Core.IComponentRegistration)">
<summary>
Add a component to the container.
</summary>
<param name="builder">The builder to register the component with.</param>
<param name="registration">The component to add.</param>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterSource(Autofac.ContainerBuilder,Autofac.Core.IRegistrationSource)">
<summary>
Add a registration source to the container.
</summary>
<param name="builder">The builder to register the registration source via.</param>
<param name="registrationSource">The registration source to add.</param>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterInstance``1(Autofac.ContainerBuilder,``0)">
<summary>
Register an instance as a component.
</summary>
<typeparam name="T">The type of the instance.</typeparam>
<param name="builder">Container builder.</param>
<param name="instance">The instance to register.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<remarks>If no services are explicitly specified for the instance, the
static type <typeparamref name="T"/> will be used as the default service (i.e. *not* <code>instance.GetType()</code>).</remarks>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterType``1(Autofac.ContainerBuilder)">
<summary>
Register a component to be created through reflection.
</summary>
<typeparam name="TImplementer">The type of the component implementation.</typeparam>
<param name="builder">Container builder.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterType(Autofac.ContainerBuilder,System.Type)">
<summary>
Register a component to be created through reflection.
</summary>
<param name="implementationType">The type of the component implementation.</param>
<param name="builder">Container builder.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Register``1(Autofac.ContainerBuilder,System.Func{Autofac.IComponentContext,``0})">
<summary>
Register a delegate as a component.
</summary>
<typeparam name="T">The type of the instance.</typeparam>
<param name="builder">Container builder.</param>
<param name="delegate">The delegate to register.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Register``1(Autofac.ContainerBuilder,System.Func{Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},``0})">
<summary>
Register a delegate as a component.
</summary>
<typeparam name="T">The type of the instance.</typeparam>
<param name="builder">Container builder.</param>
<param name="delegate">The delegate to register.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterGeneric(Autofac.ContainerBuilder,System.Type)">
<summary>
Register an un-parameterised generic type, e.g. Repository<>.
Concrete types will be made as they are requested, e.g. with Resolve<Repository<int>>().
</summary>
<param name="builder">Container builder.</param>
<param name="implementer">The open generic implementation type.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.PreserveExistingDefaults``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2})">
<summary>
Specifies that the component being registered should only be made the default for services
that have not already been registered.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TSingleRegistrationStyle">Registration style.</typeparam>
<typeparam name="TActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.PreserveExistingDefaults``2(Autofac.Builder.IRegistrationBuilder{``0,Autofac.Features.Scanning.ScanningActivatorData,``1})">
<summary>
Specifies that the components being registered should only be made the default for services
that have not already been registered.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterAssemblyTypes(Autofac.ContainerBuilder,System.Reflection.Assembly[])">
<summary>
Register the types in an assembly.
</summary>
<param name="builder">Container builder.</param>
<param name="assemblies">The assemblies from which to register types.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterTypes(Autofac.ContainerBuilder,System.Type[])">
<summary>
Register the types in a list.
</summary>
<param name="builder">Container builder.</param>
<param name="types">The types to register.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Where``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Type,System.Boolean})">
<summary>
Specifies a subset of types to register from a scanned assembly.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to filter types from.</param>
<param name="predicate">Predicate that returns true for types to register.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.As``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Type,System.Collections.Generic.IEnumerable{Autofac.Core.Service}})">
<summary>
Specifies how a type from a scanned assembly is mapped to a service.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<param name="serviceMapping">Function mapping types to services.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.As``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Type,Autofac.Core.Service})">
<summary>
Specifies how a type from a scanned assembly is mapped to a service.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<param name="serviceMapping">Function mapping types to services.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.As``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Type,System.Type})">
<summary>
Specifies how a type from a scanned assembly is mapped to a service.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<param name="serviceMapping">Function mapping types to services.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.As``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Type,System.Collections.Generic.IEnumerable{System.Type}})">
<summary>
Specifies how a type from a scanned assembly is mapped to a service.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<param name="serviceMapping">Function mapping types to services.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.AsSelf``1(Autofac.Builder.IRegistrationBuilder{``0,Autofac.Features.Scanning.ScanningActivatorData,Autofac.Builder.DynamicRegistrationStyle})">
<summary>
Specifies that a type from a scanned assembly provides its own concrete type as a service.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.AsSelf``2(Autofac.Builder.IRegistrationBuilder{``0,``1,Autofac.Builder.SingleRegistrationStyle})">
<summary>
Specifies that a type provides its own concrete type as a service.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TConcreteActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.AsSelf``1(Autofac.Builder.IRegistrationBuilder{``0,Autofac.Builder.ReflectionActivatorData,Autofac.Builder.DynamicRegistrationStyle})">
<summary>
Specifies that a type provides its own concrete type as a service.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithMetadata``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Type,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}}})">
<summary>
Specify how a type from a scanned assembly provides metadata.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set metadata on.</param>
<param name="metadataMapping">A function mapping the type to a list of metadata items.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithMetadataFrom``1(Autofac.Builder.IRegistrationBuilder{System.Object,Autofac.Features.Scanning.ScanningActivatorData,Autofac.Builder.DynamicRegistrationStyle})">
<summary>
Use the properties of an attribute (or interface implemented by an attribute) on the scanned type
to provide metadata values.
</summary>
<remarks>Inherited attributes are supported; however, there must be at most one matching attribute
in the inheritance chain.</remarks>
<typeparam name="TAttribute">The attribute applied to the scanned type.</typeparam>
<param name="registration">Registration to set metadata on.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithMetadata``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.String,System.Func{System.Type,System.Object})">
<summary>
Specify how a type from a scanned assembly provides metadata.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<param name="metadataKey">Key of the metadata item.</param>
<param name="metadataValueMapping">A function retrieving the value of the item from the component type.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Named``1(Autofac.Builder.IRegistrationBuilder{System.Object,Autofac.Features.Scanning.ScanningActivatorData,Autofac.Builder.DynamicRegistrationStyle},System.Func{System.Type,System.String})">
<summary>
Specifies how a type from a scanned assembly is mapped to a named service.
</summary>
<param name="registration">Registration to set service mapping on.</param>
<typeparam name="TService">Service type provided by the component.</typeparam>
<param name="serviceNameMapping">Function mapping types to service names.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Named``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Type,System.String},System.Type)">
<summary>
Specifies how a type from a scanned assembly is mapped to a named service.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<param name="serviceType">Service type provided by the component.</param>
<param name="serviceNameMapping">Function mapping types to service names.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Keyed``1(Autofac.Builder.IRegistrationBuilder{System.Object,Autofac.Features.Scanning.ScanningActivatorData,Autofac.Builder.DynamicRegistrationStyle},System.Func{System.Type,System.Object})">
<summary>
Specifies how a type from a scanned assembly is mapped to a keyed service.
</summary>
<param name="registration">Registration to set service mapping on.</param>
<typeparam name="TService">Service type provided by the component.</typeparam>
<param name="serviceKeyMapping">Function mapping types to service keys.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Keyed``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Type,System.Object},System.Type)">
<summary>
Specifies how a type from a scanned assembly is mapped to a keyed service.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<param name="serviceType">Service type provided by the component.</param>
<param name="serviceKeyMapping">Function mapping types to service keys.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.AsImplementedInterfaces``1(Autofac.Builder.IRegistrationBuilder{``0,Autofac.Features.Scanning.ScanningActivatorData,Autofac.Builder.DynamicRegistrationStyle})">
<summary>
Specifies that a type from a scanned assembly is registered as providing all of its
implemented interfaces.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.AsImplementedInterfaces``2(Autofac.Builder.IRegistrationBuilder{``0,``1,Autofac.Builder.SingleRegistrationStyle})">
<summary>
Specifies that a type is registered as providing all of its implemented interfaces.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TConcreteActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.AsImplementedInterfaces``1(Autofac.Builder.IRegistrationBuilder{``0,Autofac.Builder.ReflectionActivatorData,Autofac.Builder.DynamicRegistrationStyle})">
<summary>
Specifies that a type is registered as providing all of its implemented interfaces.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.FindConstructorsWith``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},Autofac.Core.Activators.Reflection.IConstructorFinder)">
<summary>
Set the policy used to find candidate constructors on the implementation type.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<param name="registration">Registration to set policy on.</param>
<param name="constructorFinder">Policy to be used when searching for constructors.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.FindConstructorsWith``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Type,System.Reflection.ConstructorInfo[]})">
<summary>
Set the policy used to find candidate constructors on the implementation type.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<param name="registration">Registration to set policy on.</param>
<param name="finder">A function that returns the constructors to select from.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.UsingConstructor``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Type[])">
<summary>
Set the policy used to select from available constructors on the implementation type.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<param name="registration">Registration to set policy on.</param>
<param name="signature">Constructor signature to match.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.UsingConstructor``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},Autofac.Core.Activators.Reflection.IConstructorSelector)">
<summary>
Set the policy used to select from available constructors on the implementation type.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set policy on.</param>
<param name="constructorSelector">Policy to be used when selecting a constructor.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.UsingConstructor``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Linq.Expressions.Expression{System.Func{``0}})">
<summary>
Set the policy used to select from available constructors on the implementation type.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<param name="registration">Registration to set policy on.</param>
<param name="constructorSelector">Expression demonstrating how the constructor is called.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithParameter``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.String,System.Object)">
<summary>
Configure an explicit value for a constructor parameter.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set parameter on.</param>
<param name="parameterName">Name of a constructor parameter on the target type.</param>
<param name="parameterValue">Value to supply to the parameter.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithParameter``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},Autofac.Core.Parameter)">
<summary>
Configure an explicit value for a constructor parameter.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set parameter on.</param>
<param name="parameter">The parameter to supply to the constructor.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithParameter``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Func{System.Reflection.ParameterInfo,Autofac.IComponentContext,System.Boolean},System.Func{System.Reflection.ParameterInfo,Autofac.IComponentContext,System.Object})">
<summary>
Configure an explicit value for a constructor parameter.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set parameter on.</param>
<param name="parameterSelector">A predicate selecting the parameter to set.</param>
<param name="valueProvider"></param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithParameters``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Configure explicit values for constructor parameters.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set parameter on.</param>
<param name="parameters">The parameters to supply to the constructor.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithProperty``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.String,System.Object)">
<summary>
Configure an explicit value for a property.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set property on.</param>
<param name="propertyName">Name of a property on the target type.</param>
<param name="propertyValue">Value to supply to the property.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithProperty``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},Autofac.Core.Parameter)">
<summary>
Configure an explicit value for a property.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set parameter on.</param>
<param name="property">The property to supply.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.WithProperties``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Configure explicit values for properties.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<typeparam name="TReflectionActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set parameter on.</param>
<param name="properties">The properties to supply.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Targeting``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},Autofac.Core.IComponentRegistration)">
<summary>
Sets the target of the registration (used for metadata generation.)
</summary>
<typeparam name="TLimit">The type of the limit.</typeparam>
<typeparam name="TActivatorData">The type of the activator data.</typeparam>
<typeparam name="TSingleRegistrationStyle">Registration style</typeparam>
<param name="registration">Registration to set target for.</param>
<param name="target">The target.</param>
<returns>
Registration builder allowing the registration to be configured.
</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="registration"/> or <paramref name="target"/> is <see langword="null"/>.
</exception>
</member>
<member name="M:Autofac.RegistrationExtensions.OnRegistered``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Action{Autofac.Core.ComponentRegisteredEventArgs})">
<summary>
Provide a handler to be called when the component is registered.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TSingleRegistrationStyle">Registration style.</typeparam>
<typeparam name="TActivatorData">Activator data type.</typeparam>
<param name="registration">Registration add handler to.</param>
<param name="handler">The handler.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.OnRegistered``2(Autofac.Builder.IRegistrationBuilder{``0,Autofac.Features.Scanning.ScanningActivatorData,``1},System.Action{Autofac.Core.ComponentRegisteredEventArgs})">
<summary>
Provide a handler to be called when the component is registred.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<param name="registration">Registration add handler to.</param>
<param name="handler">The handler.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.AsClosedTypesOf``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Type)">
<summary>
Specifies that a type from a scanned assembly is registered if it implements an interface
that closes the provided open generic interface type.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to set service mapping on.</param>
<param name="openGenericServiceType">The open generic interface or base class type for which implementations will be found.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.AssignableTo``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Type)">
<summary>
Filters the scanned types to include only those assignable to the provided
type.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to filter types from.</param>
<param name="type">The type or interface which all classes must be assignable from.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.AssignableTo``1(Autofac.Builder.IRegistrationBuilder{System.Object,Autofac.Features.Scanning.ScanningActivatorData,Autofac.Builder.DynamicRegistrationStyle})">
<summary>
Filters the scanned types to include only those assignable to the provided
type.
</summary>
<param name="registration">Registration to filter types from.</param>
<typeparam name="T">The type or interface which all classes must be assignable from.</typeparam>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Except``1(Autofac.Builder.IRegistrationBuilder{System.Object,Autofac.Features.Scanning.ScanningActivatorData,Autofac.Builder.DynamicRegistrationStyle})">
<summary>
Filters the scanned types to exclude the provided type.
</summary>
<param name="registration">Registration to filter types from.</param>
<typeparam name="T">The concrete type to exclude.</typeparam>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.Except``1(Autofac.Builder.IRegistrationBuilder{System.Object,Autofac.Features.Scanning.ScanningActivatorData,Autofac.Builder.DynamicRegistrationStyle},System.Action{Autofac.Builder.IRegistrationBuilder{``0,Autofac.Builder.ConcreteReflectionActivatorData,Autofac.Builder.SingleRegistrationStyle}})">
<summary>
Filters the scanned types to exclude the provided type, providing specific configuration for
the excluded type.
</summary>
<param name="registration">Registration to filter types from.</param>
<param name="customizedRegistration">Registration for the excepted type.</param>
<typeparam name="T">The concrete type to exclude.</typeparam>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.InNamespaceOf``1(Autofac.Builder.IRegistrationBuilder{System.Object,Autofac.Features.Scanning.ScanningActivatorData,Autofac.Builder.DynamicRegistrationStyle})">
<summary>
Filters the scanned types to include only those in the namespace of the provided type
or one of its sub-namespaces.
</summary>
<param name="registration">Registration to filter types from.</param>
<typeparam name="T">A type in the target namespace.</typeparam>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.InNamespace``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.String)">
<summary>
Filters the scanned types to include only those in the provided namespace
or one of its sub-namespaces.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<typeparam name="TScanningActivatorData">Activator data type.</typeparam>
<param name="registration">Registration to filter types from.</param>
<param name="ns">The namespace from which types will be selected.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterAdapter``2(Autofac.ContainerBuilder,System.Func{Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},``0,``1})">
<summary>
Adapt all components implementing service <typeparamref name="TFrom"/>
to provide <typeparamref name="TTo"/> using the provided <paramref name="adapter"/>
function.
</summary>
<typeparam name="TFrom">Service type to adapt from.</typeparam>
<typeparam name="TTo">Service type to adapt to. Must not be the
same as <typeparamref name="TFrom"/>.</typeparam>
<param name="builder">Container builder.</param>
<param name="adapter">Function adapting <typeparamref name="TFrom"/> to
service <typeparamref name="TTo"/>, given the context and parameters.</param>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterAdapter``2(Autofac.ContainerBuilder,System.Func{Autofac.IComponentContext,``0,``1})">
<summary>
Adapt all components implementing service <typeparamref name="TFrom"/>
to provide <typeparamref name="TTo"/> using the provided <paramref name="adapter"/>
function.
</summary>
<typeparam name="TFrom">Service type to adapt from.</typeparam>
<typeparam name="TTo">Service type to adapt to. Must not be the
same as <typeparamref name="TFrom"/>.</typeparam>
<param name="builder">Container builder.</param>
<param name="adapter">Function adapting <typeparamref name="TFrom"/> to
service <typeparamref name="TTo"/>, given the context.</param>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterAdapter``2(Autofac.ContainerBuilder,System.Func{``0,``1})">
<summary>
Adapt all components implementing service <typeparamref name="TFrom"/>
to provide <typeparamref name="TTo"/> using the provided <paramref name="adapter"/>
function.
</summary>
<typeparam name="TFrom">Service type to adapt from.</typeparam>
<typeparam name="TTo">Service type to adapt to. Must not be the
same as <typeparamref name="TFrom"/>.</typeparam>
<param name="builder">Container builder.</param>
<param name="adapter">Function adapting <typeparamref name="TFrom"/> to
service <typeparamref name="TTo"/>.</param>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterGenericDecorator(Autofac.ContainerBuilder,System.Type,System.Type,System.Object,System.Object)">
<summary>
Decorate all components implementing open generic service <paramref name="decoratedServiceType"/>.
The <paramref name="fromKey"/> and <paramref name="toKey"/> parameters must be different values.
</summary>
<param name="builder">Container builder.</param>
<param name="decoratedServiceType">Service type being decorated. Must be an open generic type.</param>
<param name="fromKey">Service key or name associated with the components being decorated.</param>
<param name="toKey">Service key or name given to the decorated components.</param>
<param name="decoratorType">The type of the decorator. Must be an open generic type, and accept a parameter
of type <paramref name="decoratedServiceType"/>, which will be set to the instance being decorated.</param>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterDecorator``1(Autofac.ContainerBuilder,System.Func{Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},``0,``0},System.Object,System.Object)">
<summary>
Decorate all components implementing service <typeparamref name="TService"/>
using the provided <paramref name="decorator"/> function.
The <paramref name="fromKey"/> and <paramref name="toKey"/> parameters must be different values.
</summary>
<typeparam name="TService">Service type being decorated.</typeparam>
<param name="builder">Container builder.</param>
<param name="decorator">Function decorating a component instance that provides
<typeparamref name="TService"/>, given the context and parameters.</param>
<param name="fromKey">Service key or name associated with the components being decorated.</param>
<param name="toKey">Service key or name given to the decorated components.</param>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterDecorator``1(Autofac.ContainerBuilder,System.Func{Autofac.IComponentContext,``0,``0},System.Object,System.Object)">
<summary>
Decorate all components implementing service <typeparamref name="TService"/>
using the provided <paramref name="decorator"/> function.
The <paramref name="fromKey"/> and <paramref name="toKey"/> parameters must be different values.
</summary>
<typeparam name="TService">Service type being decorated.</typeparam>
<param name="builder">Container builder.</param>
<param name="decorator">Function decorating a component instance that provides
<typeparamref name="TService"/>, given the context.</param>
<param name="fromKey">Service key or name associated with the components being decorated.</param>
<param name="toKey">Service key or name given to the decorated components.</param>
</member>
<member name="M:Autofac.RegistrationExtensions.RegisterDecorator``1(Autofac.ContainerBuilder,System.Func{``0,``0},System.Object,System.Object)">
<summary>
Decorate all components implementing service <typeparamref name="TService"/>
using the provided <paramref name="decorator"/> function.
The <paramref name="fromKey"/> and <paramref name="toKey"/> parameters must be different values.
</summary>
<typeparam name="TService">Service type being decorated.</typeparam>
<param name="builder">Container builder.</param>
<param name="decorator">Function decorating a component instance that provides
<typeparamref name="TService"/>.</param>
<param name="fromKey">Service key or name associated with the components being decorated.</param>
<param name="toKey">Service key or name given to the decorated components.</param>
</member>
<member name="M:Autofac.RegistrationExtensions.OnRelease``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Action{``0})">
<summary>
Run a supplied action instead of disposing instances when they're no
longer required.
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TActivatorData">Activator data type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<param name="registration">Registration to set release action for.</param>
<param name="releaseAction">An action to perform instead of disposing the instance.</param>
<returns>Registration builder allowing the registration to be configured.</returns>
<remarks>Only one release action can be configured per registration.</remarks>
</member>
<member name="M:Autofac.RegistrationExtensions.AutoActivate``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2})">
<summary>
Wraps a registration in an implicit <see cref="T:Autofac.IStartable"/> and automatically
activates the registration after the container is built.
</summary>
<param name="registration">Registration to set release action for.</param>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TActivatorData">Activator data type.</typeparam>
<typeparam name="TRegistrationStyle">Registration style.</typeparam>
<returns>A registration builder allowing further configuration of the component.</returns>
<remarks>
<para>
While you can implement an <see cref="T:Autofac.IStartable"/> to perform some logic at
container build time, sometimes you need to just activate a registered component and
that's it. This extension allows you to automatically activate a registration on
container build. No additional logic is executed and the resolved instance is not held
so container disposal will end up disposing of the instance.
</para>
<para>
Depending on how you register the lifetime of the component, you may get an exception
when you build the container - components that are scoped to specific lifetimes (like
ASP.NET components scoped to a request lifetime) will fail to resolve because the
appropriate lifetime is not available.
</para>
</remarks>
</member>
<member name="M:Autofac.RegistrationExtensions.InstancePerRequest``3(Autofac.Builder.IRegistrationBuilder{``0,``1,``2},System.Object[])">
<summary>
Share one instance of the component within the context of a single
web/HTTP/API request. Only available for integration that supports
per-request dependencies (e.g., MVC, Web API, web forms, etc.).
</summary>
<typeparam name="TLimit">Registration limit type.</typeparam>
<typeparam name="TStyle">Registration style.</typeparam>
<typeparam name="TActivatorData">Activator data type.</typeparam>
<param name="registration">The registration to configure.</param>
<param name="lifetimeScopeTags">Additional tags applied for matching lifetime scopes.</param>
<returns>A registration builder allowing further configuration of the component.</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="registration"/> is <see langword="null"/>.
</exception>
</member>
<member name="T:Autofac.RegistrationExtensionsResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.RegistrationExtensionsResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.RegistrationExtensionsResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.RegistrationExtensionsResources.InstanceRegistrationsAreSingleInstanceOnly">
<summary>
Looks up a localized string similar to The instance registration '{0}' can support SingleInstance() sharing only..
</summary>
</member>
<member name="P:Autofac.RegistrationExtensionsResources.MetadataAttributeNotFound">
<summary>
Looks up a localized string similar to A metadata attribute of type {0} was not found on {1}..
</summary>
</member>
<member name="P:Autofac.RegistrationExtensionsResources.MultipleMetadataAttributesSameType">
<summary>
Looks up a localized string similar to More than one metadata attribute of type {0} was found on {1}..
</summary>
</member>
<member name="P:Autofac.RegistrationExtensionsResources.NoMatchingConstructorExists">
<summary>
Looks up a localized string similar to No matching constructor exists on type '{0}'..
</summary>
</member>
<member name="T:Autofac.Builder.SimpleActivatorData">
<summary>
An activator builder with no parameters.
</summary>
</member>
<member name="M:Autofac.Builder.SimpleActivatorData.#ctor(Autofac.Core.IInstanceActivator)">
<summary>
Return the provided activator.
</summary>
<param name="activator">The activator to return.</param>
</member>
<member name="P:Autofac.Builder.SimpleActivatorData.Activator">
<summary>
Gets the activator.
</summary>
</member>
<member name="T:Autofac.Builder.SingleRegistrationStyle">
<summary>
Registration style for individual components.
</summary>
</member>
<member name="P:Autofac.Builder.SingleRegistrationStyle.Id">
<summary>
The id used for the registration.
</summary>
</member>
<member name="P:Autofac.Builder.SingleRegistrationStyle.RegisteredHandlers">
<summary>
Handlers to notify of the component registration event.
</summary>
</member>
<member name="P:Autofac.Builder.SingleRegistrationStyle.PreserveDefaults">
<summary>
By default, new registrations override existing registrations as defaults.
If set to true, new registrations will not change existing defaults.
</summary>
</member>
<member name="P:Autofac.Builder.SingleRegistrationStyle.Target">
<summary>
The component upon which this registration is based.
</summary>
</member>
<member name="T:Autofac.ContainerBuilder">
<summary>
Used to build an <see cref="T:Autofac.IContainer"/> from component registrations.
</summary>
<example>
<code>
var builder = new ContainerBuilder();
builder.RegisterType<Logger>()
.As<ILogger>()
.SingleInstance();
builder.Register(c => new MessageHandler(c.Resolve<ILogger>()));
var container = builder.Build();
// resolve components from container...
</code>
</example>
<remarks>Most <see cref="T:Autofac.ContainerBuilder"/> functionality is accessed
via extension methods in <see cref="T:Autofac.RegistrationExtensions"/>.</remarks>
<seealso cref="T:Autofac.IContainer"/>
<see cref="T:Autofac.RegistrationExtensions"/>
</member>
<member name="M:Autofac.ContainerBuilder.RegisterCallback(System.Action{Autofac.Core.IComponentRegistry})">
<summary>
Register a callback that will be invoked when the container is configured.
</summary>
<remarks>This is primarily for extending the builder syntax.</remarks>
<param name="configurationCallback">Callback to execute.</param>
</member>
<member name="M:Autofac.ContainerBuilder.Build(Autofac.Builder.ContainerBuildOptions)">
<summary>
Create a new container with the component registrations that have been made.
</summary>
<param name="options">Options that influence the way the container is initialised.</param>
<remarks>
Build can only be called once per <see cref="T:Autofac.ContainerBuilder"/>
- this prevents ownership issues for provided instances.
Build enables support for the relationship types that come with Autofac (e.g.
Func, Owned, Meta, Lazy, IEnumerable.) To exclude support for these types,
first create the container, then call Update() on the builder.
</remarks>
<returns>A new container with the configured component registrations.</returns>
</member>
<member name="M:Autofac.ContainerBuilder.Update(Autofac.IContainer)">
<summary>
Configure an existing container with the component registrations
that have been made.
</summary>
<remarks>
Update can only be called once per <see cref="T:Autofac.ContainerBuilder"/>
- this prevents ownership issues for provided instances.
</remarks>
<param name="container">An existing container to make the registrations in.</param>
</member>
<member name="M:Autofac.ContainerBuilder.Update(Autofac.IContainer,Autofac.Builder.ContainerBuildOptions)">
<summary>
Configure an existing container with the component registrations
that have been made and allows additional build options to be specified.
</summary>
<remarks>
Update can only be called once per <see cref="T:Autofac.ContainerBuilder"/>
- this prevents ownership issues for provided instances.
</remarks>
<param name="container">An existing container to make the registrations in.</param>
<param name="options">Options that influence the way the container is updated.</param>
</member>
<member name="M:Autofac.ContainerBuilder.Update(Autofac.Core.IComponentRegistry)">
<summary>
Configure an existing registry with the component registrations
that have been made.
</summary>
<remarks>
Update can only be called once per <see cref="T:Autofac.ContainerBuilder"/>
- this prevents ownership issues for provided instances.
</remarks>
<param name="componentRegistry">An existing registry to make the registrations in.</param>
</member>
<member name="T:Autofac.NamedParameter">
<summary>
A parameter identified by name. When applied to a reflection-based
component, <see cref="P:Autofac.NamedParameter.Name"/> will be matched against
the name of the component's constructor arguments. When applied to
a delegate-based component, the parameter can be accessed using
<see cref="M:Autofac.ParameterExtensions.Named``1(System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.String)"/>.
</summary>
<example>
Component with parameter:
<code>
public class MyComponent
{
public MyComponent(int amount) { ... }
}
</code>
Providing the parameter:
<code>
var builder = new ContainerBuilder();
builder.RegisterType<MyComponent>();
var container = builder.Build();
var myComponent = container.Resolve<MyComponent>(new NamedParameter("amount", 123));
</code>
</example>
</member>
<member name="M:Autofac.NamedParameter.#ctor(System.String,System.Object)">
<summary>
Create a <see cref="T:Autofac.NamedParameter"/> with the specified constant value.
</summary>
<param name="name">The name of the parameter.</param>
<param name="value">The parameter value.</param>
</member>
<member name="P:Autofac.NamedParameter.Name">
<summary>
The name of the parameter.
</summary>
</member>
<member name="T:Autofac.ParameterExtensions">
<summary>
Extension methods that simplify extraction of parameter values from
an <see cref="T:System.Collections.Generic.IEnumerable`1"/> where T is <see cref="T:Autofac.Core.Parameter"/>.
Each method returns the first matching parameter value, or throws an exception if
none is provided.
</summary>
<example>
At configuration time, delegate registrations can retrieve parameter values using
the methods <see cref="M:Autofac.ParameterExtensions.Named``1(System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.String)"/>, <see cref="M:Autofac.ParameterExtensions.Positional``1(System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Int32)"/> and <see cref="M:Autofac.ParameterExtensions.TypedAs``1(System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})"/>:
<code>
builder.Register((c, p) => new FtpClient(p.Named<string>("server")));
</code>
These parameters can be provided at resolution time:
<code>
container.Resolve<FtpClient>(new NamedParameter("server", "ftp.example.com"));
</code>
Alternatively, the parameters can be provided via a <i>Generated Factory</i> - http://code.google.com/p/autofac/wiki/DelegateFactories.
</example>
</member>
<member name="M:Autofac.ParameterExtensions.Named``1(System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.String)">
<summary>
Retrieve a named parameter value from a <see cref="T:Autofac.NamedParameter"/> instance.
</summary>
<typeparam name="T">The type to which the returned value will be cast.</typeparam>
<param name="parameters">The available parameters to choose from.</param>
<param name="name">The name of the parameter to select.</param>
<returns>The value of the selected parameter.</returns>
<seealso cref="T:Autofac.NamedParameter"/>
</member>
<member name="M:Autofac.ParameterExtensions.Positional``1(System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Int32)">
<summary>
Retrieve a positional parameter value from a <see cref="T:Autofac.PositionalParameter"/> instance.
</summary>
<typeparam name="T">The type to which the returned value will be cast.</typeparam>
<param name="parameters">The available parameters to choose from.</param>
<param name="position">The zero-based position of the parameter to select.</param>
<returns>The value of the selected parameter.</returns>
<remarks>The position value is the one associated with the parameter when
it was constructed, <b>not</b> its index into the <paramref name="parameters"/>
sequence.</remarks>
<seealso cref="T:Autofac.PositionalParameter"/>
</member>
<member name="M:Autofac.ParameterExtensions.TypedAs``1(System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a typed parameter value from a <see cref="T:Autofac.TypedParameter"/> instance.
</summary>
<typeparam name="T">The type to which the returned value will be cast.</typeparam>
<param name="parameters">The available parameters to choose from.</param>
<returns>The value of the selected parameter.</returns>
<seealso cref="T:Autofac.TypedParameter"/>
</member>
<member name="T:Autofac.PositionalParameter">
<summary>
A parameter that is identified according to an integer representing its
position in an argument list. When applied to a reflection-based
component, <see cref="P:Autofac.PositionalParameter.Position"/> will be matched against
the indices of the component's constructor arguments. When applied to
a delegate-based component, the parameter can be accessed using
<see cref="M:Autofac.ParameterExtensions.Positional``1(System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Int32)"/>.
</summary>
<example>
Component with parameter:
<code>
public class MyComponent
{
public MyComponent(int amount) { ... }
}
</code>
Providing the parameter:
<code>
var builder = new ContainerBuilder();
builder.RegisterType<MyComponent>();
var container = builder.Build();
var myComponent = container.Resolve<MyComponent>(new PositionalParameter(0, 123));
</code>
</example>
</member>
<member name="M:Autofac.PositionalParameter.#ctor(System.Int32,System.Object)">
<summary>
Construct a positional parameter with the specified constant value.
</summary>
<param name="position">The zero-based position of the parameter.</param>
<param name="value">The parameter value.</param>
</member>
<member name="P:Autofac.PositionalParameter.Position">
<summary>
The zero-based position of the parameter.
</summary>
</member>
<member name="T:Autofac.ResolutionExtensions">
<summary>
Adds syntactic convenience methods to the <see cref="T:Autofac.IComponentContext"/> interface.
</summary>
</member>
<member name="M:Autofac.ResolutionExtensions.InjectProperties``1(Autofac.IComponentContext,``0)">
<summary>
Set any properties on <paramref name="instance"/> that can be
resolved in the context.
</summary>
<typeparam name="TService">Type of instance. Used only to provide method chaining.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="instance">The instance to inject properties into.</param>
<returns><paramref name="instance"/>.</returns>
</member>
<member name="M:Autofac.ResolutionExtensions.InjectUnsetProperties``1(Autofac.IComponentContext,``0)">
<summary>
Set any null-valued properties on <paramref name="instance"/> that can be
resolved by the container.
</summary>
<typeparam name="TService">Type of instance. Used only to provide method chaining.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="instance">The instance to inject properties into.</param>
<returns><paramref name="instance"/>.</returns>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveNamed``1(Autofac.IComponentContext,System.String)">
<summary>
Retrieve a service from the context.
</summary>
<typeparam name="TService">The type to which the result will be cast.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceName">Name of the service.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveNamed``1(Autofac.IComponentContext,System.String,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context.
</summary>
<typeparam name="TService">The type to which the result will be cast.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceName">Name of the service.</param>
<param name="parameters">The parameters.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveNamed``1(Autofac.IComponentContext,System.String,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context.
</summary>
<typeparam name="TService">The type to which the result will be cast.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceName">Name of the service.</param>
<param name="parameters">The parameters.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveKeyed``1(Autofac.IComponentContext,System.Object)">
<summary>
Retrieve a service from the context.
</summary>
<typeparam name="TService">The type to which the result will be cast.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">Key of the service.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveKeyed``1(Autofac.IComponentContext,System.Object,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context.
</summary>
<typeparam name="TService">The type to which the result will be cast.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">Key of the service.</param>
<param name="parameters">The parameters.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveKeyed``1(Autofac.IComponentContext,System.Object,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context.
</summary>
<typeparam name="TService">The type to which the result will be cast.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">Key of the service.</param>
<param name="parameters">The parameters.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.Resolve``1(Autofac.IComponentContext)">
<summary>
Retrieve a service from the context.
</summary>
<typeparam name="TService">The service to retrieve.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<returns>The component instance that provides the service.</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.Resolve``1(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context.
</summary>
<typeparam name="TService">The type to which the result will be cast.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.Resolve``1(Autofac.IComponentContext,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context.
</summary>
<typeparam name="TService">The type to which the result will be cast.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.Resolve(Autofac.IComponentContext,System.Type)">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceType">The service type.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.Resolve(Autofac.IComponentContext,System.Type,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceType">The service type.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.Resolve(Autofac.IComponentContext,System.Type,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceType">The service type.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveNamed(Autofac.IComponentContext,System.String,System.Type)">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceName">The service name.</param>
<param name="serviceType">Type of the service.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveNamed(Autofac.IComponentContext,System.String,System.Type,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceName">The service name.</param>
<param name="serviceType">Type of the service.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveNamed(Autofac.IComponentContext,System.String,System.Type,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceName">The service name.</param>
<param name="serviceType">Type of the service.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveKeyed(Autofac.IComponentContext,System.Object,System.Type)">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">Key of the service.</param>
<param name="serviceType">Type of the service.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveKeyed(Autofac.IComponentContext,System.Object,System.Type,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">Key of the service.</param>
<param name="serviceType">Type of the service.</param>
<param name="parameters">The parameters.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveKeyed(Autofac.IComponentContext,System.Object,System.Type,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">Key of the service.</param>
<param name="serviceType">Type of the service.</param>
<param name="parameters">The parameters.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveService(Autofac.IComponentContext,Autofac.Core.Service)">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="service">The service to resolve.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveService(Autofac.IComponentContext,Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="service">The service to resolve.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveService(Autofac.IComponentContext,Autofac.Core.Service,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="service">The service to resolve.</param>
<returns>
The component instance that provides the service.
</returns>
<exception cref="T:Autofac.Core.Registration.ComponentNotRegisteredException"/>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptional``1(Autofac.IComponentContext)">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<typeparam name="TService">The service to resolve.</typeparam>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptional``1(Autofac.IComponentContext,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<typeparam name="TService">The service to resolve.</typeparam>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptional``1(Autofac.IComponentContext,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<typeparam name="TService">The service to resolve.</typeparam>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptionalNamed``1(Autofac.IComponentContext,System.String)">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceName">The name of the service.</param>
<typeparam name="TService">The service to resolve.</typeparam>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptionalNamed``1(Autofac.IComponentContext,System.String,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceName">The name of the service.</param>
<typeparam name="TService">The service to resolve.</typeparam>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptionalNamed``1(Autofac.IComponentContext,System.String,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceName">The name of the service.</param>
<typeparam name="TService">The service to resolve.</typeparam>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptionalKeyed``1(Autofac.IComponentContext,System.Object)">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">The name of the service.</param>
<typeparam name="TService">The service to resolve.</typeparam>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptionalKeyed``1(Autofac.IComponentContext,System.Object,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceKey">The name of the service.</param>
<typeparam name="TService">The service to resolve.</typeparam>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptionalKeyed``1(Autofac.IComponentContext,System.Object,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceKey">The key of the service.</param>
<typeparam name="TService">The service to resolve.</typeparam>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptional(Autofac.IComponentContext,System.Type)">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceType">The type of the service.</param>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptional(Autofac.IComponentContext,System.Type,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceType">The type of the service.</param>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptional(Autofac.IComponentContext,System.Type,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="parameters">Parameters for the service.</param>
<param name="serviceType">The type of the service.</param>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptionalService(Autofac.IComponentContext,Autofac.Core.Service)">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="service">The service.</param>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptionalService(Autofac.IComponentContext,Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="service">The service.</param>
<param name="parameters">Parameters for the service.</param>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.ResolveOptionalService(Autofac.IComponentContext,Autofac.Core.Service,Autofac.Core.Parameter[])">
<summary>
Retrieve a service from the context, or null if the service is not
registered.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="service">The service.</param>
<param name="parameters">Parameters for the service.</param>
<returns>
The component instance that provides the service, or null.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.IsRegistered``1(Autofac.IComponentContext)">
<summary>
Determine whether the specified service is available in the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<typeparam name="TService">The service to test for the registration of.</typeparam>
<returns>True if the service is registered.</returns>
</member>
<member name="M:Autofac.ResolutionExtensions.IsRegistered(Autofac.IComponentContext,System.Type)">
<summary>
Determine whether the specified service is available in the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceType">The service to test for the registration of.</param>
<returns>True if the service is registered.</returns>
</member>
<member name="M:Autofac.ResolutionExtensions.IsRegisteredWithName(Autofac.IComponentContext,System.String,System.Type)">
<summary>
Determine whether the specified service is available in the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceName">The name of the service to test for the registration of.</param>
<param name="serviceType">Type type of the service to test for the registration of.</param>
<returns>True if the service is registered.</returns>
</member>
<member name="M:Autofac.ResolutionExtensions.IsRegisteredWithName``1(Autofac.IComponentContext,System.String)">
<summary>
Determine whether the specified service is available in the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceName">The name of the service to test for the registration of.</param>
<typeparam name="TService">Type type of the service to test for the registration of.</typeparam>
<returns>True if the service is registered.</returns>
</member>
<member name="M:Autofac.ResolutionExtensions.IsRegisteredWithKey(Autofac.IComponentContext,System.Object,System.Type)">
<summary>
Determine whether the specified service is available in the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">The key of the service to test for the registration of.</param>
<param name="serviceType">Type type of the service to test for the registration of.</param>
<returns>True if the service is registered.</returns>
</member>
<member name="M:Autofac.ResolutionExtensions.IsRegisteredWithKey``1(Autofac.IComponentContext,System.Object)">
<summary>
Determine whether the specified service is available in the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">The key of the service to test for the registration of.</param>
<typeparam name="TService">Type type of the service to test for the registration of.</typeparam>
<returns>True if the service is registered.</returns>
</member>
<member name="M:Autofac.ResolutionExtensions.IsRegisteredService(Autofac.IComponentContext,Autofac.Core.Service)">
<summary>
Determine whether the specified service is available in the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="service">The service to test for the registration of.</param>
<returns>True if the service is registered.</returns>
</member>
<member name="M:Autofac.ResolutionExtensions.TryResolveService(Autofac.IComponentContext,Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.Parameter},System.Object@)">
<summary>
Try to retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="service">The service to resolve.</param>
<param name="instance">The resulting component instance providing the service, or null.</param>
<param name="parameters">The parameters.</param>
<returns>
True if a component providing the service is available.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="context"/> is <see langword="null"/>.
</exception>
</member>
<member name="M:Autofac.ResolutionExtensions.TryResolveService(Autofac.IComponentContext,Autofac.Core.Service,System.Object@)">
<summary>
Try to retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="service">The service to resolve.</param>
<param name="instance">The resulting component instance providing the service, or null.</param>
<returns>
True if a component providing the service is available.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.TryResolve(Autofac.IComponentContext,System.Type,System.Object@)">
<summary>
Try to retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceType">The service type to resolve.</param>
<param name="instance">The resulting component instance providing the service, or null.</param>
<returns>
True if a component providing the service is available.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.TryResolve``1(Autofac.IComponentContext,``0@)">
<summary>
Try to retrieve a service from the context.
</summary>
<typeparam name="T">The service type to resolve.</typeparam>
<param name="context">The context from which to resolve the service.</param>
<param name="instance">The resulting component instance providing the service, or default(T).</param>
<returns>
True if a component providing the service is available.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.TryResolveNamed(Autofac.IComponentContext,System.String,System.Type,System.Object@)">
<summary>
Try to retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceName">The name of the service to resolve.</param>
<param name="serviceType">The type of the service to resolve.</param>
<param name="instance">The resulting component instance providing the service, or null.</param>
<returns>
True if a component providing the service is available.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="M:Autofac.ResolutionExtensions.TryResolveKeyed(Autofac.IComponentContext,System.Object,System.Type,System.Object@)">
<summary>
Try to retrieve a service from the context.
</summary>
<param name="context">The context from which to resolve the service.</param>
<param name="serviceKey">The key of the service to resolve.</param>
<param name="serviceType">The type of the service to resolve.</param>
<param name="instance">The resulting component instance providing the service, or null.</param>
<returns>
True if a component providing the service is available.
</returns>
<exception cref="T:Autofac.Core.DependencyResolutionException"/>
</member>
<member name="T:Autofac.Core.ResolvedParameter">
<summary>
Flexible parameter type allows arbitrary values to be retrieved
from the resolution context.
</summary>
</member>
<member name="M:Autofac.Core.ResolvedParameter.#ctor(System.Func{System.Reflection.ParameterInfo,Autofac.IComponentContext,System.Boolean},System.Func{System.Reflection.ParameterInfo,Autofac.IComponentContext,System.Object})">
<summary>
Create an instance of the ResolvedParameter class.
</summary>
<param name="predicate">A predicate that determines which parameters on a constructor will be supplied by this instance.</param>
<param name="valueAccessor">A function that supplies the parameter value given the context.</param>
</member>
<member name="M:Autofac.Core.ResolvedParameter.CanSupplyValue(System.Reflection.ParameterInfo,Autofac.IComponentContext,System.Func{System.Object}@)">
<summary>
Returns true if the parameter is able to provide a value to a particular site.
</summary>
<param name="pi">Constructor, method, or property-mutator parameter.</param>
<param name="context">The component context in which the value is being provided.</param>
<param name="valueProvider">If the result is true, the valueProvider parameter will
be set to a function that will lazily retrieve the parameter value. If the result is false,
will be set to null.</param>
<returns>True if a value can be supplied; otherwise, false.</returns>
</member>
<member name="M:Autofac.Core.ResolvedParameter.ForNamed``1(System.String)">
<summary>
Construct a <see cref="T:Autofac.Core.ResolvedParameter"/> that will match parameters of type
<typeparamref name="TService"/> and resolve for those parameters an implementation
registered with the name <paramref name="serviceName"/>.
</summary>
<typeparam name="TService">The type of the parameter to match.</typeparam>
<param name="serviceName">The name of the matching service to resolve.</param>
<returns>A configured <see cref="T:Autofac.Core.ResolvedParameter"/> instance.</returns>
<remarks>
</remarks>
</member>
<member name="M:Autofac.Core.ResolvedParameter.ForKeyed``1(System.Object)">
<summary>
Construct a <see cref="T:Autofac.Core.ResolvedParameter"/> that will match parameters of type
<typeparamref name="TService"/> and resolve for those parameters an implementation
registered with the key <paramref name="serviceKey"/>.
</summary>
<typeparam name="TService">The type of the parameter to match.</typeparam>
<param name="serviceKey">The key of the matching service to resolve.</param>
<returns>A configured <see cref="T:Autofac.Core.ResolvedParameter"/> instance.</returns>
</member>
<member name="T:Autofac.TypedParameter">
<summary>
A parameter that can supply values to sites that exactly
match a specified type. When applied to a reflection-based
component, <see cref="P:Autofac.TypedParameter.Type"/> will be matched against
the types of the component's constructor arguments. When applied to
a delegate-based component, the parameter can be accessed using
<see cref="M:Autofac.ParameterExtensions.TypedAs``1(System.Collections.Generic.IEnumerable{Autofac.Core.Parameter})"/>.
</summary>
<example>
Component with parameter:
<code>
public class MyComponent
{
public MyComponent(int amount) { ... }
}
</code>
Providing the parameter:
<code>
var builder = new ContainerBuilder();
builder.RegisterType<MyComponent>();
var container = builder.Build();
var myComponent = container.Resolve<MyComponent>(new TypedParameter(typeof(int), 123));
</code>
</example>
</member>
<member name="M:Autofac.TypedParameter.#ctor(System.Type,System.Object)">
<summary>
Create a typed parameter with the specified constant value.
</summary>
<param name="type">The exact type to match.</param>
<param name="value">The parameter value.</param>
</member>
<member name="M:Autofac.TypedParameter.From``1(``0)">
<summary>
Shortcut for creating <see cref="T:Autofac.TypedParameter"/>
by using the <typeparamref name="T"/>
</summary>
<typeparam name="T">type to be used for the parameter</typeparam>
<param name="value">The parameter value.</param>
<returns>new typed parameter</returns>
</member>
<member name="P:Autofac.TypedParameter.Type">
<summary>
The type against which targets are matched.
</summary>
</member>
<member name="T:Autofac.TypeExtensions">
<summary>
Extends <see cref="T:System.Type"/> with methods that are useful in
building scanning rules for <see cref="M:Autofac.RegistrationExtensions.RegisterAssemblyTypes(Autofac.ContainerBuilder,System.Reflection.Assembly[])"/>.
</summary>
</member>
<member name="M:Autofac.TypeExtensions.IsInNamespace(System.Type,System.String)">
<summary>
Returns true if this type is in the <paramref name="namespace"/> namespace
or one of its sub-namespaces.
</summary>
<param name="this">The type to test.</param>
<param name="namespace">The namespace to test.</param>
<returns>True if this type is in the <paramref name="namespace"/> namespace
or one of its sub-namespaces; otherwise, false.</returns>
</member>
<member name="M:Autofac.TypeExtensions.IsInNamespaceOf``1(System.Type)">
<summary>
Returns true if this type is in the same namespace as <typeparamref name="T"/>
or one of its sub-namespaces.
</summary>
<param name="this">The type to test.</param>
<returns>True if this type is in the same namespace as <typeparamref name="T"/>
or one of its sub-namespaces; otherwise, false.</returns>
</member>
<member name="M:Autofac.TypeExtensions.IsClosedTypeOf(System.Type,System.Type)">
<summary>Determines whether the candidate type supports any base or
interface that closes the provided generic type.</summary>
<param name="this"></param>
<param name="openGeneric"></param>
<returns></returns>
</member>
<member name="M:Autofac.TypeExtensions.IsAssignableTo``1(System.Type)">
<summary>
Determines whether this type is assignable to <typeparamref name="T"/>.
</summary>
<typeparam name="T">The type to test assignability to.</typeparam>
<returns>True if this type is assignable to references of type
<typeparamref name="T"/>; otherwise, False.</returns>
</member>
<member name="T:Autofac.TypeExtensionsResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.TypeExtensionsResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.TypeExtensionsResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.TypeExtensionsResources.NotOpenGenericType">
<summary>
Looks up a localized string similar to The type '{0}' is not an open generic class or interface type..
</summary>
</member>
<member name="T:Autofac.Util.AssemblyExtensions">
<summary>
Extension methods for <see cref="T:System.Reflection.Assembly"/>.
</summary>
</member>
<member name="M:Autofac.Util.AssemblyExtensions.GetLoadableTypes(System.Reflection.Assembly)">
<summary>
Safely returns the set of loadable types from an assembly.
</summary>
<param name="assembly">The <see cref="T:System.Reflection.Assembly"/> from which to load types.</param>
<returns>
The set of types from the <paramref name="assembly"/>, or the subset
of types that could be loaded if there was any error.
</returns>
<exception cref="T:System.ArgumentNullException">
Thrown if <paramref name="assembly"/> is <see langword="null"/>.
</exception>
</member>
<member name="T:Autofac.Util.Enforce">
<summary>
Helper methods used throughout the codebase.
</summary>
</member>
<member name="M:Autofac.Util.Enforce.ArgumentNotNull``1(``0,System.String)">
<summary>
Enforce that an argument is not null. Returns the
value if valid so that it can be used inline in
base initialiser syntax.
</summary>
<typeparam name="T"></typeparam>
<param name="value"></param>
<param name="name"></param>
<returns><paramref name="value"/></returns>
</member>
<member name="M:Autofac.Util.Enforce.ArgumentElementNotNull``1(``0,System.String)">
<summary>
Enforce that sequence does not contain null. Returns the
value if valid so that it can be used inline in
base initialiser syntax.
</summary>
<typeparam name="T"></typeparam>
<param name="value">The value.</param>
<param name="name">The name.</param>
<returns><paramref name="value"/></returns>
</member>
<member name="M:Autofac.Util.Enforce.NotNull``1(``0)">
<summary>
Enforces that the provided object is non-null.
</summary>
<typeparam name="T"></typeparam>
<param name="value">The value.</param>
<returns><paramref name="value"/></returns>
</member>
<member name="M:Autofac.Util.Enforce.ArgumentNotNullOrEmpty(System.String,System.String)">
<summary>
Enforce that an argument is not null or empty. Returns the
value if valid so that it can be used inline in
base initialiser syntax.
</summary>
<param name="value">The value.</param>
<param name="description">The description.</param>
<returns><paramref name="value"/></returns>
</member>
<member name="M:Autofac.Util.Enforce.ArgumentTypeIsFunction(System.Type)">
<summary>
Enforce that the argument is a delegate type.
</summary>
<param name="delegateType">The type to test.</param>
</member>
<member name="T:Autofac.Util.EnforceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Util.EnforceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Util.EnforceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Util.EnforceResources.CannotBeEmpty">
<summary>
Looks up a localized string similar to The argument '{0}' cannot be empty..
</summary>
</member>
<member name="P:Autofac.Util.EnforceResources.CannotBeNull">
<summary>
Looks up a localized string similar to The object of type '{0}' cannot be null..
</summary>
</member>
<member name="P:Autofac.Util.EnforceResources.DelegateReturnsVoid">
<summary>
Looks up a localized string similar to Type {0} returns void..
</summary>
</member>
<member name="P:Autofac.Util.EnforceResources.ElementCannotBeNull">
<summary>
Looks up a localized string similar to The sequence provided as argument '{0}' cannot contain null elements..
</summary>
</member>
<member name="P:Autofac.Util.EnforceResources.NotDelegate">
<summary>
Looks up a localized string similar to Type {0} is not a delegate type..
</summary>
</member>
<member name="T:Autofac.Util.ReflectionExtensions">
<summary>
Extension methods for reflection-related types.
</summary>
</member>
<member name="M:Autofac.Util.ReflectionExtensions.TryGetDeclaringProperty(System.Reflection.ParameterInfo,System.Reflection.PropertyInfo@)">
<summary>
Maps from a property-set-value parameter to the declaring property.
</summary>
<param name="pi">Parameter to the property setter.</param>
<param name="prop">The property info on which the setter is specified.</param>
<returns>True if the parameter is a property setter.</returns>
</member>
<member name="M:Autofac.Util.ReflectionExtensions.GetProperty``2(System.Linq.Expressions.Expression{System.Func{``0,``1}})">
<summary>
Get a PropertyInfo object from an expression of the form
x => x.P.
</summary>
<typeparam name="TDeclaring">Type declaring the property.</typeparam>
<typeparam name="TProperty">The type of the property.</typeparam>
<param name="propertyAccessor">Expression mapping an instance of the
declaring type to the property value.</param>
<returns>Property info.</returns>
</member>
<member name="M:Autofac.Util.ReflectionExtensions.GetMethod``1(System.Linq.Expressions.Expression{System.Action{``0}})">
<summary>
Get the MethodInfo for a method called in the
expression.
</summary>
<typeparam name="TDeclaring">Type on which the method is called.</typeparam>
<param name="methodCallExpression">Expression demonstrating how the method appears.</param>
<returns>The method info for the called method.</returns>
</member>
<member name="M:Autofac.Util.ReflectionExtensions.GetConstructor``1(System.Linq.Expressions.Expression{System.Func{``0}})">
<summary>
Gets the <see cref="T:System.Reflection.ConstructorInfo"/> for the new operation called in the expression.
</summary>
<typeparam name="TDeclaring">The type on which the constructor is called.</typeparam>
<param name="constructorCallExpression">Expression demonstrating how the constructor is called.</param>
<returns>The <see cref="T:System.Reflection.ConstructorInfo"/> for the called constructor.</returns>
</member>
<member name="M:Autofac.Util.ReflectionExtensions.GetCustomAttribute``1(System.Reflection.MemberInfo,System.Boolean)">
<summary>
Retrieves a custom attribute of a specified type that is applied to a specified member,
and optionally inspects the ancestors of that member.
</summary>
<typeparam name="T">The type of attribute to search for.</typeparam>
<param name="element">The member to inspect.</param>
<param name="inherit"><c>true</c> to inspect the ancestors of element; otherwise, <c>false</c>.</param>
<returns>A custom attribute that matches <typeparamref name="T"/>, or <c>null</c> if no such attribute is found.</returns>
</member>
<member name="T:Autofac.Util.ReflectionExtensionsResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Util.ReflectionExtensionsResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Util.ReflectionExtensionsResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Util.ReflectionExtensionsResources.ExpressionNotConstructorCall">
<summary>
Looks up a localized string similar to The provided expression must be of the form () =>new X(), but the provided expression was {0}..
</summary>
</member>
<member name="P:Autofac.Util.ReflectionExtensionsResources.ExpressionNotMethodCall">
<summary>
Looks up a localized string similar to The provided expression must be of the form x =>x.M(), but the provided expression was {0}..
</summary>
</member>
<member name="P:Autofac.Util.ReflectionExtensionsResources.ExpressionNotPropertyAccessor">
<summary>
Looks up a localized string similar to The provided expression must be of the form x =>x.P, but the provided expression was {0}..
</summary>
</member>
<member name="T:Autofac.Util.ReleaseAction">
<summary>
Adapts an action to the <see cref="T:System.IDisposable"/> interface.
</summary>
</member>
<member name="M:Autofac.Util.SequenceExtensions.JoinWith(System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Joins the strings into one single string interspersing the elements with the separator (a-la
System.String.Join()).
</summary>
<param name="elements">The elements.</param>
<param name="separator">The separator.</param>
<returns>The joined string.</returns>
</member>
<member name="M:Autofac.Util.SequenceExtensions.Append``1(System.Collections.Generic.IEnumerable{``0},``0)">
<summary>
Appends the item to the specified sequence.
</summary>
<typeparam name="T"></typeparam>
<param name="sequence">The sequence.</param>
<param name="trailingItem">The trailing item.</param>
<returns></returns>
</member>
<member name="M:Autofac.Util.SequenceExtensions.Prepend``1(System.Collections.Generic.IEnumerable{``0},``0)">
<summary>
Prepends the item to the specified sequence.
</summary>
<typeparam name="T"></typeparam>
<param name="sequence">The sequence.</param>
<param name="leadingItem">The leading item.</param>
<returns></returns>
</member>
<member name="M:Autofac.Util.TypeExtensions.GetTypesThatClose(System.Type,System.Type)">
<summary>Returns the first concrete interface supported by the candidate type that
closes the provided open generic service type.</summary>
<param name="this">The type that is being checked for the interface.</param>
<param name="openGeneric">The open generic type to locate.</param>
<returns>The type of the interface.</returns>
</member>
<member name="M:Autofac.Util.TypeExtensions.FindAssignableTypesThatClose(System.Type,System.Type)">
<summary>
Looks for an interface on the candidate type that closes the provided open generic interface type.
</summary>
<param name="candidateType">The type that is being checked for the interface.</param>
<param name="openGenericServiceType">The open generic service type to locate.</param>
<returns>True if a closed implementation was found; otherwise false.</returns>
</member>
<member name="M:Autofac.Features.GeneratedFactories.GeneratedFactoryRegistrationSource.RegistrationsFor(Autofac.Core.Service,System.Func{Autofac.Core.Service,System.Collections.Generic.IEnumerable{Autofac.Core.IComponentRegistration}})">
<summary>
Retrieve registrations for an unregistered service, to be used
by the container.
</summary>
<param name="service">The service that was requested.</param>
<param name="registrationAccessor">A function that will return existing registrations for a service.</param>
<returns>Registrations providing the service.</returns>
</member>
<member name="T:Autofac.Util.ValidatedNotNullAttribute">
<summary>
Signal attribute for static analysis that indicates a helper method is
validating arguments for <see langword="null" />.
</summary>
</member>
<member name="T:Autofac.Features.GeneratedFactories.GeneratedFactoryRegistrationSourceResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Autofac.Features.GeneratedFactories.GeneratedFactoryRegistrationSourceResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Autofac.Features.GeneratedFactories.GeneratedFactoryRegistrationSourceResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Autofac.Features.GeneratedFactories.GeneratedFactoryRegistrationSourceResources.DuplicateTypesInTypeMappedFuncParameterList">
<summary>
Looks up a localized string similar to Unable to generate a function to return type '{0}' with input parameter types [{1}]. The input parameter type list has duplicate types. Try registering a custom delegate type instead of using a generic Func relationship..
</summary>
</member>
<member name="P:Autofac.Features.GeneratedFactories.GeneratedFactoryRegistrationSourceResources.GeneratedFactoryRegistrationSourceDescription">
<summary>
Looks up a localized string similar to Delegate Support (Func<T>and Custom Delegates).
</summary>
</member>
</members>
</doc>
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="FakeItEasy" publicKeyToken="eff28e2146d5fd2c" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-1.25.1.0" newVersion="1.25.1.0" />
</dependentAssembly>
</assemblyBinding>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="Autofac" publicKeyToken="17863af14b0044da" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-3.5.0.0" newVersion="3.5.0.0" />
</dependentAssembly>
</assemblyBinding>
</runtime>
</configuration>
#%command.name%
%command.help%
# Welcome to the Crane documentation
## Commands
%crane.listcommands%
This folder contains templates that are used to generate the crane documentation at build time. The built documentation ends up in /doc
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.1" />
</startup>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="Autofac" publicKeyToken="17863af14b0044da" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-3.5.0.0" newVersion="3.5.0.0" />
</dependentAssembly>
</assemblyBinding>
</runtime>
</configuration>
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
</configSections>
<log4net>
<appender name="RollingFile" type="log4net.Appender.RollingFileAppender">
<file value="Logs\Crane.Integration.Tests.log"/>
<appendToFile value="true"/>
<maximumFileSize value="10MB"/>
<maxSizeRollBackups value="20"/>
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%d %-5p %t %c - %m%n"/>
</layout>
</appender>
<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
<layout type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%d{HH:mm:ss} [%t] %-5p %c{1} - %m%n"/>
</layout>
</appender>
<appender name="ColoredConsoleAppender" type="log4net.Appender.ColoredConsoleAppender">
<target value="Console.Error" />
<mapping>
<level value="FATAL" />
<foreColor value="Red" />
<backColor value="White" />
</mapping>
<mapping>
<level value="ERROR" />
<foreColor value="Red, HighIntensity" />
</mapping>
<mapping>
<level value="WARN" />
<foreColor value="Yellow" />
</mapping>
<mapping>
<level value="INFO" />
<foreColor value="Cyan" />
</mapping>
<mapping>
<level value="DEBUG" />
<foreColor value="Green" />
</mapping>
<layout type="log4net.Layout.SimpleLayout" />
</appender>
<!-- Used by dbgview -->
<appender name="DebugString" type="log4net.Appender.OutputDebugStringAppender">
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%p %t %c - %m%n"/>
</layout>
</appender>
<!-- Used by standard tracing framework in .Net. N.B makes statements appear in resharper test runner session window -->
<appender name="NetTraceAppender" type="log4net.Appender.TraceAppender, log4net">
<layout type="log4net.Layout.PatternLayout,log4net">
<param name="ConversionPattern" value="%d [%t] %-5p - %m%n" />
</layout>
</appender>
<root>
<level value="INFO"/>
<appender-ref ref="RollingFile"/>
<appender-ref ref="NetTraceAppender"/>
<appender-ref ref="ColoredConsoleAppender"/>
</root>
</log4net>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="Autofac" publicKeyToken="17863af14b0044da" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-3.5.0.0" newVersion="3.5.0.0" />
</dependentAssembly>
</assemblyBinding>
</runtime>
</configuration>
<?xml version="1.0"?>
<doc>
<assembly>
<name>FakeItEasy</name>
</assembly>
<members>
<member name="T:FakeItEasy.A">
<summary>
Provides methods for generating fake objects.
</summary>
</member>
<member name="M:FakeItEasy.A.Fake``1">
<summary>
Creates a fake object of the type T.
</summary>
<typeparam name="T">The type of fake object to create.</typeparam>
<returns>A fake object.</returns>
</member>
<member name="M:FakeItEasy.A.Fake``1(System.Action{FakeItEasy.Creation.IFakeOptionsBuilder{``0}})">
<summary>
Creates a fake object of the type T.
</summary>
<typeparam name="T">The type of fake object to create.</typeparam>
<param name="options">A lambda where options for the built fake object can be specified.</param>
<returns>A fake object.</returns>
</member>
<member name="M:FakeItEasy.A.CollectionOfFake``1(System.Int32)">
<summary>
Creates a collection of fakes of the specified type.
</summary>
<typeparam name="T">The type of fakes to create.</typeparam>
<param name="numberOfFakes">The number of fakes in the collection.</param>
<returns>A collection of fake objects of the specified type.</returns>
</member>
<member name="M:FakeItEasy.A.Dummy``1">
<summary>
Gets a dummy object of the specified type. The value of a dummy object
should be irrelevant. Dummy objects should not be configured.
</summary>
<typeparam name="T">The type of dummy to return.</typeparam>
<returns>A dummy object of the specified type.</returns>
<exception cref="T:System.ArgumentException">Dummies of the specified type can not be created.</exception>
</member>
<member name="M:FakeItEasy.A.Equals(System.Object,System.Object)">
<summary>
Gets a value indicating whether the two objects are equal.
</summary>
<param name="objA">The first object to compare.</param>
<param name="objB">The second object to compare.</param>
<returns>True if the two objects are equal.</returns>
</member>
<member name="M:FakeItEasy.A.ReferenceEquals(System.Object,System.Object)">
<summary>
Gets a value indicating whether the two objects are the same reference.
</summary>
<param name="objA">The object A.</param>
<param name="objB">The object B.</param>
<returns>True if the objects are the same reference.</returns>
</member>
<member name="M:FakeItEasy.A.CallTo(System.Linq.Expressions.Expression{System.Action})">
<summary>
Configures a call to a faked object.
</summary>
<param name="callSpecification">An expression where the configured member is called.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.A.CallTo(System.Object)">
<summary>
Gets a configuration object allowing for further configuration of
any call to the specified faked object.
</summary>
<param name="fake">
The fake to configure.
</param>
<returns>
A configuration object.
</returns>
</member>
<member name="M:FakeItEasy.A.CallTo``1(System.Linq.Expressions.Expression{System.Func{``0}})">
<summary>
Configures a call to a faked object.
</summary>
<typeparam name="T">The type of member on the faked object to configure.</typeparam>
<param name="callSpecification">An expression where the configured member is called.</param>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.Any">
<summary>
Provides configuration for any (not a specific) call on a faked object.
</summary>
</member>
<member name="M:FakeItEasy.Any.CallTo(System.Object)">
<summary>
Gets a configuration object allowing for further configuration of
any call to the specified faked object.
</summary>
<param name="fakedObject">The faked object to configure.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.Any.Equals(System.Object,System.Object)">
<summary>
Gets a value indicating whether the two objects are equal.
</summary>
<param name="objA">The first object to compare.</param>
<param name="objB">The second object to compare.</param>
<returns>True if the two objects are equal.</returns>
</member>
<member name="M:FakeItEasy.Any.ReferenceEquals(System.Object,System.Object)">
<summary>
Gets a value indicating whether the two objects are the same reference.
</summary>
<param name="objA">The object A.</param>
<param name="objB">The object B.</param>
<returns>True if the objects are the same reference.</returns>
</member>
<member name="T:FakeItEasy.ArgumentValueFormatter`1">
<summary>
Provides string formatting for arguments of type T when written in call lists.
</summary>
<typeparam name="T">The type of the arguments which will be formatted by this instance.</typeparam>
</member>
<member name="T:FakeItEasy.IArgumentValueFormatter">
<summary>
Provides string formatting for arguments when written in
call lists.
</summary>
</member>
<member name="M:FakeItEasy.IArgumentValueFormatter.GetArgumentValueAsString(System.Object)">
<summary>
Gets a string representing the specified argument value.
</summary>
<param name="argumentValue">The argument value to get as a string.</param>
<returns>A string representation of the value.</returns>
</member>
<member name="P:FakeItEasy.IArgumentValueFormatter.ForType">
<summary>
Gets the type of arguments this formatter works on.
</summary>
</member>
<member name="P:FakeItEasy.IArgumentValueFormatter.Priority">
<summary>
Gets the priority of the formatter, when two formatters are
registered for the same type the one with the highest
priority is used.
</summary>
</member>
<member name="M:FakeItEasy.ArgumentValueFormatter`1.GetArgumentValueAsString(System.Object)">
<summary>
Gets a string representing the specified argument value.
</summary>
<param name="argumentValue">The argument value to get as a string.</param>
<returns>A string representation of the value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentValueFormatter`1.GetStringValue(`0)">
<summary>
Gets a string representing the specified argument value.
</summary>
<param name="argumentValue">The argument value to get as a string.</param>
<returns>A string representation of the value.</returns>
</member>
<member name="P:FakeItEasy.ArgumentValueFormatter`1.ForType">
<summary>
Gets the type of arguments this formatter works on.
</summary>
</member>
<member name="P:FakeItEasy.ArgumentValueFormatter`1.Priority">
<summary>
Gets the priority of the formatter, when two formatters are
registered for the same type the one with the highest
priority is used.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.BuildableCallRule">
<summary>
Provides the base for rules that can be built using the FakeConfiguration.
</summary>
</member>
<member name="T:FakeItEasy.Core.IFakeObjectCallRuleWithDescription">
<summary>
Represents a call rule that has a description of the calls the
rule is applicable to.
</summary>
</member>
<member name="T:FakeItEasy.Core.IFakeObjectCallRule">
<summary>
Allows for intercepting call to a fake object and
act upon them.
</summary>
</member>
<member name="M:FakeItEasy.Core.IFakeObjectCallRule.IsApplicableTo(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Gets whether this interceptor is applicable to the specified
call, if true is returned the Apply-method of the interceptor will
be called.
</summary>
<param name="fakeObjectCall">The call to check for applicability.</param>
<returns>True if the interceptor is applicable.</returns>
</member>
<member name="M:FakeItEasy.Core.IFakeObjectCallRule.Apply(FakeItEasy.Core.IInterceptedFakeObjectCall)">
<summary>
Applies an action to the call, might set a return value or throw
an exception.
</summary>
<param name="fakeObjectCall">The call to apply the interceptor to.</param>
</member>
<member name="P:FakeItEasy.Core.IFakeObjectCallRule.NumberOfTimesToCall">
<summary>
Gets the number of times this call rule is valid, if it's set
to null its infinitely valid.
</summary>
</member>
<member name="M:FakeItEasy.Core.IFakeObjectCallRuleWithDescription.WriteDescriptionOfValidCall(FakeItEasy.IOutputWriter)">
<summary>
Writes a description of calls the rule is applicable to.
</summary>
<param name="writer">The writer.</param>
</member>
<member name="M:FakeItEasy.Configuration.BuildableCallRule.IsApplicableTo(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Gets if this rule is applicable to the specified call.
</summary>
<param name="fakeObjectCall">The call to validate.</param>
<returns>True if the rule applies to the call.</returns>
</member>
<member name="M:FakeItEasy.Configuration.BuildableCallRule.WriteDescriptionOfValidCall(FakeItEasy.IOutputWriter)">
<summary>
Writes a description of calls the rule is applicable to.
</summary>
<param name="writer">The writer to write the description to.</param>
</member>
<member name="P:FakeItEasy.Configuration.BuildableCallRule.Applicator">
<summary>
Gets or sets an action that is called by the Apply method to apply this
rule to a fake object call.
</summary>
</member>
<member name="P:FakeItEasy.Configuration.BuildableCallRule.Actions">
<summary>
Gets a collection of actions that should be invoked when the configured
call is made.
</summary>
</member>
<member name="P:FakeItEasy.Configuration.BuildableCallRule.OutAndRefParametersValueProducer">
<summary>
Gets or sets a function that provides values to apply to output and reference variables.
</summary>
</member>
<member name="P:FakeItEasy.Configuration.BuildableCallRule.CallBaseMethod">
<summary>
Gets or sets a value indicating whether the base method of the fake object call should be
called when the fake object call is made.
</summary>
</member>
<member name="P:FakeItEasy.Configuration.BuildableCallRule.NumberOfTimesToCall">
<summary>
Gets or sets the number of times the configured rule should be used.
</summary>
</member>
<member name="P:FakeItEasy.Configuration.BuildableCallRule.DescriptionOfValidCall">
<summary>
Gets a description of calls the rule is applicable to.
</summary>
<value></value>
</member>
<member name="T:FakeItEasy.Configuration.IAnyCallConfigurationWithReturnTypeSpecified`1">
<summary>
Aggregate of IReturnValueArgumentValidationConfiguration<T> and IWhereConfiguration<IAnyCallConfigurationWithReturnTypeSpecified<T>>.
</summary>
<typeparam name="T">The type of fake object that is configured.</typeparam>
</member>
<member name="T:FakeItEasy.Configuration.IReturnValueArgumentValidationConfiguration`1">
<summary>
Configures a call that returns a value and allows the use to
specify validations for arguments.
</summary>
<typeparam name="TMember">The type of the member.</typeparam>
</member>
<member name="T:FakeItEasy.Configuration.IReturnValueConfiguration`1">
<summary>
Configures a call that returns a value.
</summary>
<typeparam name="TMember">The type of the member.</typeparam>
</member>
<member name="T:FakeItEasy.Configuration.IExceptionThrowerConfiguration">
<summary>
Configuration that lets the developer specify that an exception should be
thrown by a fake object call.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.IHideObjectMembers">
<summary>
Hides standard Object members to make fluent interfaces
easier to read. Found in the source of Autofac: <see cref="!:http://code.google.com/p/autofac/"/>
Based on blog post here:
<see cref="!:http://www.clariusconsulting.net/blogs/kzu/archive/2008/03/10/58301.aspx"/>
</summary>
</member>
<member name="M:FakeItEasy.Configuration.IHideObjectMembers.ToString">
<summary>
Hides the ToString-method.
</summary>
<returns>A string representation of the implementing object.</returns>
</member>
<member name="M:FakeItEasy.Configuration.IHideObjectMembers.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
</summary>
<param name="o">The <see cref="T:System.Object"/> to compare with this instance.</param>
<returns>
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FakeItEasy.Configuration.IHideObjectMembers.GetHashCode">
<summary>
Returns a hash code for this instance.
</summary>
<returns>
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
</returns>
</member>
<member name="M:FakeItEasy.Configuration.IHideObjectMembers.GetType">
<summary>
Gets the type.
</summary>
<returns>The exact runtime type of the current instance.</returns>
</member>
<member name="M:FakeItEasy.Configuration.IExceptionThrowerConfiguration.Throws(System.Func{FakeItEasy.Core.IFakeObjectCall,System.Exception})">
<summary>
Throws the specified exception when the currently configured
call gets called.
</summary>
<param name="exceptionFactory">A function that creates the exception to throw.</param>
<returns>Configuration object.</returns>
</member>
<member name="T:FakeItEasy.Configuration.ICallbackConfiguration`1">
<summary>
Configuration for callbacks of fake object calls.
</summary>
<typeparam name="TInterface">The type of interface to return.</typeparam>
</member>
<member name="M:FakeItEasy.Configuration.ICallbackConfiguration`1.Invokes(System.Action{FakeItEasy.Core.IFakeObjectCall})">
<summary>
Executes the specified action when a matching call is being made.
</summary>
<param name="action">The action to invoke.</param>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.Configuration.IAssertConfiguration">
<summary>
Allows the developer to assert on a call that's configured.
</summary>
</member>
<member name="M:FakeItEasy.Configuration.IAssertConfiguration.MustHaveHappened(FakeItEasy.Repeated)">
<summary>
Asserts that the configured call has happened the number of times
constrained by the repeatConstraint parameter.
</summary>
<param name="repeatConstraint">A constraint for how many times the call
must have happened.</param>
<exception cref="T:FakeItEasy.ExpectationException">The call has not been called a number of times
that passes the repeat constraint.</exception>
</member>
<member name="T:FakeItEasy.Configuration.ICallBaseConfiguration">
<summary>
Configuration that lets you specify that a fake object call should call it's base method.
</summary>
</member>
<member name="M:FakeItEasy.Configuration.ICallBaseConfiguration.CallsBaseMethod">
<summary>
When the configured method or methods are called the call
will be delegated to the base method of the faked method.
</summary>
<returns>A configuration object.</returns>
<exception cref="T:System.InvalidOperationException">The fake object is of an abstract type or an interface
and no base method exists.</exception>
</member>
<member name="M:FakeItEasy.Configuration.IReturnValueConfiguration`1.ReturnsLazily(System.Func{FakeItEasy.Core.IFakeObjectCall,`0})">
<summary>
Specifies a function used to produce a return value when the configured call is made.
The function will be called each time this call is made and can return different values
each time.
</summary>
<param name="valueProducer">A function that produces the return value.</param>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.Configuration.IArgumentValidationConfiguration`1">
<summary>
Provides configurations to validate arguments of a fake object call.
</summary>
<typeparam name="TInterface">The type of interface to return.</typeparam>
</member>
<member name="M:FakeItEasy.Configuration.IArgumentValidationConfiguration`1.WhenArgumentsMatch(System.Func{FakeItEasy.ArgumentCollection,System.Boolean})">
<summary>
Configures the call to be accepted when the specified predicate returns true.
</summary>
<param name="argumentsPredicate">The argument predicate.</param>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.Configuration.IWhereConfiguration`1">
<summary>
Provides a way to configure predicates for when a call should be applied.
</summary>
<typeparam name="T">The type of fake object that is going to be configured..</typeparam>
</member>
<member name="M:FakeItEasy.Configuration.IWhereConfiguration`1.Where(System.Func{FakeItEasy.Core.IFakeObjectCall,System.Boolean},System.Action{FakeItEasy.IOutputWriter})">
<summary>
Applies a predicate to constrain which calls will be considered for interception.
</summary>
<param name="predicate">A predicate for a fake object call.</param>
<param name="descriptionWriter">An action that writes a description of the predicate
to the output.</param>
<returns>The configuration object.</returns>
</member>
<member name="T:FakeItEasy.A`1">
<summary>
Provides an API entry point for constraining arguments of fake object calls.
</summary>
<typeparam name="T">The type of argument to validate.</typeparam>
</member>
<member name="P:FakeItEasy.A`1.That">
<summary>
Gets an argument constraint object that will be used to constrain a method call argument.
</summary>
</member>
<member name="P:FakeItEasy.A`1._">
<summary>
Gets a constraint that considers any value of an argument as valid.
</summary>
<remarks>This is a shortcut for the "Ignored"-property.</remarks>
</member>
<member name="P:FakeItEasy.A`1.Ignored">
<summary>
Gets a constraint that considers any value of an argument as valid.
</summary>
</member>
<member name="M:FakeItEasy.Core.AssemblyExtensions.ReferencesFakeItEasy(System.Reflection.Assembly)">
<summary>
Determines whether an assembly references FakeItEasy.
</summary>
<param name="assembly">The assembly to check.</param>
<returns>Whether or not the assembly references FakeItEasy.</returns>
</member>
<member name="M:FakeItEasy.Core.AssemblyExtensions.Name(System.Reflection.Assembly)">
<summary>
Gets the simple name of the assembly. Can be used in Silverlight solutions.
</summary>
<param name="assembly">The assembly.</param>
<returns>The simple name of the assembly.</returns>
</member>
<member name="T:FakeItEasy.Core.BootstrapperLocator">
<summary>
Locate an <see cref="T:FakeItEasy.IBootstrapper"/> implementation.
</summary>
<remarks>
Will search the app domain for a concrete implementation,
and if it can't find one will use the <see cref="T:FakeItEasy.DefaultBootstrapper"/>.
</remarks>
</member>
<member name="M:FakeItEasy.Core.BootstrapperLocator.FindBootstrapper">
<summary>
Scans app domain assemblies looking for a concrete implementation of
<see cref="T:FakeItEasy.IBootstrapper"/> that is not the <see cref="T:FakeItEasy.DefaultBootstrapper"/>.
Otherwise, the first matching type is instantiated and returned, or an
instance of DefaultBootstrapper is used if no other implementation is found.
</summary>
<returns>An instance of the first non-default IBootstrapper implementation found,
or a DefaultBootstrapper.</returns>
</member>
<member name="T:FakeItEasy.Core.IFakeCallProcessor">
<summary>
Represents the target of intercepted calls of a fake proxy. An implementation of this interface receives calls, gets its arguments
and can provide return values.
</summary>
</member>
<member name="M:FakeItEasy.Core.IFakeCallProcessor.Process(FakeItEasy.Core.IWritableFakeObjectCall)">
<summary>
Processes an intercepted call of a fake proxy.
</summary>
<param name="fakeObjectCall">The call information (like which method has been called, its arguments, ...).</param>
</member>
<member name="T:FakeItEasy.Core.FakeManagerProvider">
<summary>
Implementation of <see cref="T:FakeItEasy.Core.IFakeCallProcessorProvider"/>, which returns a <see cref="T:FakeItEasy.Core.FakeManager"/> as "call processor" lazily (on
the first call of <see cref="M:FakeItEasy.Core.FakeManagerProvider.Fetch(System.Object)"/> or <see cref="M:FakeItEasy.Core.FakeManagerProvider.EnsureInitialized(System.Object)"/>).
</summary>
<remarks>
Note that we just need to serialize the <see cref="T:FakeItEasy.Core.FakeManager"/> + the lock (an "empty", *new* object will be deserialized)
because <see cref="T:FakeItEasy.Core.IFakeCallProcessorProvider"/> doesn't require serializability before the first call of <see cref="M:FakeItEasy.Core.FakeManagerProvider.Fetch(System.Object)"/> or
<see cref="M:FakeItEasy.Core.FakeManagerProvider.EnsureInitialized(System.Object)"/> (see remarks section of <see cref="T:FakeItEasy.Core.IFakeCallProcessorProvider"/>).
</remarks>
</member>
<member name="T:FakeItEasy.Core.IFakeCallProcessorProvider">
<summary>
The responsibility of this interface is to instantiate a new <see cref="T:FakeItEasy.Core.IFakeCallProcessor"/> and to fully initialize it (e.g.
applying the initial configuration). This should happen one time on the first call of <see cref="M:FakeItEasy.Core.IFakeCallProcessorProvider.Fetch(System.Object)"/> or
<see cref="M:FakeItEasy.Core.IFakeCallProcessorProvider.EnsureInitialized(System.Object)"/>.
</summary>
<remarks>
<para>
Note that the implementation of this interface must be thread-safe and guarantee the one-time-initialization property when accessing
the interface methods concurrently (could happen when using this provider in spawned threads in a proxy base constructor).
</para>
<para>
An implementation of this interface should also be serializable and the deserialized object should behave like the original one
*after* it has been initialized (i.e. after the first call of <see cref="M:FakeItEasy.Core.IFakeCallProcessorProvider.Fetch(System.Object)"/> or <see cref="M:FakeItEasy.Core.IFakeCallProcessorProvider.EnsureInitialized(System.Object)"/>) because
we don't need to serialize a fake before it has been initialized (returned to the user).
</para>
</remarks>
</member>
<member name="M:FakeItEasy.Core.IFakeCallProcessorProvider.Fetch(System.Object)">
<summary>
Create and initialize a new <see cref="T:FakeItEasy.Core.IFakeCallProcessor"/> for <paramref name="proxy"/>.
</summary>
<param name="proxy">The corresponding proxy object of the new <see cref="T:FakeItEasy.Core.IFakeCallProcessor"/>.</param>
<returns>The created <see cref="T:FakeItEasy.Core.IFakeCallProcessor"/>.</returns>
</member>
<member name="M:FakeItEasy.Core.IFakeCallProcessorProvider.EnsureInitialized(System.Object)">
<summary>
Ensures that the <see cref="T:FakeItEasy.Core.IFakeCallProcessor"/> is initialized (and can be used via the proxy's tag later on).
</summary>
<param name="proxy">The corresponding proxy object of the new <see cref="T:FakeItEasy.Core.IFakeCallProcessor"/>.</param>
</member>
<member name="T:FakeItEasy.DefaultBootstrapper">
<summary>
The default bootstrapper, used to initialize FakeItEasy unless another
implementation of <see cref="T:FakeItEasy.IBootstrapper"/> is present in the assemblies
loaded in the app domain.
</summary>
</member>
<member name="T:FakeItEasy.IBootstrapper">
<summary>
Bootstrapper for FakeItEasy.
</summary>
<remarks>
<para>When FakeItEasy is initialized, it scans the executing app domain for implementations
of this interface. If any are found, one will be instantiated and used to bootstrap
FakeItEasy. If no implementations are found, then a <see cref="T:FakeItEasy.DefaultBootstrapper"/>
will be used.</para>
<para>The recommended way to implement IBootstrapper is to extend DefaultBootstrapper
and override selected methods.</para>
</remarks>
</member>
<member name="M:FakeItEasy.IBootstrapper.GetAssemblyFileNamesToScanForExtensions">
<summary>
Provides a list of assembly file names to scan for extension points, such as
<see cref="T:FakeItEasy.IDummyDefinition"/>s, <see cref="T:FakeItEasy.IArgumentValueFormatter"/>s, and
<see cref="T:FakeItEasy.IFakeConfigurator"/>s.
</summary>
<returns>A list of absolute paths pointing to assemblies to scan for extension points.</returns>
</member>
<member name="M:FakeItEasy.DefaultBootstrapper.GetAssemblyFileNamesToScanForExtensions">
<summary>
When overridden in a derived class, provides a custom list of assembly file
names to scan for extension points, such as
<see cref="T:FakeItEasy.IDummyDefinition"/>s, <see cref="T:FakeItEasy.IArgumentValueFormatter"/>s, and
<see cref="T:FakeItEasy.IFakeConfigurator"/>s.
</summary>
<returns>
An empty list, but may be overridden to provide a list of absolute paths
to assemblies to scan for extension points.
</returns>
</member>
<member name="T:FakeItEasy.Expressions.ArgumentConstraints.IArgumentValueProvider">
<summary>
An object that may provide argument values, for example as implicitly-defined values for
methods' out parameters.
</summary>
</member>
<member name="T:FakeItEasy.Core.IArgumentConstraint">
<summary>
Validates an argument, checks that it's valid in a specific fake call.
</summary>
</member>
<member name="M:FakeItEasy.Core.IArgumentConstraint.WriteDescription(FakeItEasy.IOutputWriter)">
<summary>
Writes a description of the argument constraint to the specified writer.
</summary>
<param name="writer">
The writer.
</param>
</member>
<member name="M:FakeItEasy.Core.IArgumentConstraint.IsValid(System.Object)">
<summary>
Gets whether the argument is valid.
</summary>
<param name="argument">The argument to validate.</param>
<returns>True if the argument is valid.</returns>
</member>
<member name="P:FakeItEasy.Expressions.ArgumentConstraints.OutArgumentConstraint.Value">
<summary>
Gets the value that was used when specifying the constraint.
Used for implicit assignment of out parameter values, not for matching.
Since the called method has no access to the incoming parameter value,
there's no use in accepting or rejecting calls based on the
incoming parameter value.
</summary>
</member>
<member name="M:FakeItEasy.Expressions.ArgumentConstraints.RefArgumentConstraint.#ctor(FakeItEasy.Core.IArgumentConstraint,System.Object)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Expressions.ArgumentConstraints.RefArgumentConstraint"/> class by
wrapping an existing <see cref="T:FakeItEasy.Core.IArgumentConstraint"/>.
</summary>
<param name="baseConstraint">The original constraint, which will be used for argument validation.</param>
<param name="value">The value to be used when implicitly assigning values to a call's ref parameter.</param>
</member>
<member name="P:FakeItEasy.Expressions.ArgumentConstraints.RefArgumentConstraint.Value">
<summary>
Gets the value that was used when specifying the constraint.
Used for implicit assignment of ref parameter values.
</summary>
</member>
<member name="T:FakeItEasy.MethodBaseExtensions">
<summary>
Provides extension methods for <see cref="T:System.Reflection.MethodBase"/>.
</summary>
</member>
<member name="T:FakeItEasy.OutAndRefParametersConfigurationExtensions">
<summary>
Provides extension methods for <see cref="T:FakeItEasy.Configuration.IOutAndRefParametersConfiguration"/>.
</summary>
</member>
<member name="M:FakeItEasy.OutAndRefParametersConfigurationExtensions.AssignsOutAndRefParameters(FakeItEasy.Configuration.IOutAndRefParametersConfiguration,System.Object[])">
<summary>
Specifies output values for out and ref parameters. The values should appear
in the same order as the out and ref parameters in the configured call.
Any non out and ref parameters are ignored.
The function will be called each time this call is made and can return different values.
</summary>
<param name="configuration">The configuration to extend.</param>
<param name="values">The values.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.OutAndRefParametersConfigurationExtensions.AssignsOutAndRefParametersLazily``1(FakeItEasy.Configuration.IOutAndRefParametersConfiguration,System.Func{``0,System.Object[]})">
<summary>
Specifies a function used to produce output values for out and ref parameters.
The values should appear in the same order as the out and ref parameters in the configured call.
Any non out and ref parameters are ignored.
The function will be called each time this call is made and can return different values.
</summary>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the output values.</param>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">
The signatures of the faked method and the <paramref name="valueProducer"/> do not match.
</exception>
</member>
<member name="M:FakeItEasy.OutAndRefParametersConfigurationExtensions.AssignsOutAndRefParametersLazily``2(FakeItEasy.Configuration.IOutAndRefParametersConfiguration,System.Func{``0,``1,System.Object[]})">
<summary>
Specifies a function used to produce output values for out and ref parameters.
The values should appear in the same order as the out and ref parameters in the configured call.
Any non out and ref parameters are ignored.
The function will be called each time this call is made and can return different values.
</summary>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the output values.</param>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">
The signatures of the faked method and the <paramref name="valueProducer"/> do not match.
</exception>
</member>
<member name="M:FakeItEasy.OutAndRefParametersConfigurationExtensions.AssignsOutAndRefParametersLazily``3(FakeItEasy.Configuration.IOutAndRefParametersConfiguration,System.Func{``0,``1,``2,System.Object[]})">
<summary>
Specifies a function used to produce output values for out and ref parameters.
The values should appear in the same order as the out and ref parameters in the configured call.
Any non out and ref parameters are ignored.
The function will be called each time this call is made and can return different values.
</summary>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the output values.</param>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">
The signatures of the faked method and the <paramref name="valueProducer"/> do not match.
</exception>
</member>
<member name="M:FakeItEasy.OutAndRefParametersConfigurationExtensions.AssignsOutAndRefParametersLazily``4(FakeItEasy.Configuration.IOutAndRefParametersConfiguration,System.Func{``0,``1,``2,``3,System.Object[]})">
<summary>
Specifies a function used to produce output values for out and ref parameters.
The values should appear in the same order as the out and ref parameters in the configured call.
Any non out and ref parameters are ignored.
The function will be called each time this call is made and can return different values.
</summary>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<typeparam name="T4">Type of the fourth argument of the faked method call.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the output values.</param>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">
The signatures of the faked method and the <paramref name="valueProducer"/> do not match.
</exception>
</member>
<member name="T:FakeItEasy.TypeExtensions">
<summary>
Provides extension methods for <see cref="T:System.Type"/>.
</summary>
</member>
<member name="T:FakeItEasy.StringBuilderExtensions">
<summary>
Provides extension methods for <see cref="T:System.Text.StringBuilder"/>.
</summary>
</member>
<member name="T:FakeItEasy.StringExtensions">
<summary>
Provides extension methods for <see cref="T:System.String"/>.
</summary>
</member>
<member name="M:FakeItEasy.StringExtensions.FormatInvariant(System.String,System.Object[])">
<summary>
Replaces the format item in a specified System.String with the text equivalent
of the value of a corresponding System.Object instance in a specified array using
invariant culture as <see cref="T:System.IFormatProvider"/>.
</summary>
<param name="format">A composite format string.</param>
<param name="arguments">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
<returns>The formatted string.</returns>
</member>
<member name="T:FakeItEasy.ReturnValueConfigurationExtensions">
<summary>
Provides extension methods for <see cref="T:FakeItEasy.Configuration.IReturnValueConfiguration`1"/>.
</summary>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.Returns``1(FakeItEasy.Configuration.IReturnValueConfiguration{``0},``0)">
<summary>
Specifies the value to return when the configured call is made.
</summary>
<typeparam name="T">The type of the return value.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="value">The value to return.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.Returns``1(FakeItEasy.Configuration.IReturnValueConfiguration{System.Threading.Tasks.Task{``0}},``0)">
<summary>
Specifies the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/> which is returned when the configured call is made.
The <see cref="T:System.Threading.Tasks.Task`1"/> returned from the configured call will have a <see cref="P:System.Threading.Tasks.Task.Status"/> of <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion"/>.
</summary>
<typeparam name="T">The type of the result produced by the <see cref="T:System.Threading.Tasks.Task`1"/>.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="value">The <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/>.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``1(FakeItEasy.Configuration.IReturnValueConfiguration{``0},System.Func{``0})">
<summary>
Specifies a function used to produce a return value when the configured call is made.
The function will be called each time this call is made and can return different values
each time.
</summary>
<typeparam name="T">The type of the return value.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the return value.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``1(FakeItEasy.Configuration.IReturnValueConfiguration{System.Threading.Tasks.Task{``0}},System.Func{``0})">
<summary>
Specifies a function used to produce the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/> which is returned when the configured call is made.
The function will be called each time the configured call is made and can return different values each time.
The <see cref="T:System.Threading.Tasks.Task`1"/> returned from the configured call will have a <see cref="P:System.Threading.Tasks.Task.Status"/> of <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion"/>.
</summary>
<typeparam name="T">The type of the result produced by the <see cref="T:System.Threading.Tasks.Task`1"/>.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/>.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``2(FakeItEasy.Configuration.IReturnValueConfiguration{``0},System.Func{``1,``0})">
<summary>
Specifies a function used to produce a return value when the configured call is made.
The function will be called each time this call is made and can return different values
each time.
</summary>
<typeparam name="TReturnType">The type of the return value.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the return value.</param>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="valueProducer"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``2(FakeItEasy.Configuration.IReturnValueConfiguration{System.Threading.Tasks.Task{``0}},System.Func{``1,``0})">
<summary>
Specifies a function used to produce the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/> which is returned when the configured call is made.
The function will be called each time the configured call is made and can return different values each time.
The <see cref="T:System.Threading.Tasks.Task`1"/> returned from the configured call will have a <see cref="P:System.Threading.Tasks.Task.Status"/> of <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion"/>.
</summary>
<typeparam name="TReturnType">The type of the result produced by the <see cref="T:System.Threading.Tasks.Task`1"/>.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/>.</param>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="valueProducer"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``3(FakeItEasy.Configuration.IReturnValueConfiguration{``0},System.Func{``1,``2,``0})">
<summary>
Specifies a function used to produce a return value when the configured call is made.
The function will be called each time this call is made and can return different values
each time.
</summary>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the return value.</param>
<typeparam name="TReturnType">The type of the return value.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="valueProducer"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``3(FakeItEasy.Configuration.IReturnValueConfiguration{System.Threading.Tasks.Task{``0}},System.Func{``1,``2,``0})">
<summary>
Specifies a function used to produce the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/> which is returned when the configured call is made.
The function will be called each time the configured call is made and can return different values each time.
The <see cref="T:System.Threading.Tasks.Task`1"/> returned from the configured call will have a <see cref="P:System.Threading.Tasks.Task.Status"/> of <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion"/>.
</summary>
<typeparam name="TReturnType">The type of the result produced by the <see cref="T:System.Threading.Tasks.Task`1"/>.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/>.</param>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="valueProducer"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``4(FakeItEasy.Configuration.IReturnValueConfiguration{``0},System.Func{``1,``2,``3,``0})">
<summary>
Specifies a function used to produce a return value when the configured call is made.
The function will be called each time this call is made and can return different values
each time.
</summary>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the return value.</param>
<typeparam name="TReturnType">The type of the return value.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="valueProducer"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``4(FakeItEasy.Configuration.IReturnValueConfiguration{System.Threading.Tasks.Task{``0}},System.Func{``1,``2,``3,``0})">
<summary>
Specifies a function used to produce the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/> which is returned when the configured call is made.
The function will be called each time the configured call is made and can return different values each time.
The <see cref="T:System.Threading.Tasks.Task`1"/> returned from the configured call will have a <see cref="P:System.Threading.Tasks.Task.Status"/> of <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion"/>.
</summary>
<typeparam name="TReturnType">The type of the result produced by the <see cref="T:System.Threading.Tasks.Task`1"/>.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/>.</param>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="valueProducer"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``5(FakeItEasy.Configuration.IReturnValueConfiguration{``0},System.Func{``1,``2,``3,``4,``0})">
<summary>
Specifies a function used to produce a return value when the configured call is made.
The function will be called each time this call is made and can return different values
each time.
</summary>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the return value.</param>
<typeparam name="TReturnType">The type of the return value.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<typeparam name="T4">Type of the fourth argument of the faked method call.</typeparam>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="valueProducer"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsLazily``5(FakeItEasy.Configuration.IReturnValueConfiguration{System.Threading.Tasks.Task{``0}},System.Func{``1,``2,``3,``4,``0})">
<summary>
Specifies a function used to produce the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/> which is returned when the configured call is made.
The function will be called each time the configured call is made and can return different values each time.
The <see cref="T:System.Threading.Tasks.Task`1"/> returned from the configured call will have a <see cref="P:System.Threading.Tasks.Task.Status"/> of <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion"/>.
</summary>
<typeparam name="TReturnType">The type of the result produced by the <see cref="T:System.Threading.Tasks.Task`1"/>.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<typeparam name="T4">Type of the fourth argument of the faked method call.</typeparam>
<param name="configuration">The configuration to extend.</param>
<param name="valueProducer">A function that produces the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of the <see cref="T:System.Threading.Tasks.Task`1"/>.</param>
<returns>A configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="valueProducer"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsNextFromSequence``1(FakeItEasy.Configuration.IReturnValueConfiguration{``0},``0[])">
<summary>
Configures the call to return the next value from the specified sequence each time it's called.
After the sequence has been exhausted, the call will revert to the previously configured behavior.
</summary>
<typeparam name="T">The type of return value.</typeparam>
<param name="configuration">The call configuration to extend.</param>
<param name="values">The values to return in sequence.</param>
</member>
<member name="M:FakeItEasy.ReturnValueConfigurationExtensions.ReturnsNextFromSequence``1(FakeItEasy.Configuration.IReturnValueConfiguration{System.Threading.Tasks.Task{``0}},``0[])">
<summary>
Configures the call to return a <see cref="T:System.Threading.Tasks.Task`1"/> with a <see cref="P:System.Threading.Tasks.Task`1.Result"/> of
the next value from the specified sequence each time it's called.
After the sequence has been exhausted, the call will revert to the previously configured behavior.
Each <see cref="T:System.Threading.Tasks.Task`1"/> returned from the configured call will have a <see cref="P:System.Threading.Tasks.Task.Status"/> of <see cref="F:System.Threading.Tasks.TaskStatus.RanToCompletion"/>.
</summary>
<typeparam name="T">The type of the result produced by each <see cref="T:System.Threading.Tasks.Task`1"/>.</typeparam>
<param name="configuration">The call configuration to extend.</param>
<param name="values">The values to use for the <see cref="P:System.Threading.Tasks.Task`1.Result"/> of each <see cref="T:System.Threading.Tasks.Task`1"/> in sequence.</param>
</member>
<member name="T:FakeItEasy.ArgumentValidationConfigurationExtensions">
<summary>
Provides extension methods for <see cref="T:FakeItEasy.Configuration.IArgumentValidationConfiguration`1"/>.
</summary>
</member>
<member name="M:FakeItEasy.ArgumentValidationConfigurationExtensions.WithAnyArguments``1(FakeItEasy.Configuration.IArgumentValidationConfiguration{``0})">
<summary>
Specifies that a call to the configured call should be applied no matter what arguments
are used in the call to the faked object.
</summary>
<typeparam name="TInterface">The type of the interface.</typeparam>
<param name="configuration">The configuration.</param>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.AssertConfigurationExtensions">
<summary>
Provides extension methods for <see cref="T:FakeItEasy.Configuration.IAssertConfiguration"/>.
</summary>
</member>
<member name="M:FakeItEasy.AssertConfigurationExtensions.MustHaveHappened(FakeItEasy.Configuration.IAssertConfiguration)">
<summary>
Asserts that the specified call must have happened once or more.
</summary>
<param name="configuration">The configuration to assert on.</param>
</member>
<member name="M:FakeItEasy.AssertConfigurationExtensions.MustNotHaveHappened(FakeItEasy.Configuration.IAssertConfiguration)">
<summary>
Asserts that the specified call has not happened.
</summary>
<param name="configuration">The configuration to assert on.</param>
</member>
<member name="T:FakeItEasy.ExceptionThrowerConfigurationExtensions">
<summary>
Provides the extension methods for <see cref="T:FakeItEasy.Configuration.IExceptionThrowerConfiguration"/>.
</summary>
</member>
<member name="M:FakeItEasy.ExceptionThrowerConfigurationExtensions.Throws(FakeItEasy.Configuration.IExceptionThrowerConfiguration,System.Exception)">
<summary>
Throws the specified exception when the currently configured
call gets called.
</summary>
<param name="configuration">The configuration to use.</param>
<param name="exception">The exception to throw when a call that matches is invoked.</param>
<returns>Configuration object.</returns>
</member>
<member name="M:FakeItEasy.ExceptionThrowerConfigurationExtensions.Throws(FakeItEasy.Configuration.IExceptionThrowerConfiguration,System.Func{System.Exception})">
<summary>
Throws the specified exception when the currently configured
call gets called.
</summary>
<param name="configuration">The configuration to use.</param>
<param name="exceptionFactory">A function that returns the exception to throw when invoked.</param>
<returns>Configuration object.</returns>
</member>
<member name="M:FakeItEasy.ExceptionThrowerConfigurationExtensions.Throws``1(FakeItEasy.Configuration.IExceptionThrowerConfiguration,System.Func{``0,System.Exception})">
<summary>
Throws the specified exception when the currently configured
call gets called.
</summary>
<param name="configuration">The configuration to use.</param>
<param name="exceptionFactory">A function that returns the exception to throw when invoked.</param>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<returns>Configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="exceptionFactory"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ExceptionThrowerConfigurationExtensions.Throws``2(FakeItEasy.Configuration.IExceptionThrowerConfiguration,System.Func{``0,``1,System.Exception})">
<summary>
Throws the specified exception when the currently configured
call gets called.
</summary>
<param name="configuration">The configuration to use.</param>
<param name="exceptionFactory">A function that returns the exception to throw when invoked.</param>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<returns>Configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="exceptionFactory"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ExceptionThrowerConfigurationExtensions.Throws``3(FakeItEasy.Configuration.IExceptionThrowerConfiguration,System.Func{``0,``1,``2,System.Exception})">
<summary>
Throws the specified exception when the currently configured
call gets called.
</summary>
<param name="configuration">The configuration to use.</param>
<param name="exceptionFactory">A function that returns the exception to throw when invoked.</param>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<returns>Configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="exceptionFactory"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ExceptionThrowerConfigurationExtensions.Throws``4(FakeItEasy.Configuration.IExceptionThrowerConfiguration,System.Func{``0,``1,``2,``3,System.Exception})">
<summary>
Throws the specified exception when the currently configured
call gets called.
</summary>
<param name="configuration">The configuration to use.</param>
<param name="exceptionFactory">A function that returns the exception to throw when invoked.</param>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<typeparam name="T4">Type of the fourth argument of the faked method call.</typeparam>
<returns>Configuration object.</returns>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="exceptionFactory"/> do not match.</exception>
</member>
<member name="M:FakeItEasy.ExceptionThrowerConfigurationExtensions.Throws``1(FakeItEasy.Configuration.IExceptionThrowerConfiguration)">
<summary>
Throws the specified exception when the currently configured
call gets called.
</summary>
<param name="configuration">The configuration to use.</param>
<typeparam name="T">The type of exception to throw.</typeparam>
<returns>Configuration object.</returns>
</member>
<member name="T:FakeItEasy.CallbackConfigurationExtensions">
<summary>
Provides extension methods for <see cref="T:FakeItEasy.Configuration.ICallbackConfiguration`1"/>.
</summary>
</member>
<member name="M:FakeItEasy.CallbackConfigurationExtensions.Invokes``1(FakeItEasy.Configuration.ICallbackConfiguration{``0},System.Action)">
<summary>
Executes the specified action when a matching call is being made. This overload can also be used to fake calls with arguments when they don't need to be accessed.
</summary>
<typeparam name="TFake">The type of fake object.</typeparam>
<param name="configuration">The configuration that is extended.</param>
<param name="actionToInvoke">The <see cref="T:System.Action"/> to invoke.</param>
<returns>The fake object.</returns>
</member>
<member name="M:FakeItEasy.CallbackConfigurationExtensions.Invokes``2(FakeItEasy.Configuration.ICallbackConfiguration{``0},System.Action{``1})">
<summary>
Executes the specified action when a matching call is being made.
</summary>
<param name="configuration">The configuration that is extended.</param>
<param name="actionToInvoke">The <see cref="T:System.Action`1"/> to invoke.</param>
<typeparam name="TFake">The type of fake object.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="actionToInvoke"/> do not match.</exception>
<returns>The fake object.</returns>
</member>
<member name="M:FakeItEasy.CallbackConfigurationExtensions.Invokes``3(FakeItEasy.Configuration.ICallbackConfiguration{``0},System.Action{``1,``2})">
<summary>
Executes the specified action when a matching call is being made.
</summary>
<param name="configuration">The configuration that is extended.</param>
<param name="actionToInvoke">The <see cref="T:System.Action`2"/> to invoke.</param>
<typeparam name="TFake">The type of fake object.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="actionToInvoke"/> do not match.</exception>
<returns>The fake object.</returns>
</member>
<member name="M:FakeItEasy.CallbackConfigurationExtensions.Invokes``4(FakeItEasy.Configuration.ICallbackConfiguration{``0},System.Action{``1,``2,``3})">
<summary>
Executes the specified action when a matching call is being made.
</summary>
<param name="configuration">The configuration that is extended.</param>
<param name="actionToInvoke">The <see cref="T:System.Action`3"/> to invoke.</param>
<typeparam name="TFake">The type of fake object.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="actionToInvoke"/> do not match.</exception>
<returns>The fake object.</returns>
</member>
<member name="M:FakeItEasy.CallbackConfigurationExtensions.Invokes``5(FakeItEasy.Configuration.ICallbackConfiguration{``0},System.Action{``1,``2,``3,``4})">
<summary>
Executes the specified action when a matching call is being made.
</summary>
<param name="configuration">The configuration that is extended.</param>
<param name="actionToInvoke">The <see cref="T:System.Action`4"/> to invoke.</param>
<typeparam name="TFake">The type of fake object.</typeparam>
<typeparam name="T1">Type of the first argument of the faked method call.</typeparam>
<typeparam name="T2">Type of the second argument of the faked method call.</typeparam>
<typeparam name="T3">Type of the third argument of the faked method call.</typeparam>
<typeparam name="T4">Type of the fourth argument of the faked method call.</typeparam>
<exception cref="T:FakeItEasy.Configuration.FakeConfigurationException">The signatures of the faked method and the <paramref name="actionToInvoke"/> do not match.</exception>
<returns>The fake object.</returns>
</member>
<member name="T:FakeItEasy.WhereConfigurationExtensions">
<summary>
Provides extension methods for <see cref="T:FakeItEasy.Configuration.IWhereConfiguration`1"/>.
</summary>
</member>
<member name="M:FakeItEasy.WhereConfigurationExtensions.Where``1(FakeItEasy.Configuration.IWhereConfiguration{``0},System.Linq.Expressions.Expression{System.Func{FakeItEasy.Core.IFakeObjectCall,System.Boolean}})">
<summary>
Applies a predicate to constrain which calls will be considered for interception.
</summary>
<typeparam name="T">The return type of the where method.</typeparam>
<param name="configuration">The configuration object to extend.</param>
<param name="predicate">A predicate for a fake object call.</param>
<returns>The configuration object.</returns>
</member>
<member name="T:FakeItEasy.FakeOptionsBuilderExtensions">
<summary>
Provides extension methods for <see cref="T:FakeItEasy.Creation.IFakeOptionsBuilder`1"/>.
</summary>
</member>
<member name="M:FakeItEasy.FakeOptionsBuilderExtensions.Strict``1(FakeItEasy.Creation.IFakeOptionsBuilder{``0})">
<summary>
Makes the fake strict, this means that any call to the fake
that has not been explicitly configured will throw an exception.
</summary>
<typeparam name="T">The type of fake object.</typeparam>
<param name="options">The configuration.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.FakeOptionsBuilderExtensions.CallsBaseMethods``1(FakeItEasy.Creation.IFakeOptionsBuilder{``0})">
<summary>
Makes the fake default to calling base methods, so long as they aren't abstract.
</summary>
<typeparam name="T">The type of fake object.</typeparam>
<param name="options">The configuration.</param>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.FakeObjectCallExtensions">
<summary>
Provides extension methods for <see cref="T:FakeItEasy.Core.IFakeObjectCall"/>.
</summary>
</member>
<member name="M:FakeItEasy.FakeObjectCallExtensions.GetArgument``1(FakeItEasy.Core.IFakeObjectCall,System.Int32)">
<summary>
Gets the argument at the specified index in the arguments collection
for the call.
</summary>
<typeparam name="T">The type of the argument to get.</typeparam>
<param name="call">The call to get the argument from.</param>
<param name="argumentIndex">The index of the argument.</param>
<returns>The value of the argument with the specified index.</returns>
</member>
<member name="M:FakeItEasy.FakeObjectCallExtensions.GetArgument``1(FakeItEasy.Core.IFakeObjectCall,System.String)">
<summary>
Gets the argument with the specified name in the arguments collection
for the call.
</summary>
<typeparam name="T">The type of the argument to get.</typeparam>
<param name="call">The call to get the argument from.</param>
<param name="argumentName">The name of the argument.</param>
<returns>The value of the argument with the specified name.</returns>
</member>
<member name="M:FakeItEasy.FakeObjectCallExtensions.Write``1(System.Collections.Generic.IEnumerable{``0},FakeItEasy.IOutputWriter)">
<summary>
Writes the calls in the collection to the specified output writer.
</summary>
<typeparam name="T">The type of the calls.</typeparam>
<param name="calls">The calls to write.</param>
<param name="writer">The writer to write the calls to.</param>
</member>
<member name="M:FakeItEasy.FakeObjectCallExtensions.WriteToConsole``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Writes all calls in the collection to the console.
</summary>
<typeparam name="T">The type of the calls.</typeparam>
<param name="calls">The calls to write.</param>
</member>
<member name="M:FakeItEasy.FakeObjectCallExtensions.GetDescription(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Gets the description of a call to a fake object.
</summary>
<param name="fakeObjectCall">The call to describe.</param>
<returns>A description of the call.</returns>
</member>
<member name="T:FakeItEasy.RepeatConfigurationExtensions">
<summary>
Provides extensions for <see cref="T:FakeItEasy.Configuration.IRepeatConfiguration"/>.
</summary>
</member>
<member name="M:FakeItEasy.RepeatConfigurationExtensions.Once(FakeItEasy.Configuration.IRepeatConfiguration)">
<summary>
Specifies NumberOfTimes(1) to the repeat configuration.
</summary>
<param name="configuration">The configuration to set repeat 1 to.</param>
</member>
<member name="M:FakeItEasy.RepeatConfigurationExtensions.Twice(FakeItEasy.Configuration.IRepeatConfiguration)">
<summary>
Specifies NumberOfTimes(2) to the repeat configuration.
</summary>
<param name="configuration">The configuration to set repeat 2 to.</param>
</member>
<member name="T:FakeItEasy.ExceptionMessages">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.ApplicatorNotSetExceptionMessage">
<summary>
Looks up a localized string similar to The Apply method of the ExpressionInterceptor may no be called before the Applicator property has been set..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.ArgumentNameDoesNotExist">
<summary>
Looks up a localized string similar to The specified argument name does not exist in the ArgumentList..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.ArgumentsForConstructorOnInterfaceType">
<summary>
Looks up a localized string similar to Arguments for constructor was specified when generating proxy of interface type..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.ArgumentValidationDefaultMessage">
<summary>
Looks up a localized string similar to An argument validation was not configured correctly..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.CalledTooFewTimesMessage">
<summary>
Looks up a localized string similar to The method '{0}' was called too few times, expected #{1} times but was called #{2} times..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.CalledTooManyTimesMessage">
<summary>
Looks up a localized string similar to The method '{0}' was called too many times, expected #{1} times but was called #{2} times..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.CanNotGenerateFakeMessage">
<summary>
Looks up a localized string similar to Can not create fake of the type '{0}', it's not registered in the current container and the current IProxyGenerator can not generate the fake.
The following constructors failed:
{1}.
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.ConfiguringNonFakeObjectExceptionMessage">
<summary>
Looks up a localized string similar to Error when accessing FakeObject, the specified argument is of the type '{0}' which is not faked..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.CreatingExpressionCallMatcherWithNonMethodOrPropertyExpression">
<summary>
Looks up a localized string similar to An ExpressionCallMatcher can only be created for expressions that represents a method call or a property getter..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.FailedToGenerateFakeWithArgumentsForConstructorPattern">
<summary>
Looks up a localized string similar to
The current proxy generator failed to create a proxy with the specified arguments for the constructor:
Reason for failure:
- {0}
.
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.FailedToGenerateProxyPattern">
<summary>
Looks up a localized string similar to FakeItEasy failed to create fake object of type "{0}".
1. The type is not registered in the current IFakeObjectContainer.
2. The current IProxyGenerator failed to generate a proxy for the following reason:
{1}.
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.FakeCreationExceptionDefaultMessage">
<summary>
Looks up a localized string similar to Unable to create fake object..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.FakeManagerWasInitializedWithDifferentProxyMessage">
<summary>
Looks up a localized string similar to The fake manager was initialized for a different proxy..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.FakingNonAbstractClassWithArgumentsForConstructor">
<summary>
Looks up a localized string similar to Only abstract classes can be faked using the A.Fake-method that takes an enumerable of objects as arguments for constructor, use the overload that takes an expression instead..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.MemberAccessorNotCorrectExpressionType">
<summary>
Looks up a localized string similar to The member accessor expression must be a lambda expression with a MethodCallExpression or MemberAccessExpression as its body..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.MemberCanNotBeIntercepted">
<summary>
Looks up a localized string similar to The specified method can not be configured since it can not be intercepted by the current IProxyGenerator..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.MethodMissmatchWhenPlayingBackRecording">
<summary>
Looks up a localized string similar to The method of the call did not match the method of the recorded call, the recorded sequence is no longer valid..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.NoConstructorMatchingArguments">
<summary>
Looks up a localized string similar to No constructor matching the specified arguments was found on the type {0}..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.NoDefaultConstructorMessage">
<summary>
Looks up a localized string similar to Can not generate fake object for the class since no usable default constructor was found, specify a constructor call..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.NoMoreRecordedCalls">
<summary>
Looks up a localized string similar to All the recorded calls has been applied, the recorded sequence is no longer valid..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.NonConstructorExpressionMessage">
<summary>
Looks up a localized string similar to Only expression of the type ExpressionType.New (constructor calls) are accepted..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.NowCalledDirectly">
<summary>
Looks up a localized string similar to The Now-method on the event raise is not meant to be called directly, only use it to register to an event on a fake object that you want to be raised..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.NumberOfOutAndRefParametersDoesNotMatchCall">
<summary>
Looks up a localized string similar to The number of values for out and ref parameters specified does not match the number of out and ref parameters in the call..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.OrderedAssertionsAlreadyOpen">
<summary>
Looks up a localized string similar to A scope for ordered assertions is already opened, close that scope before opening another one..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.SpecifiedCallIsNotToFakedObject">
<summary>
Looks up a localized string similar to The specified call is not made on a fake object..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.TypeCanNotBeProxied">
<summary>
Looks up a localized string similar to The current fake proxy generator can not create proxies of the type {0}..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.UnableToCreateDummyPattern">
<summary>
Looks up a localized string similar to FakeItEasy was unable to create dummy of type "{0}", register it in the current IFakeObjectContainer to enable this..
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.WasCalledWrongNumberOfTimes">
<summary>
Looks up a localized string similar to Expected to find call {0} the number of times specified by the predicate '{1}' but found it {2} times among the calls:.
</summary>
</member>
<member name="P:FakeItEasy.ExceptionMessages.WrongNumberOfArgumentNamesMessage">
<summary>
Looks up a localized string similar to The number of argument names does not match the number of arguments..
</summary>
</member>
<member name="T:FakeItEasy.Raise`1">
<summary>
A class exposing an event handler to attach to an event of a faked object
in order to raise that event.
</summary>
<typeparam name="TEventArgs">The type of the event args.</typeparam>
</member>
<member name="T:FakeItEasy.Core.IEventRaiserArguments">
<summary>
Used by the event raising rule of fake objects to get the event arguments used in
a call to Raise.With.
</summary>
</member>
<member name="P:FakeItEasy.Core.IEventRaiserArguments.Sender">
<summary>
Gets the sender of the event.
</summary>
</member>
<member name="P:FakeItEasy.Core.IEventRaiserArguments.EventArguments">
<summary>
Gets the event arguments of the event.
</summary>
</member>
<member name="M:FakeItEasy.Raise`1.op_Implicit(FakeItEasy.Raise{`0})~System.EventHandler{`0}">
<summary>
Converts a raiser into an <see cref="T:System.EventHandler`1"/>
</summary>
<param name="raiser">The raiser to convert.</param>
<returns>The new event handler</returns>
</member>
<member name="M:FakeItEasy.Raise`1.op_Implicit(FakeItEasy.Raise{`0})~System.EventHandler">
<summary>
Converts a raiser into an <see cref="T:System.EventHandler"/>
</summary>
<param name="raiser">The raiser to convert.</param>
<returns>The new event handler</returns>
</member>
<member name="M:FakeItEasy.Raise`1.Now(System.Object,`0)">
<summary>
Register this event handler to an event on a faked object in order to raise that event.
</summary>
<param name="sender">The sender of the event.</param>
<param name="e">Event args for the event.</param>
</member>
<member name="M:FakeItEasy.Raise`1.Now(System.Object,System.EventArgs)">
<summary>
Register this event handler to an event on a faked object in order to raise that event.
</summary>
<param name="sender">The sender of the event.</param>
<param name="e">Event args for the event.</param>
</member>
<member name="P:FakeItEasy.Raise`1.Go">
<summary>
Gets a generic event handler to attach to the event to raise.
</summary>
</member>
<member name="T:FakeItEasy.Fake`1">
<summary>
Represents a fake object that provides an API for configuring a faked object, exposed by the
FakedObject-property.
</summary>
<typeparam name="T">The type of the faked object.</typeparam>
</member>
<member name="T:FakeItEasy.Configuration.IStartConfiguration`1">
<summary>
Provides methods for configuring a fake object.
</summary>
<typeparam name="TFake">The type of fake object.</typeparam>
</member>
<member name="M:FakeItEasy.Configuration.IStartConfiguration`1.CallsTo``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
<summary>
Configures the behavior of the fake object when a call that matches the specified
call happens.
</summary>
<typeparam name="TMember">The type of the return value of the member.</typeparam>
<param name="callSpecification">An expression that specifies the calls to configure.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.Configuration.IStartConfiguration`1.CallsTo(System.Linq.Expressions.Expression{System.Action{`0}})">
<summary>
Configures the behavior of the fake object when a call that matches the specified
call happens.
</summary>
<param name="callSpecification">An expression that specifies the calls to configure.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.Configuration.IStartConfiguration`1.AnyCall">
<summary>
Configures the behavior of the fake object when a call is made to any method on the
object.
</summary>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.Fake`1.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Fake`1"/> class.
Creates a new fake object.
</summary>
</member>
<member name="M:FakeItEasy.Fake`1.#ctor(System.Action{FakeItEasy.Creation.IFakeOptionsBuilder{`0}})">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Fake`1"/> class.
Creates a new fake object using the specified options.
</summary>
<param name="options">
Options used to create the fake object.
</param>
</member>
<member name="M:FakeItEasy.Fake`1.CallsTo(System.Linq.Expressions.Expression{System.Action{`0}})">
<summary>
Configures calls to the specified member.
</summary>
<param name="callSpecification">An expression specifying the call to configure.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.Fake`1.CallsTo``1(System.Linq.Expressions.Expression{System.Func{`0,``0}})">
<summary>
Configures calls to the specified member.
</summary>
<typeparam name="TMember">The type of value the member returns.</typeparam>
<param name="callSpecification">An expression specifying the call to configure.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.Fake`1.AnyCall">
<summary>
Configures any call to the fake object.
</summary>
<returns>A configuration object.</returns>
</member>
<member name="P:FakeItEasy.Fake`1.FakedObject">
<summary>
Gets the faked object.
</summary>
</member>
<member name="P:FakeItEasy.Fake`1.RecordedCalls">
<summary>
Gets all calls made to the faked object.
</summary>
</member>
<member name="T:FakeItEasy.Core.TypeCatalogue">
<summary>
Provides access to all types in:
<list type="bullet">
<item>FakeItEasy,</item>
<item>assemblies loaded into the current <see cref="T:System.AppDomain"/> that reference FakeItEasy and</item>
<item>assemblies whose paths are supplied to the constructor, that also reference FakeItEasy.</item>
</list>
</summary>
</member>
<member name="T:FakeItEasy.Core.ITypeCatalogue">
<summary>
Provides a set of types that are available.
</summary>
</member>
<member name="M:FakeItEasy.Core.ITypeCatalogue.GetAvailableTypes">
<summary>
Gets a collection of available types.
</summary>
<returns>The available types.</returns>
</member>
<member name="M:FakeItEasy.Core.TypeCatalogue.Load(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Loads the available types into the <see cref="T:FakeItEasy.Core.TypeCatalogue"/>.
</summary>
<param name="extraAssemblyFiles">
The full paths to assemblies from which to load types,
as well as assemblies loaded into the current <see cref="T:System.AppDomain"/>.
</param>
</member>
<member name="M:FakeItEasy.Core.TypeCatalogue.GetAvailableTypes">
<summary>
Gets a collection of available types.
</summary>
<returns>The available types.</returns>
</member>
<member name="T:FakeItEasy.Configuration.IAnyCallConfigurationWithNoReturnTypeSpecified">
<summary>
Configuration for any call to a faked object.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.IVoidArgumentValidationConfiguration">
<summary>
Provides configuration methods for methods that does not have a return value and
allows the use to specify validations for arguments.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.IVoidConfiguration">
<summary>
Provides configuration methods for methods that does not have a return value.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.IOutAndRefParametersConfiguration">
<summary>
Lets the developer configure output values of out and ref parameters.
</summary>
</member>
<member name="M:FakeItEasy.Configuration.IOutAndRefParametersConfiguration.AssignsOutAndRefParametersLazily(System.Func{FakeItEasy.Core.IFakeObjectCall,System.Collections.Generic.ICollection{System.Object}})">
<summary>
Specifies a function used to produce output values for out and ref parameters.
The values should appear in the same order as the out and ref parameters in the configured call.
Any non out and ref parameters are ignored.
The function will be called each time this call is made and can return different values.
</summary>
<param name="valueProducer">A function that produces the output values.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.Configuration.IVoidConfiguration.DoesNothing">
<summary>
Configures the specified call to do nothing when called.
</summary>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.Configuration.IAnyCallConfigurationWithNoReturnTypeSpecified.WithReturnType``1">
<summary>
Matches calls that has the return type specified in the generic type parameter.
</summary>
<typeparam name="TMember">The return type of the members to configure.</typeparam>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.IoC.Module">
<summary>
Manages registration of a set of components in a DictionaryContainer.
</summary>
</member>
<member name="M:FakeItEasy.IoC.Module.RegisterDependencies(FakeItEasy.IoC.DictionaryContainer)">
<summary>
Registers the components of this module.
</summary>
<param name="container">The container to register components in.</param>
</member>
<member name="T:FakeItEasy.Configuration.IRecordingCallRuleFactory">
<summary>
A factory that creates instances of the RecordingCallRuleType.
</summary>
</member>
<member name="M:FakeItEasy.Configuration.IRecordingCallRuleFactory.Create``1(FakeItEasy.Core.FakeManager,FakeItEasy.Configuration.RecordedCallRule)">
<summary>
Creates the specified fake object.
</summary>
<typeparam name="TFake">The type of the fake.</typeparam>
<param name="fakeObject">The fake object the rule belongs to.</param>
<param name="recordedRule">The rule that's being recorded.</param>
<returns>A RecordingCallRule instance.</returns>
</member>
<member name="T:FakeItEasy.Configuration.IStartConfigurationFactory">
<summary>
A factory responsible for creating start configuration for fake objects.
</summary>
</member>
<member name="M:FakeItEasy.Configuration.IStartConfigurationFactory.CreateConfiguration``1(FakeItEasy.Core.FakeManager)">
<summary>
Creates a start configuration for the specified fake object that fakes the
specified type.
</summary>
<typeparam name="TFake">The type of the fake object.</typeparam>
<param name="fakeObject">The fake object to configure.</param>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.Configuration.FakeConfigurationException">
<summary>
An exception that can be thrown when something goes wrong with the configuration
of a fake object.
</summary>
</member>
<member name="M:FakeItEasy.Configuration.FakeConfigurationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Configuration.FakeConfigurationException"/> class.
</summary>
</member>
<member name="M:FakeItEasy.Configuration.FakeConfigurationException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Configuration.FakeConfigurationException"/> class.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:FakeItEasy.Configuration.FakeConfigurationException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Configuration.FakeConfigurationException"/> class.
</summary>
<param name="message">The message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:FakeItEasy.Configuration.FakeConfigurationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Configuration.FakeConfigurationException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is null.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:FakeItEasy.Configuration.IFakeConfigurationManager">
<summary>
Handles the configuration of fake object given an expression specifying
a call on a faked object.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.IAfterCallSpecifiedConfiguration">
<summary>
Lets you set up expectations and configure repeat for the configured call.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.IRepeatConfiguration">
<summary>
Provides configuration for method calls that has a return value.
</summary>
</member>
<member name="M:FakeItEasy.Configuration.IRepeatConfiguration.NumberOfTimes(System.Int32)">
<summary>
Specifies the number of times for the configured event.
</summary>
<param name="numberOfTimesToRepeat">The number of times to repeat.</param>
</member>
<member name="T:FakeItEasy.Configuration.IAfterCallSpecifiedWithOutAndRefParametersConfiguration">
<summary>
A combination of the IAfterCallSpecifiedConfiguration and IOutAndRefParametersConfiguration
interfaces.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.IRecordingConfiguration">
<summary>
Configurations for when a configured call is recorded.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.IRecordingConfigurationWithArgumentValidation">
<summary>
Provides configuration from VisualBasic.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.RecordedCallRule">
<summary>
A call rule that has been recorded.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.RecordingCallRule`1">
<summary>
A call rule that "sits and waits" for the next call, when
that call occurs the recorded rule is added for that call.
</summary>
<typeparam name="TFake">The type of the fake.</typeparam>
</member>
<member name="T:FakeItEasy.Core.ICallCollectionAndCallMatcherAccessor">
<summary>
Provides access to a set of calls and a call matcher for these calls.
</summary>
</member>
<member name="T:FakeItEasy.Core.ICallMatcherAccessor">
<summary>
Provides access to a call matcher.
</summary>
</member>
<member name="P:FakeItEasy.Core.ICallMatcherAccessor.Matcher">
<summary>
Gets a call predicate that can be used to check if a fake object call matches
the specified constraint.
</summary>
</member>
<member name="P:FakeItEasy.Core.ICallCollectionAndCallMatcherAccessor.Calls">
<summary>
Gets the set of calls.
</summary>
</member>
<member name="T:FakeItEasy.Configuration.RuleBuilder.Factory">
<summary>
Represents a delegate that creates a configuration object from
a fake object and the rule to build.
</summary>
<param name="ruleBeingBuilt">The rule that's being built.</param>
<param name="fakeObject">The fake object the rule is for.</param>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.Core.ICallMatcher">
<summary>
Represents a predicate that matches a fake object call.
</summary>
</member>
<member name="M:FakeItEasy.Core.ICallMatcher.Matches(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Gets a value indicating whether the call matches the predicate.
</summary>
<param name="fakeObjectCall">The call to match.</param>
<returns>True if the call matches the predicate.</returns>
</member>
<member name="T:FakeItEasy.Core.ArgumentInfo">
<summary>
Represents an argument and a dummy value to use for that argument.
</summary>
</member>
<member name="M:FakeItEasy.Core.ArgumentInfo.#ctor(System.Boolean,System.Type,System.Object)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Core.ArgumentInfo"/> class.
</summary>
<param name="wasSuccessfullyResolved">A value indicating if the dummy value was successfully resolved.</param>
<param name="typeOfArgument">The type of argument.</param>
<param name="resolvedValue">The resolved value.</param>
</member>
<member name="P:FakeItEasy.Core.ArgumentInfo.WasSuccessfullyResolved">
<summary>
Gets a value indicating whether a dummy argument value was successfully
resolved.
</summary>
</member>
<member name="P:FakeItEasy.Core.ArgumentInfo.TypeOfArgument">
<summary>
Gets the type of the argument.
</summary>
</member>
<member name="P:FakeItEasy.Core.ArgumentInfo.ResolvedValue">
<summary>
Gets the resolved value.
</summary>
</member>
<member name="T:FakeItEasy.Core.ArgumentValueFormatter.RangedFormatter">
<summary>
Holds a formatter as well as the distance between a type to be formatted
and the type for which the formatted is registered.
</summary>
</member>
<member name="T:FakeItEasy.Core.CallRuleMetadata">
<summary>
Keeps track of metadata for interceptions.
</summary>
</member>
<member name="M:FakeItEasy.Core.CallRuleMetadata.HasNotBeenCalledSpecifiedNumberOfTimes">
<summary>
Gets whether the rule has been called the number of times specified or not.
</summary>
<returns>True if the rule has not been called the number of times specified.</returns>
</member>
<member name="P:FakeItEasy.Core.CallRuleMetadata.CalledNumberOfTimes">
<summary>
Gets or sets the number of times the rule has been used.
</summary>
</member>
<member name="P:FakeItEasy.Core.CallRuleMetadata.Rule">
<summary>
Gets or sets the rule this metadata object is tracking.
</summary>
</member>
<member name="T:FakeItEasy.IArgumentConstraintManager`1">
<summary>
Manages attaching of argument constraints.
</summary>
<typeparam name="T">The type of argument to constrain.</typeparam>
</member>
<member name="M:FakeItEasy.IArgumentConstraintManager`1.Matches(System.Func{`0,System.Boolean},System.Action{FakeItEasy.IOutputWriter})">
<summary>
Constrains the argument with a predicate.
</summary>
<param name="predicate">The predicate that should constrain the argument.</param>
<param name="descriptionWriter">An action that will be write a description of the constraint.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="P:FakeItEasy.IArgumentConstraintManager`1.Not">
<summary>
Inverts the logic of the matches method.
</summary>
</member>
<member name="T:FakeItEasy.Core.DefaultFakeManagerAccessor">
<summary>
Default implementation of <see cref="T:FakeItEasy.Core.IFakeManagerAccessor"/>.
</summary>
</member>
<member name="T:FakeItEasy.Core.IFakeManagerAccessor">
<summary>
Attaches a fake manager to the proxy so that intercepted
calls can be configured.
</summary>
</member>
<member name="M:FakeItEasy.Core.IFakeManagerAccessor.GetFakeManager(System.Object)">
<summary>
Gets the fake manager associated with the proxy.
</summary>
<param name="proxy">The proxy to get the manager from.</param>
<returns>A fake manager.</returns>
</member>
<member name="M:FakeItEasy.Core.IFakeManagerAccessor.TagProxy(System.Object,FakeItEasy.Core.FakeManager)">
<summary>
Tags a proxy object, so that it can accessed later by <see cref="M:FakeItEasy.Core.IFakeManagerAccessor.GetFakeManager(System.Object)"/>.
</summary>
<param name="proxy">The proxy to tag.</param>
<param name="manager">The fake manager.</param>
</member>
<member name="M:FakeItEasy.Core.DefaultFakeManagerAccessor.GetFakeManager(System.Object)">
<summary>
Gets the fake manager associated with the proxy.
</summary>
<param name="proxy">The proxy to get the manager from.</param>
<returns>A fake manager.</returns>
</member>
<member name="T:FakeItEasy.Creation.ITaggable">
<summary>
Represents an object that can be tagged with another object. When implemented
by a proxy returned from an <see cref="T:FakeItEasy.Creation.IProxyGenerator"/> FakeItEasy uses the tag
to store a reference to the <see cref="T:FakeItEasy.Core.FakeManager"/> that handles that proxy.
</summary>
</member>
<member name="P:FakeItEasy.Creation.ITaggable.Tag">
<summary>
Gets or sets the tag.
</summary>
</member>
<member name="T:FakeItEasy.Core.DefaultFakeObjectCallFormatter">
<summary>
The default implementation of the IFakeObjectCallFormatter interface.
</summary>
</member>
<member name="T:FakeItEasy.Core.IFakeObjectCallFormatter">
<summary>
Provides string formatting for fake object calls.
</summary>
</member>
<member name="M:FakeItEasy.Core.IFakeObjectCallFormatter.GetDescription(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Gets a human readable description of the specified
fake object call.
</summary>
<param name="call">The call to get a description for.</param>
<returns>A description of the call.</returns>
</member>
<member name="M:FakeItEasy.Core.DefaultFakeObjectCallFormatter.GetDescription(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Gets a human readable description of the specified
fake object call.
</summary>
<param name="call">The call to get a description for.</param>
<returns>A description of the call.</returns>
</member>
<member name="T:FakeItEasy.Core.DefaultFakeWrapperConfigurer">
<summary>
Handles configuring of fake objects to delegate all their calls to a wrapped instance.
</summary>
</member>
<member name="T:FakeItEasy.Core.IFakeWrapperConfigurer">
<summary>
Manages configuration of fake objects to wrap instances.
</summary>
</member>
<member name="M:FakeItEasy.Core.IFakeWrapperConfigurer.ConfigureFakeToWrap(System.Object,System.Object,FakeItEasy.SelfInitializedFakes.ISelfInitializingFakeRecorder)">
<summary>
Configures the specified faked object to wrap the specified instance.
</summary>
<param name="fakedObject">The faked object to configure.</param>
<param name="wrappedInstance">The instance to wrap.</param>
<param name="recorder">The recorder to use, null if no recording should be made.</param>
</member>
<member name="M:FakeItEasy.Core.DefaultFakeWrapperConfigurer.ConfigureFakeToWrap(System.Object,System.Object,FakeItEasy.SelfInitializedFakes.ISelfInitializingFakeRecorder)">
<summary>
Configures the specified faked object to wrap the specified instance.
</summary>
<param name="fakedObject">The faked object to configure.</param>
<param name="wrappedInstance">The instance to wrap.</param>
<param name="recorder">The recorder to use, null if no recording should be made.</param>
</member>
<member name="T:FakeItEasy.Core.DelegateFakeObjectContainer">
<summary>
A fake object container where delegates can be registered that are used to
resolve fake objects.
</summary>
</member>
<member name="T:FakeItEasy.Core.IFakeObjectContainer">
<summary>
A container that can create fake objects.
</summary>
</member>
<member name="T:FakeItEasy.Core.IFakeObjectConfigurator">
<summary>
Handles global configuration of fake object.
</summary>
</member>
<member name="M:FakeItEasy.Core.IFakeObjectConfigurator.ConfigureFake(System.Type,System.Object)">
<summary>
Applies base configuration to a fake object.
</summary>
<param name="typeOfFake">The type the fake object represents.</param>
<param name="fakeObject">The fake object to configure.</param>
</member>
<member name="M:FakeItEasy.Core.IFakeObjectContainer.TryCreateDummyObject(System.Type,System.Object@)">
<summary>
Creates a dummy object of the specified type using the specified arguments if it's
supported by the container, returns a value indicating if it's supported or not.
</summary>
<param name="typeOfDummy">The type of dummy object to create.</param>
<param name="fakeObject">The dummy object that was created if the method returns true.</param>
<returns>True if a dummy object can be created.</returns>
</member>
<member name="M:FakeItEasy.Core.DelegateFakeObjectContainer.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Core.DelegateFakeObjectContainer"/> class.
Creates a new instance of the DelegateFakeObjectContainer.
</summary>
</member>
<member name="M:FakeItEasy.Core.DelegateFakeObjectContainer.TryCreateDummyObject(System.Type,System.Object@)">
<summary>
Creates a fake object of the specified type using the specified arguments if it's
supported by the container, returns a value indicating if it's supported or not.
</summary>
<param name="typeOfDummy">The type of dummy object to create.</param>
<param name="fakeObject">The fake object that was created if the method returns true.</param>
<returns>True if a fake object can be created.</returns>
</member>
<member name="M:FakeItEasy.Core.DelegateFakeObjectContainer.ConfigureFake(System.Type,System.Object)">
<summary>
Configures the fake.
</summary>
<param name="typeOfFake">The type of fake.</param>
<param name="fakeObject">The fake object.</param>
</member>
<member name="M:FakeItEasy.Core.DelegateFakeObjectContainer.Register``1(System.Func{``0})">
<summary>
Registers the specified fake delegate.
</summary>
<typeparam name="T">The type of the return value of the method that <paramref name="fakeDelegate"/> encapsulates.</typeparam>
<param name="fakeDelegate">The fake delegate.</param>
</member>
<member name="T:FakeItEasy.Core.DynamicContainer">
<summary>
A IFakeObjectContainer implementation that uses MEF to load IFakeDefinitions and
IFakeConfigurations.
</summary>
</member>
<member name="M:FakeItEasy.Core.DynamicContainer.#ctor(System.Collections.Generic.IEnumerable{FakeItEasy.IDummyDefinition},System.Collections.Generic.IEnumerable{FakeItEasy.IFakeConfigurator})">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Core.DynamicContainer"/> class.
</summary>
<param name="dummyDefinitions">The dummy definitions.</param>
<param name="fakeConfigurators">The fake configurators.</param>
</member>
<member name="M:FakeItEasy.Core.DynamicContainer.TryCreateDummyObject(System.Type,System.Object@)">
<summary>
Creates a fake object of the specified type using the specified arguments if it's
supported by the container, returns a value indicating if it's supported or not.
</summary>
<param name="typeOfDummy">The type of fake object to create.</param>
<param name="fakeObject">The fake object that was created if the method returns true.</param>
<returns>True if a fake object can be created.</returns>
</member>
<member name="M:FakeItEasy.Core.DynamicContainer.ConfigureFake(System.Type,System.Object)">
<summary>
Applies base configuration to a fake object.
</summary>
<param name="typeOfFake">The type the fake object represents.</param>
<param name="fakeObject">The fake object to configure.</param>
</member>
<member name="T:FakeItEasy.Core.FakeCreationException">
<summary>
An exception that is thrown when there was an error creating a fake object.
</summary>
</member>
<member name="M:FakeItEasy.Core.FakeCreationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Core.FakeCreationException"/> class.
</summary>
</member>
<member name="M:FakeItEasy.Core.FakeCreationException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Core.FakeCreationException"/> class.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:FakeItEasy.Core.FakeCreationException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Core.FakeCreationException"/> class.
</summary>
<param name="message">The message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:FakeItEasy.Core.FakeCreationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Core.FakeCreationException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is null.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:FakeItEasy.Core.FakeManager">
<content>Auto fake property rule.</content>
<summary>
The central point in the API for proxied fake objects handles interception
of fake object calls by using a set of rules. User defined rules can be inserted
by using the AddRule-method.
</summary>
<content>Event rule.</content>
<content>Object member rule.</content>
<content>Property behavior rule.</content>
<content>Property setter rule.</content>
</member>
<member name="M:FakeItEasy.Core.FakeManager.#ctor(System.Type,System.Object)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Core.FakeManager"/> class.
</summary>
<param name="fakeObjectType">The faked type.</param>
<param name="proxy">The faked proxy object.</param>
</member>
<member name="M:FakeItEasy.Core.FakeManager.AddRuleFirst(FakeItEasy.Core.IFakeObjectCallRule)">
<summary>
Adds a call rule to the fake object.
</summary>
<param name="rule">The rule to add.</param>
</member>
<member name="M:FakeItEasy.Core.FakeManager.AddRuleLast(FakeItEasy.Core.IFakeObjectCallRule)">
<summary>
Adds a call rule last in the list of user rules, meaning it has the lowest priority possible.
</summary>
<param name="rule">The rule to add.</param>
</member>
<member name="M:FakeItEasy.Core.FakeManager.RemoveRule(FakeItEasy.Core.IFakeObjectCallRule)">
<summary>
Removes the specified rule for the fake object.
</summary>
<param name="rule">The rule to remove.</param>
</member>
<member name="M:FakeItEasy.Core.FakeManager.AddInterceptionListener(FakeItEasy.Core.IInterceptionListener)">
<summary>
Adds an interception listener to the manager.
</summary>
<param name="listener">The listener to add.</param>
</member>
<member name="M:FakeItEasy.Core.FakeManager.ClearUserRules">
<summary>
Removes any specified user rules.
</summary>
</member>
<member name="P:FakeItEasy.Core.FakeManager.Object">
<summary>
Gets the faked proxy object.
</summary>
</member>
<member name="P:FakeItEasy.Core.FakeManager.FakeObjectType">
<summary>
Gets the faked type.
</summary>
</member>
<member name="P:FakeItEasy.Core.FakeManager.Rules">
<summary>
Gets the interceptions that are currently registered with the fake object.
</summary>
</member>
<member name="P:FakeItEasy.Core.FakeManager.RecordedCallsInScope">
<summary>
Gets a collection of all the calls made to the fake object within the current scope.
</summary>
</member>
<member name="T:FakeItEasy.Core.FakeManager.Factory">
<summary>
A delegate responsible for creating FakeObject instances.
</summary>
<param name="fakeObjectType">The faked type.</param>
<param name="proxy">The faked proxy object.</param>
<returns>An instance of <see cref="T:FakeItEasy.Core.FakeManager"/>.</returns>
</member>
<member name="T:FakeItEasy.Core.IInterceptedFakeObjectCall">
<summary>
Represents a call to a fake object at interception time.
</summary>
</member>
<member name="T:FakeItEasy.Core.IWritableFakeObjectCall">
<summary>
Represents a fake object call that can be edited.
</summary>
</member>
<member name="T:FakeItEasy.Core.IFakeObjectCall">
<summary>
Represents a call to a fake object.
</summary>
</member>
<member name="P:FakeItEasy.Core.IFakeObjectCall.Method">
<summary>
Gets the method that's called.
</summary>
</member>
<member name="P:FakeItEasy.Core.IFakeObjectCall.Arguments">
<summary>
Gets the arguments used in the call.
</summary>
</member>
<member name="P:FakeItEasy.Core.IFakeObjectCall.FakedObject">
<summary>
Gets the faked object the call is performed on.
</summary>
</member>
<member name="M:FakeItEasy.Core.IWritableFakeObjectCall.SetReturnValue(System.Object)">
<summary>
Sets the return value of the call.
</summary>
<param name="value">The return value to set.</param>
</member>
<member name="M:FakeItEasy.Core.IWritableFakeObjectCall.CallBaseMethod">
<summary>
Calls the base method of the faked type.
</summary>
</member>
<member name="M:FakeItEasy.Core.IWritableFakeObjectCall.SetArgumentValue(System.Int32,System.Object)">
<summary>
Sets the value of the argument at the specified index in the parameters list.
</summary>
<param name="index">The index of the argument to set the value of.</param>
<param name="value">The value to set to the argument.</param>
</member>
<member name="M:FakeItEasy.Core.IWritableFakeObjectCall.AsReadOnly">
<summary>
Freezes the call so that it can no longer be modified.
</summary>
<returns>A completed fake object call.</returns>
</member>
<member name="M:FakeItEasy.Core.IInterceptedFakeObjectCall.DoNotRecordCall">
<summary>
Sets that the call should not be recorded by the fake manager.
</summary>
</member>
<member name="M:FakeItEasy.Core.FakeManager.EventRule.TryPreserveStackTrace(System.Exception)">
<summary>
Attempts to preserve the stack trace of an existing exception when rethrown via <c>throw</c> or <c>throw ex</c>.
</summary>
<remarks>Nicked from
http://weblogs.asp.net/fmarguerie/archive/2008/01/02/rethrowing-exceptions-and-preserving-the-full-call-stack-trace.aspx.
If reduced trust context (for example) precludes
invoking internal members on <see cref="T:System.Exception"/>, the stack trace will not be preserved.
</remarks>
<param name="exception">The exception whose stack trace needs preserving.</param>
</member>
<member name="T:FakeItEasy.Core.FakeScope">
<summary>
Represents a scope for fake objects, calls configured within a scope
are only valid within that scope. Only calls made within a scope
are accessible from within a scope so for example asserts will only
assert on those calls done within the scope.
</summary>
</member>
<member name="T:FakeItEasy.Core.IFakeScope">
<summary>
Provides access to all calls made to fake objects within a scope.
Scopes calls so that only calls made within the scope are visible.
</summary>
</member>
<member name="M:FakeItEasy.Core.FakeScope.Create">
<summary>
Creates a new scope and sets it as the current scope.
</summary>
<returns>The created scope.</returns>
</member>
<member name="M:FakeItEasy.Core.FakeScope.Create(FakeItEasy.Core.IFakeObjectContainer)">
<summary>
Creates a new scope and sets it as the current scope, using the specified
container as the container for the new scope.
</summary>
<param name="container">The container to use for the new scope.</param>
<returns>The created scope.</returns>
</member>
<member name="M:FakeItEasy.Core.FakeScope.Dispose">
<summary>
Closes the scope.
</summary>
</member>
<member name="M:FakeItEasy.Core.FakeScope.AddInterceptedCall(FakeItEasy.Core.FakeManager,FakeItEasy.Core.ICompletedFakeObjectCall)">
<summary>
Adds an intercepted call to the current scope.
</summary>
<param name="fakeManager">The fake object.</param>
<param name="call">The call that is intercepted.</param>
</member>
<member name="M:FakeItEasy.Core.FakeScope.AddRuleFirst(FakeItEasy.Core.FakeManager,FakeItEasy.Core.CallRuleMetadata)">
<summary>
Adds a fake object call to the current scope.
</summary>
<param name="fakeManager">The fake object.</param>
<param name="rule">The rule to add.</param>
</member>
<member name="T:FakeItEasy.Core.IInterceptionListener">
<summary>
Represents a listener for fake object calls, can be plugged into a
FakeManager instance to listen to all intercepted calls.
</summary>
<remarks>The OnBeforeCallIntercepted method will be invoked before the OnBeforeCallIntercepted method of any
previously added listener. The OnAfterCallIntercepted method will be invoked after the OnAfterCallIntercepted
method of any previously added listener.</remarks>
</member>
<member name="M:FakeItEasy.Core.IInterceptionListener.OnBeforeCallIntercepted(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Called when the interception begins but before any call rules
has been applied.
</summary>
<param name="interceptedCall">The intercepted call.</param>
</member>
<member name="M:FakeItEasy.Core.IInterceptionListener.OnAfterCallIntercepted(FakeItEasy.Core.ICompletedFakeObjectCall,FakeItEasy.Core.IFakeObjectCallRule)">
<summary>
Called when the interception has been completed and rules has been
applied.
</summary>
<param name="interceptedCall">The intercepted call.</param>
<param name="ruleThatWasApplied">The rule that was applied to the call.</param>
</member>
<member name="T:FakeItEasy.Creation.IProxyGenerator">
<summary>
An interface to be implemented by classes that can generate proxies for FakeItEasy.
</summary>
</member>
<member name="M:FakeItEasy.Creation.IProxyGenerator.GenerateProxy(System.Type,System.Collections.Generic.IEnumerable{System.Type},System.Collections.Generic.IEnumerable{System.Object},System.Collections.Generic.IEnumerable{System.Reflection.Emit.CustomAttributeBuilder},FakeItEasy.Core.IFakeCallProcessorProvider)">
<summary>
Generates a proxy of the specified type and returns a result object containing information
about the success of the generation and the proxy if it was generated.
</summary>
<param name="typeOfProxy">The type of proxy to generate.</param>
<param name="additionalInterfacesToImplement">Interfaces to be implemented by the proxy.</param>
<param name="argumentsForConstructor">Arguments to pass to the constructor of the type in <paramref name="typeOfProxy" />.</param>
<param name="customAttributeBuilders">The custom attribute builders.</param>
<param name="fakeCallProcessorProvider">The call processor provider.</param>
<returns>A result containing the generated proxy.</returns>
</member>
<member name="M:FakeItEasy.Creation.IProxyGenerator.GenerateProxy(System.Type,System.Collections.Generic.IEnumerable{System.Type},System.Collections.Generic.IEnumerable{System.Object},FakeItEasy.Core.IFakeCallProcessorProvider)">
<summary>
Generates a proxy of the specified type and returns a result object containing information
about the success of the generation and the proxy if it was generated.
</summary>
<param name="typeOfProxy">The type of proxy to generate.</param>
<param name="additionalInterfacesToImplement">Interfaces to be implemented by the proxy.</param>
<param name="argumentsForConstructor">Arguments to pass to the constructor of the type in <paramref name="typeOfProxy" />.</param>
<param name="fakeCallProcessorProvider">The call processor provider.</param>
<returns>A result containing the generated proxy.</returns>
</member>
<member name="M:FakeItEasy.Creation.IProxyGenerator.MethodCanBeInterceptedOnInstance(System.Reflection.MethodInfo,System.Object,System.String@)">
<summary>
Gets a value indicating whether the specified member can be intercepted by the proxy generator.
</summary>
<param name="method">The member to test.</param>
<param name="callTarget">The instance the method will be called on.</param>
<param name="failReason">The reason the method can not be intercepted.</param>
<returns>True if the member can be intercepted.</returns>
</member>
<member name="T:FakeItEasy.Core.ICompletedFakeObjectCall">
<summary>
Represents a completed call to a fake object.
</summary>
</member>
<member name="P:FakeItEasy.Core.ICompletedFakeObjectCall.ReturnValue">
<summary>
Gets the value set to be returned from the call.
</summary>
</member>
<member name="T:FakeItEasy.IOutputWriter">
<summary>
Represents a text writer that writes to the output.
</summary>
</member>
<member name="M:FakeItEasy.IOutputWriter.Write(System.String)">
<summary>
Writes the specified value to the output.
</summary>
<param name="value">The value to write.</param>
<returns>The writer for method chaining.</returns>
</member>
<member name="M:FakeItEasy.IOutputWriter.WriteArgumentValue(System.Object)">
<summary>
Formats the specified argument value as a string and writes
it to the output.
</summary>
<param name="value">The value to write.</param>
<returns>The writer for method chaining.</returns>
</member>
<member name="M:FakeItEasy.IOutputWriter.Indent">
<summary>
Indents the writer.
</summary>
<returns>A disposable that will unindent the writer when disposed.</returns>
</member>
<member name="T:FakeItEasy.Core.TypeCatalogueInstanceProvider">
<summary>
Provides instances from type catalogues.
</summary>
</member>
<member name="M:FakeItEasy.Core.TypeCatalogueInstanceProvider.InstantiateAllOfType``1">
<summary>
Gets an instance per type in the catalogue that is a descendant
of the specified type.
</summary>
<typeparam name="T">The type of instances to get.</typeparam>
<returns>A sequence of instances of the specified type.</returns>
</member>
<member name="T:FakeItEasy.Core.MethodInfoManager">
<summary>
Handles comparisons of instances of <see cref="T:System.Reflection.MethodInfo"/>.
</summary>
</member>
<member name="M:FakeItEasy.Core.MethodInfoManager.WillInvokeSameMethodOnTarget(System.Type,System.Reflection.MethodInfo,System.Reflection.MethodInfo)">
<summary>
Gets a value indicating whether the two instances of <see cref="T:System.Reflection.MethodInfo"/> would invoke the same method
if invoked on an instance of the target type.
</summary>
<param name="target">The type of target for invocation.</param>
<param name="first">The first <see cref="T:System.Reflection.MethodInfo"/>.</param>
<param name="second">The second <see cref="T:System.Reflection.MethodInfo"/>.</param>
<returns>True if the same method would be invoked.</returns>
</member>
<member name="T:FakeItEasy.Core.NullFakeObjectContainer">
<summary>
A null implementation for the IFakeObjectContainer interface.
</summary>
</member>
<member name="M:FakeItEasy.Core.NullFakeObjectContainer.TryCreateDummyObject(System.Type,System.Object@)">
<summary>
Always returns false and sets the fakeObject to null.
</summary>
<param name="typeOfDummy">The type of dummy object to create.</param>
<param name="fakeObject">Output variable for the fake object that will always be set to null.</param>
<returns>Always return false.</returns>
</member>
<member name="M:FakeItEasy.Core.NullFakeObjectContainer.ConfigureFake(System.Type,System.Object)">
<summary>
Applies base configuration to a fake object.
</summary>
<param name="typeOfFake">The type the fake object represents.</param>
<param name="fakeObject">The fake object to configure.</param>
</member>
<member name="T:FakeItEasy.Core.WrappedObjectRule">
<summary>
A call rule that applies to any call and just delegates the
call to the wrapped object.
</summary>
</member>
<member name="M:FakeItEasy.Core.WrappedObjectRule.#ctor(System.Object)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Core.WrappedObjectRule"/> class.
Creates a new instance.
</summary>
<param name="wrappedInstance">
The object to wrap.
</param>
</member>
<member name="M:FakeItEasy.Core.WrappedObjectRule.IsApplicableTo(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Gets whether this interceptor is applicable to the specified
call, if true is returned the Apply-method of the interceptor will
be called.
</summary>
<param name="fakeObjectCall">The call to check for applicability.</param>
<returns>True if the interceptor is applicable.</returns>
</member>
<member name="M:FakeItEasy.Core.WrappedObjectRule.Apply(FakeItEasy.Core.IInterceptedFakeObjectCall)">
<summary>
Applies an action to the call, might set a return value or throw
an exception.
</summary>
<param name="fakeObjectCall">The call to apply the interceptor to.</param>
</member>
<member name="P:FakeItEasy.Core.WrappedObjectRule.NumberOfTimesToCall">
<summary>
Gets the number of times this call rule is valid, if it's set
to null its infinitely valid.
</summary>
<value></value>
</member>
<member name="T:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter">
<summary>
An adapter that adapts an <see cref="T:Castle.DynamicProxy.IInvocation"/> to a <see cref="T:FakeItEasy.Core.IFakeObjectCall"/>.
</summary>
</member>
<member name="M:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.#ctor(Castle.DynamicProxy.IInvocation)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter"/> class.
</summary>
<param name="invocation">The invocation.</param>
</member>
<member name="M:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.AsReadOnly">
<summary>
Freezes the call so that it can no longer be modified.
</summary>
<returns>A completed fake object call.</returns>
</member>
<member name="M:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.CallBaseMethod">
<summary>
Calls the base method, should not be used with interface types.
</summary>
</member>
<member name="M:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.SetArgumentValue(System.Int32,System.Object)">
<summary>
Sets the specified value to the argument at the specified index.
</summary>
<param name="index">The index of the argument to set the value to.</param>
<param name="value">The value to set to the argument.</param>
</member>
<member name="M:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.SetReturnValue(System.Object)">
<summary>
Sets the return value of the call.
</summary>
<param name="returnValue">The return value.</param>
</member>
<member name="M:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.ToString">
<summary>
Returns a description of the call.
</summary>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.Description">
<summary>
Gets a human readable description of the call.
</summary>
<value></value>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.ReturnValue">
<summary>
Gets the value set to be returned from the call.
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.Method">
<summary>
Gets the method that's called.
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.Arguments">
<summary>
Gets the arguments used in the call.
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.CastleInvocationCallAdapter.FakedObject">
<summary>
Gets the faked object the call is performed on.
</summary>
</member>
<member name="T:FakeItEasy.Creation.CastleDynamicProxy.DynamicProxyResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.DynamicProxyResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.DynamicProxyResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.DynamicProxyResources.ArgumentsForConstructorDoesNotMatchAnyConstructorMessage">
<summary>
Looks up a localized string similar to No constructor matches the passed arguments for constructor..
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.DynamicProxyResources.ArgumentsForConstructorOnInterfaceTypeMessage">
<summary>
Looks up a localized string similar to Arguments for constructor specified for interface type..
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.DynamicProxyResources.ProxyIsSealedTypeMessage">
<summary>
Looks up a localized string similar to The type of proxy "{0}" is sealed..
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.DynamicProxyResources.ProxyIsValueTypeMessage">
<summary>
Looks up a localized string similar to The type of proxy must be an interface or a class but it was {0}..
</summary>
</member>
<member name="P:FakeItEasy.Creation.CastleDynamicProxy.DynamicProxyResources.ProxyTypeWithNoDefaultConstructorMessage">
<summary>
Looks up a localized string similar to No usable default constructor was found on the type {0}..
</summary>
</member>
<member name="T:FakeItEasy.Creation.DefaultFakeAndDummyManager">
<summary>
The default implementation of the IFakeAndDummyManager interface.
</summary>
</member>
<member name="T:FakeItEasy.Creation.IFakeAndDummyManager">
<summary>
Handles the creation of fake and dummy objects.
</summary>
</member>
<member name="M:FakeItEasy.Creation.IFakeAndDummyManager.CreateDummy(System.Type)">
<summary>
Creates a dummy of the specified type.
</summary>
<param name="typeOfDummy">The type of dummy to create.</param>
<returns>The created dummy.</returns>
<exception cref="T:FakeItEasy.Core.FakeCreationException">The current IProxyGenerator is not able to generate a fake of the specified type and
the current IFakeObjectContainer does not contain the specified type.</exception>
</member>
<member name="M:FakeItEasy.Creation.IFakeAndDummyManager.CreateFake(System.Type,FakeItEasy.Creation.FakeOptions)">
<summary>
Creates a fake object of the specified type.
</summary>
<param name="typeOfFake">The type of fake object to generate.</param>
<param name="options">Options for building the fake object.</param>
<returns>A fake object.</returns>
<exception cref="T:FakeItEasy.Core.FakeCreationException">The current IProxyGenerator is not able to generate a fake of the specified type.</exception>
</member>
<member name="M:FakeItEasy.Creation.IFakeAndDummyManager.TryCreateDummy(System.Type,System.Object@)">
<summary>
Tries to create a dummy of the specified type.
</summary>
<param name="typeOfDummy">The type of dummy to create.</param>
<param name="result">Outputs the result dummy when creation is successful.</param>
<returns>A value indicating whether the creation was successful.</returns>
</member>
<member name="M:FakeItEasy.Creation.IFakeAndDummyManager.TryCreateFake(System.Type,FakeItEasy.Creation.FakeOptions,System.Object@)">
<summary>
Tries to create a fake object of the specified type.
</summary>
<param name="typeOfFake">The type of fake to create.</param>
<param name="options">Options for the creation of the fake.</param>
<param name="result">The created fake object when creation is successful.</param>
<returns>A value indicating whether the creation was successful.</returns>
</member>
<member name="T:FakeItEasy.Creation.DefaultFakeCreatorFacade">
<summary>
Default implementation of the IFakeCreator-interface.
</summary>
</member>
<member name="T:FakeItEasy.Creation.IFakeCreatorFacade">
<summary>
A facade used by the public API for testability.
</summary>
</member>
<member name="M:FakeItEasy.Creation.IFakeCreatorFacade.CreateFake``1(System.Action{FakeItEasy.Creation.IFakeOptionsBuilder{``0}})">
<summary>
Creates a fake object of the specified type.
</summary>
<typeparam name="T">The type of fake to create.</typeparam>
<param name="options">Options for the created fake object.</param>
<returns>The created fake object.</returns>
<exception cref="T:FakeItEasy.Core.FakeCreationException">Was unable to generate the fake in the current configuration.</exception>
</member>
<member name="M:FakeItEasy.Creation.IFakeCreatorFacade.CreateDummy``1">
<summary>
Creates a dummy object, this can be a fake object or an object resolved
from the current IFakeObjectContainer.
</summary>
<typeparam name="T">The type of dummy to create.</typeparam>
<returns>The created dummy.</returns>
<exception cref="T:FakeItEasy.Core.FakeCreationException">Was unable to generate the fake in the current configuration and
no dummy was registered in the container for the specified type..</exception>
</member>
<member name="M:FakeItEasy.Creation.IFakeCreatorFacade.CollectionOfFake``1(System.Int32)">
<summary>
Creates a collection of fakes of the specified type.
</summary>
<typeparam name="T">The type of fakes to create.</typeparam>
<param name="numberOfFakes">The number of fakes in the collection.</param>
<returns>A collection of fake objects of the specified type.</returns>
</member>
<member name="M:FakeItEasy.Creation.DefaultFakeCreatorFacade.#ctor(FakeItEasy.Creation.IFakeAndDummyManager)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Creation.DefaultFakeCreatorFacade"/> class.
</summary>
<param name="fakeAndDummyManager">The fake and dummy manager.</param>
</member>
<member name="M:FakeItEasy.Creation.DefaultFakeCreatorFacade.CreateFake``1(System.Action{FakeItEasy.Creation.IFakeOptionsBuilder{``0}})">
<summary>
Creates a fake object of the specified type.
</summary>
<typeparam name="T">The type of fake to create.</typeparam>
<param name="options">Options for the created fake object.</param>
<returns>The created fake object.</returns>
<exception cref="T:FakeItEasy.Core.FakeCreationException">Was unable to generate the fake in the current configuration.</exception>
</member>
<member name="M:FakeItEasy.Creation.DefaultFakeCreatorFacade.CollectionOfFake``1(System.Int32)">
<summary>
Creates a collection of fakes of the specified type.
</summary>
<typeparam name="T">The type of fakes to create.</typeparam>
<param name="numberOfFakes">The number of fakes in the collection.</param>
<returns>
A collection of fake objects of the specified type.
</returns>
</member>
<member name="M:FakeItEasy.Creation.DefaultFakeCreatorFacade.CreateDummy``1">
<summary>
Creates a dummy object, this can be a fake object or an object resolved
from the current IFakeObjectContainer.
</summary>
<typeparam name="T">The type of dummy to create.</typeparam>
<returns>The created dummy.</returns>
<exception cref="T:FakeItEasy.Core.FakeCreationException">Was unable to generate the fake in the current configuration and
no dummy was registered in the container for the specified type..</exception>
</member>
<member name="T:FakeItEasy.Creation.IFakeOptionsBuilderForWrappers`1">
<summary>
Provides options for fake wrappers.
</summary>
<typeparam name="T">The type of the fake object generated.</typeparam>
</member>
<member name="T:FakeItEasy.Creation.IFakeOptionsBuilder`1">
<summary>
Provides options for generating fake object.
</summary>
<typeparam name="T">The type of fake object generated.</typeparam>
</member>
<member name="M:FakeItEasy.Creation.IFakeOptionsBuilder`1.WithArgumentsForConstructor(System.Collections.Generic.IEnumerable{System.Object})">
<summary>
Specifies arguments for the constructor of the faked class.
</summary>
<param name="argumentsForConstructor">The arguments to pass to the constructor of the faked class.</param>
<returns>Options object.</returns>
</member>
<member name="M:FakeItEasy.Creation.IFakeOptionsBuilder`1.WithArgumentsForConstructor(System.Linq.Expressions.Expression{System.Func{`0}})">
<summary>
Specifies arguments for the constructor of the faked class by giving an expression with the call to
the desired constructor using the arguments to be passed to the constructor.
</summary>
<param name="constructorCall">The constructor call to use when creating a class proxy.</param>
<returns>Options object.</returns>
</member>
<member name="M:FakeItEasy.Creation.IFakeOptionsBuilder`1.Wrapping(`0)">
<summary>
Specifies that the fake should delegate calls to the specified instance.
</summary>
<param name="wrappedInstance">The object to delegate calls to.</param>
<returns>Options object.</returns>
</member>
<member name="M:FakeItEasy.Creation.IFakeOptionsBuilder`1.WithAdditionalAttributes(System.Collections.Generic.IEnumerable{System.Reflection.Emit.CustomAttributeBuilder})">
<summary>
Specifies that the fake should be created with these additional attributes.
</summary>
<param name="customAttributeBuilders">The attributes to build into the proxy.</param>
<returns>Options object.</returns>
</member>
<member name="M:FakeItEasy.Creation.IFakeOptionsBuilder`1.Implements(System.Type)">
<summary>
Sets up the fake to implement the specified interface in addition to the
originally faked class.
</summary>
<param name="interfaceType">The type of interface to implement.</param>
<returns>Options object.</returns>
<exception cref="T:System.ArgumentException">The specified type is not an interface.</exception>
<exception cref="T:System.ArgumentNullException">The specified type is null.</exception>
</member>
<member name="M:FakeItEasy.Creation.IFakeOptionsBuilder`1.OnFakeCreated(System.Action{`0})">
<summary>
Specifies an action that should be run over the fake object
once it's created.
</summary>
<param name="action">An action to perform.</param>
<returns>Options object.</returns>
</member>
<member name="M:FakeItEasy.Creation.IFakeOptionsBuilderForWrappers`1.RecordedBy(FakeItEasy.SelfInitializedFakes.ISelfInitializingFakeRecorder)">
<summary>
Specifies a fake recorder to use.
</summary>
<param name="recorder">The recorder to use.</param>
<returns>Options object.</returns>
</member>
<member name="M:FakeItEasy.Creation.DummyValueCreationSession.#ctor(FakeItEasy.Core.IFakeObjectContainer,FakeItEasy.Creation.IFakeObjectCreator)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Creation.DummyValueCreationSession"/> class.
</summary>
<param name="container">The container.</param>
<param name="fakeObjectCreator">The fake object creator.</param>
</member>
<member name="T:FakeItEasy.Creation.ProxyGeneratorResult">
<summary>
Contains the result of a call to TryCreateProxy of IProxyGenerator.
</summary>
</member>
<member name="M:FakeItEasy.Creation.ProxyGeneratorResult.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Creation.ProxyGeneratorResult"/> class.
Creates a new instance representing a failed proxy
generation attempt.
</summary>
<param name="reasonForFailure">
The reason the proxy generation failed.
</param>
</member>
<member name="M:FakeItEasy.Creation.ProxyGeneratorResult.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Creation.ProxyGeneratorResult"/> class.
Creates a new instance representing a failed proxy
generation attempt due to an exception being caught.
</summary>
<param name="reasonForFailure">
The reason the proxy generation failed.
</param>
<param name="exception">
The exception thrown from the creation attempt.
</param>
</member>
<member name="M:FakeItEasy.Creation.ProxyGeneratorResult.#ctor(System.Object)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Creation.ProxyGeneratorResult"/> class.
Creates a new instance representing a successful proxy
generation.
</summary>
<param name="generatedProxy">
The proxy that was generated.
</param>
</member>
<member name="P:FakeItEasy.Creation.ProxyGeneratorResult.ProxyWasSuccessfullyGenerated">
<summary>
Gets a value indicating whether the proxy was successfully created.
</summary>
</member>
<member name="P:FakeItEasy.Creation.ProxyGeneratorResult.GeneratedProxy">
<summary>
Gets the generated proxy when it was successfully created.
</summary>
</member>
<member name="P:FakeItEasy.Creation.ProxyGeneratorResult.ReasonForFailure">
<summary>
Gets the reason for failure when the generation was not successful.
</summary>
</member>
<member name="T:FakeItEasy.Expressions.ICallExpressionParser">
<summary>
Represents a class that can parse a lambda expression
that represents a method or property call.
</summary>
</member>
<member name="M:FakeItEasy.Expressions.ICallExpressionParser.Parse(System.Linq.Expressions.LambdaExpression)">
<summary>
Parses the specified expression.
</summary>
<param name="callExpression">The expression to parse.</param>
<returns>The parsed expression.</returns>
</member>
<member name="T:FakeItEasy.Expressions.ExpressionCallMatcher">
<summary>
Handles the matching of fake object calls to expressions.
</summary>
</member>
<member name="M:FakeItEasy.Expressions.ExpressionCallMatcher.#ctor(System.Linq.Expressions.LambdaExpression,FakeItEasy.Expressions.ExpressionArgumentConstraintFactory,FakeItEasy.Core.MethodInfoManager,FakeItEasy.Expressions.ICallExpressionParser)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Expressions.ExpressionCallMatcher"/> class.
</summary>
<param name="callSpecification">The call specification.</param>
<param name="constraintFactory">The constraint factory.</param>
<param name="methodInfoManager">The method info manager to use.</param>
<param name="callExpressionParser">A parser to use to parse call expressions.</param>
</member>
<member name="M:FakeItEasy.Expressions.ExpressionCallMatcher.Matches(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Matches the specified call against the expression.
</summary>
<param name="call">The call to match.</param>
<returns>True if the call is matched by the expression.</returns>
</member>
<member name="M:FakeItEasy.Expressions.ExpressionCallMatcher.ToString">
<summary>
Gets a description of the call.
</summary>
<returns>Description of the call.</returns>
</member>
<member name="P:FakeItEasy.Expressions.ExpressionCallMatcher.DescriptionOfMatchingCall">
<summary>
Gets a human readable description of calls that will be matched by this
matcher.
</summary>
</member>
<member name="T:FakeItEasy.Expressions.ExpressionCallRule">
<summary>
An implementation of the <see cref="T:FakeItEasy.Core.IFakeObjectCallRule"/> interface that uses
expressions for evaluating if the rule is applicable to a specific call.
</summary>
</member>
<member name="M:FakeItEasy.Expressions.ExpressionCallRule.#ctor(FakeItEasy.Expressions.ExpressionCallMatcher)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.Expressions.ExpressionCallRule"/> class.
</summary>
<param name="expressionMatcher">The expression matcher to use.</param>
</member>
<member name="M:FakeItEasy.Expressions.ExpressionCallRule.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="T:FakeItEasy.Expressions.ExpressionCallRule.Factory">
<summary>
Handles the instantiation of ExpressionCallRule instance.
</summary>
<param name="callSpecification">An expression specifying the call.</param>
<returns>A rule instance.</returns>
</member>
<member name="T:FakeItEasy.Expressions.ExpressionParser">
<summary>
Manages breaking call specification expression into their various parts.
</summary>
</member>
<member name="T:FakeItEasy.Expressions.IExpressionParser">
<summary>
Manages breaking call specification expression into their various parts.
</summary>
</member>
<member name="M:FakeItEasy.Expressions.IExpressionParser.GetFakeManagerCallIsMadeOn(System.Linq.Expressions.LambdaExpression)">
<summary>
Gets the fake object an expression is called on.
</summary>
<param name="fakeObjectCall">The call expression.</param>
<returns>The FakeManager instance that manages the faked object the call is made on.</returns>
<exception cref="T:System.ArgumentNullException">The fakeObjectCall is null.</exception>
<exception cref="T:System.ArgumentException">The specified expression is not an expression where a call is made to a faked object.</exception>
</member>
<member name="M:FakeItEasy.Expressions.ExpressionParser.GetFakeManagerCallIsMadeOn(System.Linq.Expressions.LambdaExpression)">
<summary>
Gets the fake object an expression is called on.
</summary>
<param name="fakeObjectCall">The call expression.</param>
<returns>A FakeObject.</returns>
<exception cref="T:System.ArgumentNullException">The fakeObjectCall is null.</exception>
<exception cref="T:System.ArgumentException">The specified expression is not an expression where a call is made to a faked object.</exception>
</member>
<member name="T:FakeItEasy.ExtensionSyntax.Full.ObjectExtensions">
<summary>
Provides extension methods for configuring and asserting on faked objects
without going through the static methods of the Fake-class.
</summary>
</member>
<member name="M:FakeItEasy.ExtensionSyntax.Full.ObjectExtensions.CallsTo``2(``0,System.Linq.Expressions.Expression{System.Func{``0,``1}})">
<summary>
Configures the behavior of the fake object when a call that matches the specified
call happens.
</summary>
<typeparam name="TFake">The type of fake object to configure.</typeparam>
<typeparam name="TMember">The type of the return value of the member.</typeparam>
<param name="fakedObject">The faked object to configure.</param>
<param name="callSpecification">An expression that specifies the calls to configure.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.ExtensionSyntax.Full.ObjectExtensions.CallsTo``1(``0,System.Linq.Expressions.Expression{System.Action{``0}})">
<summary>
Configures the behavior of the fake object when a call that matches the specified
call happens.
</summary>
<param name="fakedObject">The faked object to configure.</param>
<typeparam name="TFake">The type of fake object to configure.</typeparam>
<param name="callSpecification">An expression that specifies the calls to configure.</param>
<returns>A configuration object.</returns>
</member>
<member name="M:FakeItEasy.ExtensionSyntax.Full.ObjectExtensions.AnyCall``1(``0)">
<summary>
Configures the behavior of the fake object when a call is made to any method on the
object.
</summary>
<typeparam name="TFake">The type of the fake.</typeparam>
<param name="fakedObject">The faked object.</param>
<returns>A configuration object.</returns>
</member>
<member name="T:FakeItEasy.ExtensionSyntax.ObjectExtensions">
<summary>
Provides an extension method for configuring fake objects.
</summary>
</member>
<member name="M:FakeItEasy.ExtensionSyntax.ObjectExtensions.Configure``1(``0)">
<summary>
Gets an object that provides a fluent interface syntax for configuring
the fake object.
</summary>
<typeparam name="TFake">The type of the fake object.</typeparam>
<param name="fakedObject">The fake object to configure.</param>
<returns>A configuration object.</returns>
<exception cref="T:System.ArgumentNullException">The fakedObject was null.</exception>
<exception cref="T:System.ArgumentException">The object passed in is not a faked object.</exception>
</member>
<member name="T:FakeItEasy.FakeAttribute">
<summary>
Used to tag fields and properties that will be initialized through the
Fake.Initialize-method.
</summary>
</member>
<member name="T:FakeItEasy.IoC.DictionaryContainer">
<summary>
A simple implementation of an IoC container.
</summary>
</member>
<member name="F:FakeItEasy.IoC.DictionaryContainer.registeredServices">
<summary>
The dictionary that stores the registered services.
</summary>
</member>
<member name="M:FakeItEasy.IoC.DictionaryContainer.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.IoC.DictionaryContainer"/> class.
</summary>
</member>
<member name="M:FakeItEasy.IoC.DictionaryContainer.Resolve(System.Type)">
<summary>
Resolves an instance of the specified component type.
</summary>
<param name="componentType">Type of the component.</param>
<returns>An instance of the component type.</returns>
</member>
<member name="M:FakeItEasy.IoC.DictionaryContainer.Register``1(System.Func{FakeItEasy.IoC.DictionaryContainer,``0})">
<summary>
Registers the specified resolver.
</summary>
<typeparam name="T">The type of component to register.</typeparam>
<param name="resolver">The resolver.</param>
</member>
<member name="M:FakeItEasy.IoC.DictionaryContainer.RegisterSingleton``1(System.Func{FakeItEasy.IoC.DictionaryContainer,``0})">
<summary>
Registers the specified resolver as a singleton.
</summary>
<typeparam name="T">The type of component to register.</typeparam>
<param name="resolver">The resolver.</param>
</member>
<member name="T:FakeItEasy.IRepeatSpecification">
<summary>
Provides properties and methods to specify repeat.
</summary>
</member>
<member name="M:FakeItEasy.IRepeatSpecification.Times(System.Int32)">
<summary>
Specifies the number of times as repeat.
</summary>
<param name="numberOfTimes">The number of times expected.</param>
<returns>A Repeated instance.</returns>
</member>
<member name="P:FakeItEasy.IRepeatSpecification.Once">
<summary>
Specifies once as the repeat.
</summary>
</member>
<member name="P:FakeItEasy.IRepeatSpecification.Twice">
<summary>
Specifies twice as the repeat.
</summary>
</member>
<member name="T:FakeItEasy.OrderedAssertion">
<summary>
Provides functionality for making ordered assertions on fakes.
</summary>
</member>
<member name="M:FakeItEasy.OrderedAssertion.OrderedAssertions(System.Collections.Generic.IEnumerable{FakeItEasy.Core.ICompletedFakeObjectCall})">
<summary>
Creates a scope that changes the behavior on asserts so that all asserts within
the scope must be to calls in the specified collection of calls. Calls must have happened
in the order that the asserts are specified or the asserts will fail.
</summary>
<param name="calls">The calls to assert among.</param>
<returns>A disposable used to close the scope.</returns>
</member>
<member name="T:FakeItEasy.CompletedFakeObjectCallExtensions">
<summary>
Provides extension methods for <see cref="T:FakeItEasy.Core.ICompletedFakeObjectCall"/>.
</summary>
</member>
<member name="M:FakeItEasy.CompletedFakeObjectCallExtensions.Matching``1(System.Collections.Generic.IEnumerable{FakeItEasy.Core.ICompletedFakeObjectCall},System.Linq.Expressions.Expression{System.Action{``0}})">
<summary>
Filters to contain only the calls that matches the call specification.
</summary>
<typeparam name="TFake">The type of fake the call is made on.</typeparam>
<param name="calls">The calls to filter.</param>
<param name="callSpecification">The call to match on.</param>
<returns>A collection of the calls that matches the call specification.</returns>
</member>
<member name="T:FakeItEasy.FakeConfigurator`1">
<summary>
Provides the base implementation for the IFakeConfigurator-interface.
</summary>
<typeparam name="T">The type of fakes the configurator can configure.</typeparam>
</member>
<member name="T:FakeItEasy.IFakeConfigurator">
<summary>
Provides configurations for fake objects of a specific type.
</summary>
</member>
<member name="M:FakeItEasy.IFakeConfigurator.ConfigureFake(System.Object)">
<summary>
Applies the configuration for the specified fake object.
</summary>
<param name="fakeObject">The fake object to configure.</param>
</member>
<member name="P:FakeItEasy.IFakeConfigurator.ForType">
<summary>
Gets the type the instance provides configuration for.
</summary>
</member>
<member name="M:FakeItEasy.FakeConfigurator`1.ConfigureFake(`0)">
<summary>
Configures the fake.
</summary>
<param name="fakeObject">The fake object.</param>
</member>
<member name="M:FakeItEasy.FakeConfigurator`1.FakeItEasy#IFakeConfigurator#ConfigureFake(System.Object)">
<summary>
Applies the configuration for the specified fake object.
</summary>
<param name="fakeObject">The fake object to configure.</param>
</member>
<member name="M:FakeItEasy.FakeConfigurator`1.AssertThatFakeIsOfCorrectType(System.Object)">
<summary>
Asserts the type of the that fake is of correct.
</summary>
<param name="fakeObject">The fake object.</param>
</member>
<member name="P:FakeItEasy.FakeConfigurator`1.ForType">
<summary>
Gets the type the instance provides configuration for.
</summary>
<value></value>
</member>
<member name="T:FakeItEasy.DummyDefinition`1">
<summary>
Represents a definition of how a fake object of the type T should
be created.
</summary>
<typeparam name="T">The type of fake.</typeparam>
</member>
<member name="T:FakeItEasy.IDummyDefinition">
<summary>
Represents a definition of how dummies of the specified type should be created.
</summary>
</member>
<member name="M:FakeItEasy.IDummyDefinition.CreateDummy">
<summary>
Creates the fake.
</summary>
<returns>The fake object.</returns>
</member>
<member name="P:FakeItEasy.IDummyDefinition.ForType">
<summary>
Gets the type of fake object the definition is for.
</summary>
</member>
<member name="M:FakeItEasy.DummyDefinition`1.FakeItEasy#IDummyDefinition#CreateDummy">
<summary>
Creates the dummy.
</summary>
<returns>The dummy object.</returns>
</member>
<member name="M:FakeItEasy.DummyDefinition`1.CreateDummy">
<summary>
Creates the dummy.
</summary>
<returns>The dummy object.</returns>
</member>
<member name="P:FakeItEasy.DummyDefinition`1.ForType">
<summary>
Gets the type the definition is for.
</summary>
<value>For type.</value>
</member>
<member name="T:FakeItEasy.ArgumentConstraintManagerExtensions">
<summary>
Provides validation extensions for <see cref="T:FakeItEasy.IArgumentConstraintManager`1"/>.
</summary>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.IsNull``1(FakeItEasy.IArgumentConstraintManager{``0})">
<summary>
Constrains an argument so that it must be null (Nothing in VB).
</summary>
<typeparam name="T">The type of the argument.</typeparam>
<param name="manager">The constraint manager to match the constraint.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.Contains(FakeItEasy.IArgumentConstraintManager{System.String},System.String)">
<summary>
Constrains the string argument to contain the specified text.
</summary>
<param name="manager">The constraint manager to match the constraint.</param>
<param name="value">The string the argument string should contain.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.Contains``1(FakeItEasy.IArgumentConstraintManager{``0},System.Object)">
<summary>
Constrains the sequence so that it must contain the specified value.
</summary>
<param name="manager">The constraint manager to match the constraint.</param>
<param name="value">The value the collection should contain.</param>
<typeparam name="T">The type of sequence.</typeparam>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.StartsWith(FakeItEasy.IArgumentConstraintManager{System.String},System.String)">
<summary>
Constrains the string so that it must start with the specified value.
</summary>
<param name="manager">The constraint manager to match the constraint.</param>
<param name="value">The value the string should start with.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.EndsWith(FakeItEasy.IArgumentConstraintManager{System.String},System.String)">
<summary>
Constrains the string so that it must end with the specified value.
</summary>
<param name="manager">The constraint manager to match the constraint.</param>
<param name="value">The value the string should end with.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.IsNullOrEmpty(FakeItEasy.IArgumentConstraintManager{System.String})">
<summary>
Constrains the string so that it must be null or empty.
</summary>
<param name="manager">The constraint manager to match the constraint.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.IsGreaterThan``1(FakeItEasy.IArgumentConstraintManager{``0},``0)">
<summary>
Constrains argument value so that it must be greater than the specified value.
</summary>
<param name="manager">The constraint manager to match the constraint.</param>
<param name="value">The value the string should start with.</param>
<typeparam name="T">The type of argument to constrain.</typeparam>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.IsSameSequenceAs``1(FakeItEasy.IArgumentConstraintManager{``0},System.Collections.IEnumerable)">
<summary>
The tested argument collection should contain the same elements as the
as the specified collection.
</summary>
<param name="manager">The constraint manager to match the constraint.</param>
<param name="value">The sequence to test against.</param>
<typeparam name="T">The type of argument to constrain.</typeparam>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.IsEmpty``1(FakeItEasy.IArgumentConstraintManager{``0})">
<summary>
Tests that the IEnumerable contains no items.
</summary>
<typeparam name="T">The type of argument.</typeparam>
<param name="manager">The constraint manager to match the constraint.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.IsEqualTo``1(FakeItEasy.IArgumentConstraintManager{``0},``0)">
<summary>
Tests that the passed in argument is equal to the specified value.
</summary>
<typeparam name="T">The type of the argument.</typeparam>
<param name="manager">The constraint manager to match the constraint.</param>
<param name="value">The value to compare to.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.IsSameAs``1(FakeItEasy.IArgumentConstraintManager{``0},``0)">
<summary>
Tests that the passed in argument is the same instance (reference) as the specified value.
</summary>
<typeparam name="T">The type of the argument.</typeparam>
<param name="manager">The constraint manager to match the constraint.</param>
<param name="value">The reference to compare to.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.IsInstanceOf``1(FakeItEasy.IArgumentConstraintManager{``0},System.Type)">
<summary>
Constrains the argument to be of the specified type.
</summary>
<typeparam name="T">The type of argument in the method signature.</typeparam>
<param name="manager">The constraint manager.</param>
<param name="type">The type to constrain the argument with.</param>
<returns>A dummy value.</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.Matches``1(FakeItEasy.IArgumentConstraintManager{``0},System.Func{``0,System.Boolean},System.String)">
<summary>
Constrains the argument with a predicate.
</summary>
<param name="scope">
The constraint manager.
</param>
<param name="predicate">
The predicate that should constrain the argument.
</param>
<param name="description">
A human readable description of the constraint.
</param>
<typeparam name="T">
The type of argument in the method signature.
</typeparam>
<returns>
A dummy argument value.
</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.Matches``1(FakeItEasy.IArgumentConstraintManager{``0},System.Func{``0,System.Boolean},System.String,System.Object[])">
<summary>
Constrains the argument with a predicate.
</summary>
<param name="manager">
The constraint manager.
</param>
<param name="predicate">
The predicate that should constrain the argument.
</param>
<param name="descriptionFormat">
A human readable description of the constraint format string.
</param>
<param name="args">
Arguments for the format string.
</param>
<typeparam name="T">
The type of argument in the method signature.
</typeparam>
<returns>
A dummy argument value.
</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.Matches``1(FakeItEasy.IArgumentConstraintManager{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})">
<summary>
Constrains the argument with a predicate.
</summary>
<param name="scope">
The constraint manager.
</param>
<param name="predicate">
The predicate that should constrain the argument.
</param>
<typeparam name="T">
The type of argument in the method signature.
</typeparam>
<returns>
A dummy argument value.
</returns>
</member>
<member name="M:FakeItEasy.ArgumentConstraintManagerExtensions.NullCheckedMatches``1(FakeItEasy.IArgumentConstraintManager{``0},System.Func{``0,System.Boolean},System.Action{FakeItEasy.IOutputWriter})">
<summary>
Constrains the argument to be not null (Nothing in VB) and to match
the specified predicate.
</summary>
<typeparam name="T">The type of the argument to constrain.</typeparam>
<param name="manager">The constraint manager.</param>
<param name="predicate">The predicate that constrains non null values.</param>
<param name="descriptionWriter">An action that writes a description of the constraint
to the output.</param>
<returns>A dummy argument value.</returns>
</member>
<member name="T:FakeItEasy.OutputWriterExtensions">
<summary>
Provides extensions for <see cref="T:FakeItEasy.IOutputWriter"/>.
</summary>
</member>
<member name="M:FakeItEasy.OutputWriterExtensions.WriteLine(FakeItEasy.IOutputWriter)">
<summary>
Writes a new line to the writer.
</summary>
<param name="writer">The writer to write to.</param>
<returns>The writer.</returns>
</member>
<member name="M:FakeItEasy.OutputWriterExtensions.Write(FakeItEasy.IOutputWriter,System.String,System.Object[])">
<summary>
Writes the format string to the writer.
</summary>
<param name="writer">The writer to write to.</param>
<param name="format">The format string to write.</param>
<param name="args">Replacements for the format string.</param>
<returns>The writer.</returns>
</member>
<member name="M:FakeItEasy.OutputWriterExtensions.Write(FakeItEasy.IOutputWriter,System.Object)">
<summary>
Writes the specified object to the writer (using the ToString-method of the object).
</summary>
<param name="writer">The writer to write to.</param>
<param name="value">The value to write to the writer.</param>
<returns>The writer.</returns>
</member>
<member name="T:FakeItEasy.Repeated">
<summary>
Provides syntax for specifying the number of times a call must have been repeated when asserting on
fake object calls.
</summary>
<example><code>A.CallTo(() => foo.Bar()).Assert(Happened.Once.Exactly);</code></example>
</member>
<member name="M:FakeItEasy.Repeated.Like(System.Linq.Expressions.Expression{System.Func{System.Int32,System.Boolean}})">
<summary>
Specifies that a call must have been repeated a number of times
that is validated by the specified repeatValidation argument.
</summary>
<param name="repeatValidation">A predicate that specifies the number of times
a call must have been made.</param>
<returns>A Repeated-instance.</returns>
</member>
<member name="M:FakeItEasy.Repeated.Matches(System.Int32)">
<summary>
When implemented gets a value indicating if the repeat is matched
by the Happened-instance.
</summary>
<param name="repeat">The repeat of a call.</param>
<returns>True if the repeat is a match.</returns>
</member>
<member name="P:FakeItEasy.Repeated.Never">
<summary>
Asserts that a call has not happened at all.
</summary>
</member>
<member name="P:FakeItEasy.Repeated.Exactly">
<summary>
The call must have happened exactly the number of times that is specified in the next step.
</summary>
</member>
<member name="P:FakeItEasy.Repeated.AtLeast">
<summary>
The call must have happened any number of times greater than or equal to the number of times that is specified
in the next step.
</summary>
</member>
<member name="P:FakeItEasy.Repeated.NoMoreThan">
<summary>
The call must have happened any number of times less than or equal to the number of times that is specified
in the next step.
</summary>
</member>
<member name="T:FakeItEasy.Recorders">
<summary>
Provides methods for creating recorders for self initializing fakes.
</summary>
</member>
<member name="M:FakeItEasy.Recorders.FileRecorder(System.String)">
<summary>
Gets a recorder that records to and loads calls from the specified file.
</summary>
<param name="fileName">The file to use for recording.</param>
<returns>A recorder instance.</returns>
</member>
<member name="T:FakeItEasy.IFileSystem">
<summary>
Provides access to the file system.
</summary>
</member>
<member name="M:FakeItEasy.IFileSystem.Open(System.String,System.IO.FileMode)">
<summary>
Opens the specified file in the specified mode.
</summary>
<param name="fileName">The full path and name of the file to open.</param>
<param name="mode">The mode to open the file in.</param>
<returns>A stream for reading and writing the file.</returns>
</member>
<member name="M:FakeItEasy.IFileSystem.FileExists(System.String)">
<summary>
Gets a value indicating whether the specified file exists.
</summary>
<param name="fileName">The path and name of the file to check.</param>
<returns>True if the file exists.</returns>
</member>
<member name="M:FakeItEasy.IFileSystem.Create(System.String)">
<summary>
Creates a file with the specified name.
</summary>
<param name="fileName">The name of the file to create.</param>
</member>
<member name="T:FakeItEasy.ExpressionExtensions">
<summary>
Provides extension methods for <see cref="T:System.Linq.Expressions.Expression"/>.
</summary>
</member>
<member name="M:FakeItEasy.ExpressionExtensions.Evaluate(System.Linq.Expressions.Expression)">
<summary>
Evaluates an expression by compiling it into a delegate and invoking the delegate.
</summary>
<param name="expression">The expression to be evaluated.</param>
<returns>The value returned from the delegate compiled from the expression.</returns>
</member>
<member name="T:FakeItEasy.ExpectationException">
<summary>
An exception thrown when an expectation is not met (when asserting on fake object calls).
</summary>
</member>
<member name="M:FakeItEasy.ExpectationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.ExpectationException"/> class.
</summary>
</member>
<member name="M:FakeItEasy.ExpectationException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.ExpectationException"/> class.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:FakeItEasy.ExpectationException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.ExpectationException"/> class.
</summary>
<param name="message">The message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:FakeItEasy.ExpectationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.ExpectationException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is null.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:FakeItEasy.ValueProducerSignatureHelper">
<summary>
Provides helper methods for checking the value producer signature against call signatures.
</summary>
</member>
<member name="T:FakeItEasy.ArgumentCollection">
<summary>
A collection of method arguments.
</summary>
</member>
<member name="F:FakeItEasy.ArgumentCollection.arguments">
<summary>
The arguments this collection contains.
</summary>
</member>
<member name="M:FakeItEasy.ArgumentCollection.#ctor(System.Object[],System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.ArgumentCollection"/> class.
</summary>
<param name="arguments">The arguments.</param>
<param name="argumentNames">The argument names.</param>
</member>
<member name="M:FakeItEasy.ArgumentCollection.#ctor(System.Object[],System.Reflection.MethodInfo)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.ArgumentCollection"/> class.
</summary>
<param name="arguments">The arguments.</param>
<param name="method">The method.</param>
</member>
<member name="M:FakeItEasy.ArgumentCollection.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection or arguments.
</summary>
<returns>
A <see cref = "T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:FakeItEasy.ArgumentCollection.Get``1(System.Int32)">
<summary>
Gets the argument at the specified index.
</summary>
<typeparam name = "T">The type of the argument to get.</typeparam>
<param name = "index">The index of the argument.</param>
<returns>The argument at the specified index.</returns>
</member>
<member name="M:FakeItEasy.ArgumentCollection.Get``1(System.String)">
<summary>
Gets the argument with the specified name.
</summary>
<typeparam name = "T">The type of the argument to get.</typeparam>
<param name = "argumentName">The name of the argument.</param>
<returns>The argument with the specified name.</returns>
</member>
<member name="P:FakeItEasy.ArgumentCollection.Empty">
<summary>
Gets an empty ArgumentList.
</summary>
</member>
<member name="P:FakeItEasy.ArgumentCollection.Count">
<summary>
Gets the number of arguments in the list.
</summary>
</member>
<member name="P:FakeItEasy.ArgumentCollection.ArgumentNames">
<summary>
Gets the names of the arguments in the list.
</summary>
</member>
<member name="P:FakeItEasy.ArgumentCollection.Item(System.Int32)">
<summary>
Gets the argument at the specified index.
</summary>
<param name = "argumentIndex">The index of the argument to get.</param>
<returns>The argument at the specified index.</returns>
</member>
<member name="T:FakeItEasy.Guard">
<summary>
Provides methods for guarding method arguments.
</summary>
</member>
<member name="M:FakeItEasy.Guard.AgainstNull(System.Object,System.String)">
<summary>
Throws an exception if the specified argument is null.
</summary>
<param name="argument">The argument.</param>
<param name="argumentName">Name of the argument.</param>
<exception cref="T:System.ArgumentNullException">The specified argument was null.</exception>
</member>
<member name="T:FakeItEasy.Guard.ValidatedNotNullAttribute">
<summary>
When applied to a parameter, this attribute provides an indication to code analysis that the argument has been null checked.
</summary>
</member>
<member name="T:FakeItEasy.Fake">
<summary>
Provides static methods for accessing fake objects.
</summary>
</member>
<member name="M:FakeItEasy.Fake.GetFakeManager(System.Object)">
<summary>
Gets the fake object that manages the faked object.
</summary>
<param name="fakedObject">The faked object to get the manager object for.</param>
<returns>The fake object manager.</returns>
</member>
<member name="M:FakeItEasy.Fake.CreateScope">
<summary>
Creates a new scope and sets it as the current scope. When inside a scope the
getting the calls made to a fake will return only the calls within that scope and when
asserting that calls were made, the calls must have been made within that scope.
</summary>
<returns>The created scope.</returns>
</member>
<member name="M:FakeItEasy.Fake.CreateScope(FakeItEasy.Core.IFakeObjectContainer)">
<summary>
Creates a new scope and sets it as the current scope. When inside a scope the
getting the calls made to a fake will return only the calls within that scope and when
asserting that calls were made, the calls must have been made within that scope.
</summary>
<param name="container">The container to use within the specified scope.</param>
<returns>The created scope.</returns>
</member>
<member name="M:FakeItEasy.Fake.Equals(System.Object,System.Object)">
<summary>
Gets a value indicating whether the two objects are equal.
</summary>
<param name="objA">The first object to compare.</param>
<param name="objB">The second object to compare.</param>
<returns>True if the two objects are equal.</returns>
</member>
<member name="M:FakeItEasy.Fake.ReferenceEquals(System.Object,System.Object)">
<summary>
Gets a value indicating whether the two objects are the same reference.
</summary>
<param name="objA">The object A.</param>
<param name="objB">The object B.</param>
<returns>True if the objects are the same reference.</returns>
</member>
<member name="M:FakeItEasy.Fake.GetCalls(System.Object)">
<summary>
Gets all the calls made to the specified fake object.
</summary>
<param name="fakedObject">The faked object.</param>
<returns>A collection containing the calls to the object.</returns>
<exception cref="T:System.ArgumentException">The object passed in is not a faked object.</exception>
</member>
<member name="M:FakeItEasy.Fake.ClearConfiguration(System.Object)">
<summary>
Clears the configuration of the faked object.
</summary>
<param name="fakedObject">The faked object to clear the configuration of.</param>
</member>
<member name="M:FakeItEasy.Fake.InitializeFixture(System.Object)">
<summary>
Sets a new fake to each property or field that is tagged with the FakeAttribute in the specified
fixture.
</summary>
<param name="fixture">The object to initialize.</param>
</member>
<member name="T:FakeItEasy.Raise">
<summary>
Allows the developer to raise an event on a faked object.
</summary>
</member>
<member name="M:FakeItEasy.Raise.With``1(System.Object,``0)">
<summary>
Raises an event on a faked object by attaching the event handler produced by the method
to the event that is to be raised.
</summary>
<typeparam name="TEventArgs">The type of the event args.</typeparam>
<param name="sender">The sender of the event.</param>
<param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
<returns>A Raise(TEventArgs)-object that exposes the event handler to attach.</returns>
</member>
<member name="M:FakeItEasy.Raise.With``1(``0)">
<summary>
Raises an event on a faked object by attaching the event handler produced by the method
to the event that is to be raised.
</summary>
<typeparam name="TEventArgs">The type of the event arguments.</typeparam>
<param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
<returns>
A Raise(TEventArgs)-object that exposes the event handler to attach.
</returns>
</member>
<member name="M:FakeItEasy.Raise.WithEmpty">
<summary>
Raises an event with empty event arguments on a faked object by attaching the event handler produced by the method
to the event that is to be raised.
</summary>
<returns>
A Raise(TEventArgs)-object that exposes the event handler to attach.
</returns>
</member>
<member name="T:FakeItEasy.RootModule">
<summary>
Handles the registration of root dependencies in an IoC-container.
</summary>
</member>
<member name="M:FakeItEasy.RootModule.RegisterDependencies(FakeItEasy.IoC.DictionaryContainer)">
<summary>
Registers the dependencies.
</summary>
<param name="container">The container to register the dependencies in.</param>
</member>
<member name="T:FakeItEasy.SelfInitializedFakes.CallData">
<summary>
DTO for recorded calls.
</summary>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.CallData.#ctor(System.Reflection.MethodInfo,System.Collections.Generic.IEnumerable{System.Object},System.Object)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.SelfInitializedFakes.CallData"/> class.
</summary>
<param name="method">The method.</param>
<param name="outputArguments">The output arguments.</param>
<param name="returnValue">The return value.</param>
</member>
<member name="P:FakeItEasy.SelfInitializedFakes.CallData.Method">
<summary>
Gets the method that was called.
</summary>
<value>The method.</value>
</member>
<member name="P:FakeItEasy.SelfInitializedFakes.CallData.OutputArguments">
<summary>
Gets the output arguments of the call.
</summary>
<value>The output arguments.</value>
</member>
<member name="P:FakeItEasy.SelfInitializedFakes.CallData.ReturnValue">
<summary>
Gets the return value of the call.
</summary>
<value>The return value.</value>
</member>
<member name="T:FakeItEasy.SelfInitializedFakes.ICallStorage">
<summary>
Represents storage for recorded calls for self initializing
fakes.
</summary>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.ICallStorage.Load">
<summary>
Loads the recorded calls for the specified recording.
</summary>
<returns>The recorded calls for the recording with the specified id.</returns>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.ICallStorage.Save(System.Collections.Generic.IEnumerable{FakeItEasy.SelfInitializedFakes.CallData})">
<summary>
Saves the specified calls as the recording with the specified id,
overwriting any previous recording.
</summary>
<param name="calls">The calls to save.</param>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.FileStorage.#ctor(System.String,FakeItEasy.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.SelfInitializedFakes.FileStorage"/> class.
</summary>
<param name="fileName">Name of the file.</param>
<param name="fileSystem">The file system.</param>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.FileStorage.Load">
<summary>
Loads the recorded calls for the specified recording.
</summary>
<returns>
The recorded calls for the recording with the specified id.
</returns>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.FileStorage.Save(System.Collections.Generic.IEnumerable{FakeItEasy.SelfInitializedFakes.CallData})">
<summary>
Saves the specified calls as the recording with the specified id,
overwriting any previous recording.
</summary>
<param name="calls">The calls to save.</param>
</member>
<member name="T:FakeItEasy.SelfInitializedFakes.FileStorage.Factory">
<summary>
A factory responsible for creating instances of FileStorage.
</summary>
<param name="fileName">The file name of the storage.</param>
<returns>A FileStorage instance.</returns>
</member>
<member name="T:FakeItEasy.SelfInitializedFakes.ISelfInitializingFakeRecorder">
<summary>
An interface for recorders that provides stored responses for self initializing fakes.
</summary>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.ISelfInitializingFakeRecorder.ApplyNext(FakeItEasy.Core.IInterceptedFakeObjectCall)">
<summary>
Applies the call if the call has been recorded.
</summary>
<param name="fakeObjectCall">The call to apply to from recording.</param>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.ISelfInitializingFakeRecorder.RecordCall(FakeItEasy.Core.ICompletedFakeObjectCall)">
<summary>
Records the specified call.
</summary>
<param name="fakeObjectCall">The call to record.</param>
</member>
<member name="P:FakeItEasy.SelfInitializedFakes.ISelfInitializingFakeRecorder.IsRecording">
<summary>
Gets a value indicating whether the recorder is currently recording.
</summary>
</member>
<member name="T:FakeItEasy.SelfInitializedFakes.RecordingException">
<summary>
An exception that can be thrown when recording for self initialized
fakes fails or when playback fails.
</summary>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.RecordingException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.SelfInitializedFakes.RecordingException"/> class.
</summary>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.RecordingException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.SelfInitializedFakes.RecordingException"/> class.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.RecordingException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.SelfInitializedFakes.RecordingException"/> class.
</summary>
<param name="message">The message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.RecordingException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.SelfInitializedFakes.RecordingException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">
The <paramref name="info"/> parameter is null.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
<member name="T:FakeItEasy.SelfInitializedFakes.RecordingManager">
<summary>
Manages the applying of recorded calls and recording of new calls when
using self initialized fakes.
</summary>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.RecordingManager.#ctor(FakeItEasy.SelfInitializedFakes.ICallStorage)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.SelfInitializedFakes.RecordingManager"/> class.
</summary>
<param name="storage">The storage.</param>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.RecordingManager.ApplyNext(FakeItEasy.Core.IInterceptedFakeObjectCall)">
<summary>
Applies the call if the call has been recorded.
</summary>
<param name="fakeObjectCall">The call to apply to from recording.</param>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.RecordingManager.RecordCall(FakeItEasy.Core.ICompletedFakeObjectCall)">
<summary>
Records the specified call.
</summary>
<param name="fakeObjectCall">The call to record.</param>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.RecordingManager.Dispose">
<summary>
Saves all recorded calls to the storage.
</summary>
</member>
<member name="P:FakeItEasy.SelfInitializedFakes.RecordingManager.IsRecording">
<summary>
Gets a value indicating whether the recorder is currently recording.
</summary>
<value></value>
</member>
<member name="T:FakeItEasy.SelfInitializedFakes.RecordingManager.Factory">
<summary>
Represents a factory responsible for creating recording manager
instances.
</summary>
<param name="storage">The storage the manager should use.</param>
<returns>A RecordingManager instance.</returns>
</member>
<member name="T:FakeItEasy.SelfInitializedFakes.SelfInitializationRule">
<summary>
A call rule use for self initializing fakes, delegates call to
be applied by the recorder.
</summary>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.SelfInitializationRule.#ctor(FakeItEasy.Core.IFakeObjectCallRule,FakeItEasy.SelfInitializedFakes.ISelfInitializingFakeRecorder)">
<summary>
Initializes a new instance of the <see cref="T:FakeItEasy.SelfInitializedFakes.SelfInitializationRule"/> class.
</summary>
<param name="wrappedRule">The wrapped rule.</param>
<param name="recorder">The recorder.</param>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.SelfInitializationRule.IsApplicableTo(FakeItEasy.Core.IFakeObjectCall)">
<summary>
Gets whether this interceptor is applicable to the specified
call, if true is returned the Apply-method of the interceptor will
be called.
</summary>
<param name="fakeObjectCall">The call to check for applicability.</param>
<returns>True if the interceptor is applicable.</returns>
</member>
<member name="M:FakeItEasy.SelfInitializedFakes.SelfInitializationRule.Apply(FakeItEasy.Core.IInterceptedFakeObjectCall)">
<summary>
Applies an action to the call, might set a return value or throw
an exception.
</summary>
<param name="fakeObjectCall">The call to apply the interceptor to.</param>
</member>
<member name="P:FakeItEasy.SelfInitializedFakes.SelfInitializationRule.NumberOfTimesToCall">
<summary>
Gets the number of times this call rule is valid, if it's set
to null its infinitely valid.
</summary>
<value></value>
</member>
<member name="T:FakeItEasy.EnumerableExtensions">
<summary>
Provides extension methods for generic usage of <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
</member>
<member name="M:FakeItEasy.EnumerableExtensions.Zip``2(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``1})">
<summary>
Gets an enumerable of tuples where the first value of each tuple is a value
from the first collection and the second value of each tuple is the value at the same position
from the second collection.
</summary>
<typeparam name="TFirst">The type of values in the first collection.</typeparam>
<typeparam name="TSecond">The type of values in the second collection.</typeparam>
<param name="firstCollection">The first of the collections to combine.</param>
<param name="secondCollection">The second of the collections to combine.</param>
<returns>An enumerable of tuples.</returns>
</member>
<member name="M:FakeItEasy.EnumerableExtensions.ToCollectionString``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.String},System.String)">
<summary>
Joins the collection to a string.
</summary>
<typeparam name="T">The type of items in the collection.</typeparam>
<param name="items">The items to join.</param>
<param name="stringConverter">A function that converts from an item to a string value.</param>
<param name="separator">Separator to insert between each item.</param>
<returns>A string representation of the collection.</returns>
</member>
<member name="M:FakeItEasy.EnumerableExtensions.FirstFromEachKey``2(System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1})">
<summary>
Gets a dictionary containing the first element from the sequence that has a key specified by the key selector.
</summary>
<typeparam name="T">The type of items in the sequence.</typeparam>
<typeparam name="TKey">The type of the key.</typeparam>
<param name="sequence">The sequence.</param>
<param name="keySelector">The key selector.</param>
<returns>A dictionary.</returns>
</member>
<member name="T:FakeItEasy.SmellyAttribute">
<summary>
An attribute that can be applied to code that should be fixed because there's a
code smell.
</summary>
</member>
<member name="P:FakeItEasy.SmellyAttribute.Description">
<summary>
Gets or sets the description of the smell.
</summary>
</member>
<member name="T:FakeItEasy.NextCall">
<summary>
Lets you specify options for the next call to a fake object.
</summary>
</member>
<member name="M:FakeItEasy.NextCall.To``1(``0)">
<summary>
Specifies options for the next call to the specified fake object. The next call will
be recorded as a call configuration.
</summary>
<typeparam name="TFake">The type of the faked object.</typeparam>
<param name="fake">The faked object to configure.</param>
<returns>A call configuration object.</returns>
</member>
<member name="T:FakeItEasy.UnderTestAttribute">
<summary>
Used to tag fields and properties that will be initialized as a SUT through the Fake.Initialize-method.
</summary>
</member>
</members>
</doc>
<?xml version="1.0"?>
<doc>
<assembly>
<name>FluentAssertions.Core</name>
</assembly>
<members>
<member name="M:FluentAssertions.AndConstraint`1.#ctor(`0)">
<summary>
Initializes a new instance of the <see cref="T:System.Object"/> class.
</summary>
</member>
<member name="T:FluentAssertions.AndWhichConstraint`2">
<summary>
Constraint which can be returned from an assertion which matches a condition and which will allow
further matches to be performed on the matched condition as well as the parent constraint.
</summary>
<typeparam name="TParentConstraint">The type of the original constraint that was matched</typeparam>
<typeparam name="TMatchedElement">The type of the matched object which the parent constarint matched</typeparam>
</member>
<member name="P:FluentAssertions.AndWhichConstraint`2.Which">
<summary>
Returns the instance which the original parent constraint matched, so that further matches can be performed
</summary>
</member>
<member name="T:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Collections.Generic.IEnumerable`1"/> is in the expectation state.
</summary>
</member>
<member name="T:FluentAssertions.Collections.CollectionAssertions`2">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Collections.IEnumerable"/> is in the expected state.
</summary>
</member>
<member name="T:FluentAssertions.Primitives.ReferenceTypeAssertions`2">
<summary>
Contains a number of methods to assert that a reference type object is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.ReferenceTypeAssertions`2.BeNull(System.String,System.Object[])">
<summary>
Asserts that the current object has not been initialized yet.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.ReferenceTypeAssertions`2.NotBeNull(System.String,System.Object[])">
<summary>
Asserts that the current object has been initialized.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.ReferenceTypeAssertions`2.BeSameAs(`0,System.String,System.Object[])">
<summary>
Asserts that an object reference refers to the exact same object as another object reference.
</summary>
<param name="expected">The expected object</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Primitives.ReferenceTypeAssertions`2.NotBeSameAs(`0,System.String,System.Object[])">
<summary>
Asserts that an object reference refers to a different object than another object reference refers to.
</summary>
<param name="unexpected">The unexpected object</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Primitives.ReferenceTypeAssertions`2.BeOfType``1(System.String,System.Object[])">
<summary>
Asserts that the object is of the specified type <typeparamref name="T"/>.
</summary>
<typeparam name="T">The expected type of the object.</typeparam>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.ReferenceTypeAssertions`2.BeOfType(System.Type,System.String,System.Object[])">
<summary>
Asserts that the object is of the specified type <paramref name="expectedType"/>.
</summary>
<param name="expectedType">
The type that the subject is supposed to be of.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.ReferenceTypeAssertions`2.BeAssignableTo``1(System.String,System.Object[])">
<summary>
Asserts that the object is assignable to a variable of type <typeparamref name="T"/>.
</summary>
<typeparam name="T">The type to which the object should be assignable.</typeparam>
<param name="because">The reason why the object should be assignable to the type.</param>
<param name="reasonArgs">The parameters used when formatting the <paramref name="because"/>.</param>
<returns>An <see cref="T:FluentAssertions.AndConstraint`1"/> which can be used to chain assertions.</returns>
</member>
<member name="M:FluentAssertions.Primitives.ReferenceTypeAssertions`2.Match(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the <paramref name="predicate"/> is satisfied.
</summary>
<param name="predicate">The predicate which must be statisfied by the <typeparamref name="TSubject"/>.</param>
<param name="because">The reason why the predicate should be satisfied.</param>
<param name="reasonArgs">The parameters used when formatting the <paramref name="because"/>.</param>
<returns>An <see cref="T:FluentAssertions.AndConstraint`1"/> which can be used to chain assertions.</returns>
</member>
<member name="M:FluentAssertions.Primitives.ReferenceTypeAssertions`2.Match``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the <paramref name="predicate"/> is satisfied.
</summary>
<param name="predicate">The predicate which must be statisfied by the <typeparamref name="TSubject"/>.</param>
<param name="because">The reason why the predicate should be satisfied.</param>
<param name="reasonArgs">The parameters used when formatting the <paramref name="because"/>.</param>
<returns>An <see cref="T:FluentAssertions.AndConstraint`1"/> which can be used to chain assertions.</returns>
</member>
<member name="P:FluentAssertions.Primitives.ReferenceTypeAssertions`2.Subject">
<summary>
Gets the object which value is being asserted.
</summary>
</member>
<member name="P:FluentAssertions.Primitives.ReferenceTypeAssertions`2.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.BeEmpty(System.String,System.Object[])">
<summary>
Asserts that the collection does not contain any items.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotBeEmpty(System.String,System.Object[])">
<summary>
Asserts that the collection contains at least 1 item.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.BeNullOrEmpty(System.String,System.Object[])">
<summary>
Asserts that the collection is null or does not contain any items.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotBeNullOrEmpty(System.String,System.Object[])">
<summary>
Asserts that the collection is not null and contains at least 1 item.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.OnlyHaveUniqueItems(System.String,System.Object[])">
<summary>
Asserts that the collection does not contain any duplicate items.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotContainNulls(System.String,System.Object[])">
<summary>
Asserts that the collection does not contain any <c>null</c> items.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.Equal(System.Object[])">
<summary>
Expects the current collection to contain all the same elements in the same order as the collection identified by
<paramref name="elements"/>. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="elements">A params array with the expected elements.</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.Equal(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Expects the current collection to contain all the same elements in the same order as the collection identified by
<paramref name="expected"/>. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="expected">An <see cref="T:System.Collections.IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotEqual(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Expects the current collection not to contain all the same elements in the same order as the collection identified by
<paramref name="unexpected"/>. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="unexpected">An <see cref="T:System.Collections.IEnumerable"/> with the elements that are not expected.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.BeEquivalentTo(System.Object[])">
<summary>
Expects the current collection to contain all elements of the collection identified by <paramref name="elements"/>,
regardless of the order. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="elements">A params array with the expected elements.</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.BeEquivalentTo(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Expects the current collection to contain all elements of the collection identified by <paramref name="expected"/>,
regardless of the order. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="expected">An <see cref="T:System.Collections.IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotBeEquivalentTo(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Expects the current collection not to contain all elements of the collection identified by <paramref name="unexpected"/>,
regardless of the order. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="unexpected">An <see cref="T:System.Collections.IEnumerable"/> with the unexpected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.ContainItemsAssignableTo``1(System.String,System.Object[])">
<summary>
Asserts that the current collection only contains items that are assignable to the type <typeparamref name="T"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.Contain(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Expects the current collection to contain the specified elements in any order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">An <see cref="T:System.Collections.IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.ContainInOrder(System.Object[])">
<summary>
Expects the current collection to contain the specified elements in the exact same order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">An <see cref="T:System.Collections.IEnumerable"/> with the expected elements.</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.ContainInOrder(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Expects the current collection to contain the specified elements in the exact same order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">An <see cref="T:System.Collections.IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.BeInAscendingOrder(System.String,System.Object[])">
<summary>
Expects the current collection to have all elements in ascending order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.BeInDescendingOrder(System.String,System.Object[])">
<summary>
Expects the current collection to have all elements in descending order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.BeInOrder(FluentAssertions.Collections.SortOrder,System.String,System.Object[])">
<summary>
Expects the current collection to have all elements in the specified <paramref name="expectedOrder"/>.
Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotBeAscendingInOrder(System.String,System.Object[])">
<summary>
Asserts the current collection does not have all elements in ascending order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotBeDescendingInOrder(System.String,System.Object[])">
<summary>
Asserts the current collection does not have all elements in descending order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotBeInOrder(FluentAssertions.Collections.SortOrder,System.String,System.Object[])">
<summary>
Asserts the current collection does not have all elements in ascending order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.BeSubsetOf(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Asserts that the collection is a subset of the <paramref name="expectedSuperset"/>.
</summary>
<param name="expectedSuperset">An <see cref="T:System.Collections.IEnumerable"/> with the expected superset.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotBeSubsetOf(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Asserts that the collection is not a subset of the <paramref name="unexpectedSuperset"/>.
</summary>
<param name="unexpectedSuperset">An <see cref="T:System.Collections.IEnumerable"/> with the unexpected superset.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.HaveSameCount(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Assert that the current collection has the same number of elements as <paramref name="otherCollection"/>.
</summary>
<param name="otherCollection">The other collection with the same expected number of elements</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.HaveElementAt(System.Int32,System.Object,System.String,System.Object[])">
<summary>
Asserts that the current collection has the supplied <paramref name="element"/> at the
supplied <paramref name="index"/>.
</summary>
<param name="index">The index where the element is expected</param>
<param name="element">The expected element</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotContain(System.Object,System.String,System.Object[])">
<summary>
Asserts that the current collection does not contain the supplied <paramref name="unexpected"/> item.
</summary>
<param name="unexpected">The element that is not expected to be in the collection</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.IntersectWith(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Asserts that the collection shares one or more items with the specified <paramref name="otherCollection"/>.
</summary>
<param name="otherCollection">The <see cref="T:System.Collections.IEnumerable"/> with the expected shared items.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.CollectionAssertions`2.NotIntersectWith(System.Collections.IEnumerable,System.String,System.Object[])">
<summary>
Asserts that the collection does not share any items with the specified <paramref name="otherCollection"/>.
</summary>
<param name="otherCollection">The <see cref="T:System.Collections.IEnumerable"/> to compare to.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Collections.CollectionAssertions`2.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.HaveCount(System.Int32,System.String,System.Object[])">
<summary>
Asserts that the number of items in the collection matches the supplied <paramref name="expected"/> amount.
</summary>
<param name="expected">The expected number of items in the collection.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.HaveCount(System.Linq.Expressions.Expression{System.Func{System.Int32,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the number of items in the collection matches a condition stated by the <paramref name="countPredicate"/>.
</summary>
<param name="countPredicate">A predicate that yields the number of items that is expected to be in the collection.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.Equal(`0[])">
<summary>
Expects the current collection to contain all the same elements in the same order as the collection identified by
<paramref name="elements"/>. Elements are compared using their <see cref="!:T.Equals(T)"/> method.
</summary>
<param name="elements">A params array with the expected elements.</param>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.Equal(System.Collections.Generic.IEnumerable{`0},System.Func{`0,`0,System.Boolean},System.String,System.Object[])">
<summary>
Asserts that two collections contain the same items in the same order, where equality is determined using a
predicate.
</summary>
<param name="expectation">
The collection to compare the subject with.
</param>
<param name="predicate">
A predicate the is used to determine whether two objects should be treated as equal.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.Contain(`0,System.String,System.Object[])">
<summary>
Asserts that the collection contains the specified item.
</summary>
<param name="expected">The expectation item.</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.Contain(System.Collections.Generic.IEnumerable{`0},`0[])">
<summary>
Asserts that the collection contains some extra items in addition to the original items.
</summary>
<param name="expectedItemsList">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of expectation items.</param>
<param name="additionalExpectedItems">Additional items that are expectation to be contained by the collection.</param>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.Contain(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the collection contains at least one item that matches the predicate.
</summary>
<param name="predicate">A predicate to match the items in the collection against.</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.OnlyContain(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the collection only contains items that match a predicate.
</summary>
<param name="predicate">A predicate to match the items in the collection against.</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.NotContain(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the collection does not contain any items that match the predicate.
</summary>
<param name="predicate">A predicate to match the items in the collection against.</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Collections.SelfReferencingCollectionAssertions`2.ContainSingle(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.String,System.Object[])">
<summary>
Expects the current collection to contain only a single item matching the specified <paramref name="predicate"/>.
</summary>
<param name="predicate">The predictes that will be used to find the matching items.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Collections.WhichValueConstraint`2.WhichValue">
<summary>
Gets the value of the object refered to by the key.
</summary>
</member>
<member name="M:FluentAssertions.Common.DateTimeExtensions.ToDateTimeOffset(System.DateTime)">
<summary>
Converts an existing <see cref="T:System.DateTime"/> to a <see cref="T:System.DateTimeOffset"/> but normalizes the <see cref="T:System.DateTimeKind"/>
so that comparisons of converted <see cref="T:System.DateTime"/> instances retain the UTC/local agnostic behavior.
</summary>
</member>
<member name="T:FluentAssertions.Common.IProvidePlatformServices">
<summary>
Defines the contract the platform-specific assembly must implement to be able to get a chance to initialize itself.
</summary>
</member>
<member name="T:FluentAssertions.Common.PlatformAdapter">
<summary>
Facade to resolve an implementation of a particular interface using a platform-specific assembly.
</summary>
</member>
<member name="T:FluentAssertions.Common.ProbingAdapterResolver">
<summary>
An implementation of <see cref="T:FluentAssertions.Common.IAdapterResolver"/> that probes for platforms-specific adapters by dynamically
looking for concrete types in platform-specific assemblies.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.IEquivalencyStep">
<summary>
Defines a step in the process of comparing two object graphs for structural equivalency.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.IEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.IEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.EnumEqualityStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EnumEqualityStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.EnumerableEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the verificationScope subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EnumerableEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="T:FluentAssertions.Equivalency.IncludePropertyByPredicateSelectionRule">
<summary>
Selection rule that includes a particular property in the structural comparison.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.ISelectionRule">
<summary>
Represents a rule that defines which properties of the subject-under-test to include while comparing
two objects for structural equality.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.ISelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Adds or removes properties to/from the collection of subject properties that must be included while
comparing two objects for structural equality.
</summary>
<param name="selectedProperties">
A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
<param name="info">
Type info about the subject.
</param>
<returns>
The collection of properties after applying this rule. Can contain less or more than was passed in.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.IncludePropertyByPredicateSelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Adds or removes properties to/from the collection of subject properties that must be included while
comparing two objects for structural equality.
</summary>
<param name="selectedProperties">
A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
<returns>
The collection of properties after applying this rule. Can contain less or more than was passed in.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.IncludePropertyByPredicateSelectionRule.ToString">
<summary>
Returns a string that represents the current object.
</summary>
<returns>
A string that represents the current object.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="M:FluentAssertions.Equivalency.StringEqualityEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.StringEqualityEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.SystemTypeEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.SystemTypeEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="T:FluentAssertions.InternalAssertionExtensions">
<summary>
Contains extension methods for custom assertions in unit tests.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Invoking``1(``0,System.Action{``0})">
<summary>
Invokes the specified action on an subject so that you can chain it with any of the ShouldThrow or ShouldNotThrow
overloads.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Enumerating(System.Func{System.Collections.IEnumerable})">
<summary>
Forces enumerating a collection. Should be used to assert that a method that uses the
<c>yield</c> keyword throws a particular exception.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Enumerating``1(System.Func{System.Collections.Generic.IEnumerable{``0}})">
<summary>
Forces enumerating a collection. Should be used to assert that a method that uses the
<c>yield</c> keyword throws a particular exception.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Object)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.ObjectAssertions"/> object that can be used to assert the
current <see cref="T:System.Object"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Boolean)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.BooleanAssertions"/> object that can be used to assert the
current <see cref="T:System.Boolean"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.Boolean})">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.NullableBooleanAssertions"/> object that can be used to assert the
current nullable <see cref="T:System.Boolean"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Guid)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.GuidAssertions"/> object that can be used to assert the
current <see cref="T:System.Guid"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.Guid})">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.NullableGuidAssertions"/> object that can be used to assert the
current nullable <see cref="T:System.Guid"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Collections.IEnumerable)">
<summary>
Returns an <see cref="T:FluentAssertions.Collections.NonGenericCollectionAssertions"/> object that can be used to assert the
current <see cref="T:System.Collections.IEnumerable"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns an <see cref="T:FluentAssertions.Collections.GenericCollectionAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns an <see cref="T:FluentAssertions.Collections.StringCollectionAssertions"/> object that can be used to assert the
current <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should``2(System.Collections.Generic.IDictionary{``0,``1})">
<summary>
Returns an <see cref="T:FluentAssertions.Collections.GenericDictionaryAssertions`2"/> object that can be used to assert the
current <see cref="T:System.Collections.Generic.IDictionary`2"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.DateTime)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.DateTimeOffsetAssertions"/> object that can be used to assert the
current <see cref="T:System.DateTime"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.DateTime})">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.NullableDateTimeOffsetAssertions"/> object that can be used to assert the
current nullable <see cref="T:System.DateTime"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should``1(System.IComparable{``0})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.ComparableTypeAssertions`1"/> object that can be used to assert the
current <see cref="T:System.IComparable`1"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Int32)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Int32"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.Int32})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Int32"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Decimal)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Decimal"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.Decimal})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Decimal"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Byte)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Byte"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.Byte})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Byte"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Int16)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Int16"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.Int16})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Int16"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Int64)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Int64"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.Int64})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Int64"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Single)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Single"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.Single})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Single"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Double)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Double"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.Double})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Double"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.String)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.StringAssertions"/> object that can be used to assert the
current <see cref="T:System.String"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.TimeSpan)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.SimpleTimeSpanAssertions"/> object that can be used to assert the
current <see cref="T:System.TimeSpan"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Nullable{System.TimeSpan})">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.NullableSimpleTimeSpanAssertions"/> object that can be used to assert the
current nullable <see cref="T:System.TimeSpan"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Type)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.TypeAssertions"/> object that can be used to assert the
current <see cref="T:System.Type"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(FluentAssertions.Types.TypeSelector)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.TypeAssertions"/> object that can be used to assert the
current <see cref="T:System.Type"/>.
</summary>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Reflection.MethodInfo)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.MethodInfoAssertions"/> object that can be used to assert the current <see cref="T:System.Reflection.MethodInfo"/>.
</summary>
<seealso cref="T:FluentAssertions.Types.TypeAssertions"/>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(FluentAssertions.Types.MethodInfoSelector)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.MethodInfoSelectorAssertions"/> object that can be used to assert the methods returned by the
current <see cref="T:FluentAssertions.Types.MethodInfoSelector"/>.
</summary>
<seealso cref="T:FluentAssertions.Types.TypeAssertions"/>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(System.Reflection.PropertyInfo)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.PropertyInfoAssertions"/> object that can be used to assert the
current <see cref="T:FluentAssertions.Types.PropertyInfoSelector"/>.
</summary>
<seealso cref="T:FluentAssertions.Types.TypeAssertions"/>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.Should(FluentAssertions.Types.PropertyInfoSelector)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.PropertyInfoAssertions"/> object that can be used to assert the properties returned by the
current <see cref="T:FluentAssertions.Types.PropertyInfoSelector"/>.
</summary>
<seealso cref="T:FluentAssertions.Types.TypeAssertions"/>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.ShouldBeEquivalentTo``1(``0,System.Object,System.String,System.Object[])">
<summary>
Asserts that an object is equivalent to another object.
</summary>
<remarks>
Objects are equivalent when both object graphs have equally named properties with the same value,
irrespective of the type of those objects. Two properties are also equal if one type can be converted to another and the result is equal.
The type of a collection property is ignored as long as the collection implements <see cref="T:System.Collections.IEnumerable"/> and all
items in the collection are structurally equal.
Notice that actual behavior is determined by the <see cref="F:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Default"/> instance of the
<see cref="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1"/> class.
</remarks>
<param name="because">
An optional formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the
assertion is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.ShouldBeEquivalentTo``1(``0,System.Object,System.Func{FluentAssertions.Equivalency.EquivalencyAssertionOptions{``0},FluentAssertions.Equivalency.EquivalencyAssertionOptions{``0}},System.String,System.Object[])">
<summary>
Asserts that an object is equivalent to another object.
</summary>
<remarks>
Objects are equivalent when both object graphs have equally named properties with the same value,
irrespective of the type of those objects. Two properties are also equal if one type can be converted to another and the result is equal.
The type of a collection property is ignored as long as the collection implements <see cref="T:System.Collections.IEnumerable"/> and all
items in the collection are structurally equal.
</remarks>
<param name="config">
A reference to the <see cref="F:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Default"/> configuration object that can be used
to influence the way the object graphs are compared. You can also provide an alternative instance of the
<see cref="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1"/> class.
</param>
<param name="because">
An optional formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the
assertion is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.InternalAssertionExtensions.As``1(System.Object)">
<summary>
Safely casts the specified object to the type specified through <typeparamref name="TTo"/>.
</summary>
<remarks>
Has been introduced to allow casting objects without breaking the fluent API.
</remarks>
<typeparam name="TTo"></typeparam>
</member>
<member name="M:FluentAssertions.Collections.GenericCollectionAssertions`1.BeInAscendingOrder(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},System.String,System.Object[])">
<summary>
Asserts that a collection is ordered in ascending order according to the value of the the specified
<paramref name="propertyExpression"/>.
</summary>
<param name="propertyExpression">
A lambda expression that references the property that should be used to determine the expected ordering.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="args">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericCollectionAssertions`1.BeInDescendingOrder(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},System.String,System.Object[])">
<summary>
Asserts that a collection is ordered in descending order according to the value of the the specified
<paramref name="propertyExpression"/>.
</summary>
<param name="propertyExpression">
A lambda expression that references the property that should be used to determine the expected ordering.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="args">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="T:FluentAssertions.Collections.GenericDictionaryAssertions`2">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Collections.Generic.IDictionary`2"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.HaveCount(System.Int32,System.String,System.Object[])">
<summary>
Asserts that the number of items in the dictionary matches the supplied <paramref name="expected"/> amount.
</summary>
<param name="expected">The expected number of items.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.HaveCount(System.Linq.Expressions.Expression{System.Func{System.Int32,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the number of items in the dictionary matches a condition stated by a predicate.
</summary>
<param name="countPredicate">The predicate which must be statisfied by the amount of items.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.BeEmpty(System.String,System.Object[])">
<summary>
Asserts that the dictionary does not contain any items.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.NotBeEmpty(System.String,System.Object[])">
<summary>
Asserts that the dictionary contains at least 1 item.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.Equal(System.Collections.Generic.IDictionary{`0,`1},System.String,System.Object[])">
<summary>
Asserts that the current dictionary contains all the same key-value pairs as the
specified <paramref name="expected"/> dictionary. Keys and values are compared using
their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected dictionary</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.NotEqual(System.Collections.Generic.IDictionary{`0,`1},System.String,System.Object[])">
<summary>
Asserts the current dictionary not to contain all the same key-value pairs as the
specified <paramref name="unexpected"/> dictionary. Keys and values are compared using
their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="unexpected">The unexpected dictionary</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.ContainKey(`0,System.String,System.Object[])">
<summary>
Asserts that the dictionary contains the specified key. Keys are compared using
their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected key</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.ContainKeys(`0[])">
<summary>
Asserts that the dictionary contains all of the specified keys. Keys are compared using
their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected keys</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.ContainKeys(System.Collections.Generic.IEnumerable{`0},System.String,System.Object[])">
<summary>
Asserts that the dictionary contains all of the specified keys. Keys are compared using
their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected keys</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.NotContainKey(`0,System.String,System.Object[])">
<summary>
Asserts that the current dictionary does not contain the specified <paramref name="unexpected"/> key.
Keys are compared using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="unexpected">The unexpected key</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.ContainValue(`1,System.String,System.Object[])">
<summary>
Asserts that the dictionary contains the specified value. Values are compared using
their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.ContainValues(`1[])">
<summary>
Asserts that the dictionary contains all of the specified values. Values are compared using
their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected values</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.ContainValues(System.Collections.Generic.IEnumerable{`1},System.String,System.Object[])">
<summary>
Asserts that the dictionary contains all of the specified values. Values are compared using
their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected values</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.RepetitionPreservingIntersect(System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})">
<summary>
Returns an enumerable consisting of all items in the first collection also appearing in the second.
</summary>
<remarks>Enumerable.Intersect is not suitable because it drops any repeated elements.</remarks>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.NotContainValue(`1,System.String,System.Object[])">
<summary>
Asserts that the current dictionary does not contain the specified <paramref name="unexpected"/> value.
Values are compared using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="unexpected">The unexpected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.Contain(System.Collections.Generic.KeyValuePair{`0,`1},System.String,System.Object[])">
<summary>
Asserts that the current dictionary contains the specified <paramref name="expected"/>.
Keys and values are compared using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected <see cref="T:System.Collections.Generic.KeyValuePair`2"/></param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.Contain(`0,`1,System.String,System.Object[])">
<summary>
Asserts that the current dictionary contains the specified <paramref name="value"/> for the supplied <paramref name="key"/>. Values are compared using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="key">The key for which to validate the value</param>
<param name="value">The value to validate</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.NotContain(System.Collections.Generic.KeyValuePair{`0,`1},System.String,System.Object[])">
<summary>
Asserts that the current dictionary does not contain the specified <paramref name="item"/>.
Keys and values are compared using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="item">The unexpected <see cref="T:System.Collections.Generic.KeyValuePair`2"/></param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.GenericDictionaryAssertions`2.NotContain(`0,`1,System.String,System.Object[])">
<summary>
Asserts that the current dictionary does not contain the specified <paramref name="value"/> for the
supplied <paramref name="key"/>. Values are compared using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="key">The key for which to validate the value</param>
<param name="value">The value to validate</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Collections.GenericDictionaryAssertions`2.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Collections.NonGenericCollectionAssertions">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Collections.IEnumerable"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Collections.NonGenericCollectionAssertions.HaveCount(System.Int32,System.String,System.Object[])">
<summary>
Asserts that the number of items in the collection matches the supplied <paramref name="expected"/> amount.
</summary>
<param name="expected">The expected number of items in the collection.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.NonGenericCollectionAssertions.HaveCount(System.Linq.Expressions.Expression{System.Func{System.Int32,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the number of items in the collection matches a condition stated by the <paramref name="countPredicate"/>.
</summary>
<param name="countPredicate">A predicate that yields the number of items that is expected to be in the collection.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.NonGenericCollectionAssertions.Contain(System.Object,System.String,System.Object[])">
<summary>
Asserts that the current collection contains the specified <paramref name="expected"/> object. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">An object, or <see cref="T:System.Collections.IEnumerable"/> of objects that are expected to be in the collection.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.Equal(System.String[])">
<summary>
Expects the current collection to contain all the same elements in the same order as the collection identified by
<paramref name="expected"/>. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="expected">An <see cref="!:IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.Equal(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Expects the current collection to contain all the same elements in the same order as the collection identified by
<paramref name="expected"/>. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="expected">An <see cref="!:IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.BeEquivalentTo(System.String[])">
<summary>
Expects the current collection to contain all elements of the collection identified by <paramref name="elements"/>,
regardless of the order. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="elements">A params array with the expected elements.</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.BeEquivalentTo(System.Collections.Generic.IEnumerable{System.String},System.String,System.Object[])">
<summary>
Expects the current collection to contain all elements of the collection identified by <paramref name="expected"/>,
regardless of the order. Elements are compared using their <see cref="M:System.Object.Equals(System.Object)"/>.
</summary>
<param name="expected">An <see cref="!:IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.ContainInOrder(System.String[])">
<summary>
Expects the current collection to contain the specified elements in the exact same order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">An <see cref="!:IEnumerable"/> with the expected elements.</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.ContainInOrder(System.Collections.Generic.IEnumerable{System.String},System.String,System.Object[])">
<summary>
Expects the current collection to contain the specified elements in the exact same order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">An <see cref="!:IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.Contain(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Expects the current collection to contain the specified elements in any order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">An <see cref="!:IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.Contain(System.Collections.Generic.IEnumerable{System.String},System.String,System.Object,System.Object[])">
<summary>
Expects the current collection to contain the specified elements in any order. Elements are compared
using their <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">An <see cref="!:IEnumerable"/> with the expected elements.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.Contain(System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Asserts that the collection contains some extra items in addition to the original items.
</summary>
<param name="expectedItemsList">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of expectation items.</param>
<param name="additionalExpectedItems">Additional items that are expectation to be contained by the collection.</param>
</member>
<member name="M:FluentAssertions.Collections.StringCollectionAssertions.Contain(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>
Asserts that the collection contains some extra items in addition to the original items.
</summary>
<param name="expectedItemsList">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of expectation items.</param>
<param name="additionalExpectedItems">Additional items that are expectation to be contained by the collection.</param>
</member>
<member name="P:FluentAssertions.Common.Configuration.Current">
<summary>
Gets the active configuration,
</summary>
</member>
<member name="P:FluentAssertions.Common.Configuration.ValueFormatterDetectionMode">
<summary>
Gets or sets the mode on how Fluent Assertions will find custom implementations of
<see cref="T:FluentAssertions.Formatting.IValueFormatter"/>.
</summary>
</member>
<member name="P:FluentAssertions.Common.Configuration.ValueFormatterAssembly">
<summary>
Gets or sets the assembly name to scan for custom value formatters in case <see cref="P:FluentAssertions.Common.Configuration.ValueFormatterDetectionMode"/>
is set to <see cref="!:ValueFormatterDetectionMode.Specific"/>.
</summary>
</member>
<member name="M:FluentAssertions.Common.ExpressionExtensions.GetPropertyPath``2(System.Linq.Expressions.Expression{System.Func{``0,``1}})">
<summary>
Gets a dotted path of property names representing the property expression. E.g. Parent.Child.Sibling.Name.
</summary>
</member>
<member name="T:FluentAssertions.Common.Services">
<summary>
Maintains the framework-specific services.
</summary>
</member>
<member name="M:FluentAssertions.Common.StringExtensions.IndexOfFirstMismatch(System.String,System.String)">
<summary>
Finds the first index at which the <paramref name="value"/> does not match the <paramref name="expected"/>
string anymore, including the exact casing.
</summary>
</member>
<member name="M:FluentAssertions.Common.StringExtensions.IndexOfFirstMismatch(System.String,System.String,System.StringComparison)">
<summary>
Finds the first index at which the <paramref name="value"/> does not match the <paramref name="expected"/>
string anymore, accounting for the specified <paramref name="stringComparison"/>.
</summary>
</member>
<member name="M:FluentAssertions.Common.StringExtensions.IndexedSegmentAt(System.String,System.Int32)">
<summary>
Gets the quoted three characters at the specified index of a string, including the index itself.
</summary>
</member>
<member name="M:FluentAssertions.Common.StringExtensions.Escape(System.String)">
<summary>
Replaces all characters that might conflict with formatting placeholders and newlines with their escaped counterparts.
</summary>
</member>
<member name="M:FluentAssertions.Common.StringExtensions.Combine(System.String,System.String,System.String)">
<summary>
Joins a string with one or more other strings using a specified separator.
</summary>
<remarks>
Any string that is empty (including the original string) is ignored.
</remarks>
</member>
<member name="M:FluentAssertions.Common.StringExtensions.Capitalize(System.String)">
<summary>
Changes the first character of a string to uppercase.
</summary>
</member>
<member name="M:FluentAssertions.Common.TypeExtensions.HasAttribute``1(System.Reflection.MemberInfo)">
<summary>
Determines whether the specified method has been annotated with a specific attribute.
</summary>
<returns>
<c>true</c> if the specified method has attribute; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Common.TypeExtensions.IsEquivalentTo(System.Reflection.PropertyInfo,System.Reflection.PropertyInfo)">
<summary>
Determines whether two <see cref="T:System.Reflection.PropertyInfo"/> objects refer to the same property.
</summary>
</member>
<member name="M:FluentAssertions.Common.TypeExtensions.FindProperty(System.Type,System.String,System.Type)">
<summary>
Finds the property by a case-sensitive name.
</summary>
<returns>
Returns <c>null</c> if no such property exists.
</returns>
</member>
<member name="T:FluentAssertions.Common.ValueFormatterDetectionMode">
<summary>
Defines the modes in which custom implementations of <see cref="!:IValueFormatter"/> are detected as configured
through <see cref="P:FluentAssertions.Common.Configuration.ValueFormatterDetectionMode"/>.
</summary>
</member>
<member name="F:FluentAssertions.Common.ValueFormatterDetectionMode.Disabled">
<summary>
Detection is disabled.
</summary>
</member>
<member name="F:FluentAssertions.Common.ValueFormatterDetectionMode.Specific">
<summary>
Only custom value formatters exposed through the assembly set in <see cref="P:FluentAssertions.Common.Configuration.ValueFormatterAssembly"/>
are detected.
</summary>
</member>
<member name="F:FluentAssertions.Common.ValueFormatterDetectionMode.Scan">
<summary>
All custom value formatters in any assembly loaded in the current <see cref="!:AppDomain"/> will be detected.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.AllDeclaredPublicPropertiesSelectionRule">
<summary>
Selection rule that adds all public properties of the subject as far as they are defined on the declared
type.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.AllDeclaredPublicPropertiesSelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Adds or removes properties to/from the collection of subject properties that must be included while
comparing two objects for structural equality.
</summary>
<param name="selectedProperties">
A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
<returns>
The collection of properties after applying this rule. Can contain less or more than was passed in.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.AllDeclaredPublicPropertiesSelectionRule.ToString">
<summary>
Returns a string that represents the current object.
</summary>
<returns>
A string that represents the current object.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="T:FluentAssertions.Equivalency.AllRuntimePublicPropertiesSelectionRule">
<summary>
Selection rule that adds all public properties of the subject based on its run-time type rather than its
declared type.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.AllRuntimePublicPropertiesSelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Adds or removes properties to/from the collection of subject properties that must be included while
comparing two objects for structural equality.
</summary>
<param name="selectedProperties">
A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
<returns>
The collection of properties after applying this rule. Can contain less or more than was passed in.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.AllRuntimePublicPropertiesSelectionRule.ToString">
<summary>
Returns a string that represents the current object.
</summary>
<returns>
A string that represents the current object.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="M:FluentAssertions.Equivalency.ApplyAssertionRulesEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.ApplyAssertionRulesEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="T:FluentAssertions.Equivalency.AssertionResultSet">
<summary>
Represents a collection of assertion results obtained through a <see cref="T:FluentAssertions.Execution.AssertionScope"/>.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.AssertionResultSet.AddSet(System.Object,System.String[])">
<summary>
Adds the failures (if any) resulting from executing an assertion within a
<see cref="T:FluentAssertions.Execution.AssertionScope"/> identified by a key.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.AssertionResultSet.SelectClosestMatchFor(System.Object)">
<summary>
Returns the closest match compared to the set identified by the provided <paramref name="key"/> or
an empty array if one of the results represents a succesful assertion.
</summary>
<remarks>
The closest match is the set that contains the least amount of failures, or no failures at all, and preferably
the set that is identified by the <paramref name="key"/>.
</remarks>
</member>
<member name="P:FluentAssertions.Equivalency.AssertionResultSet.ContainsSuccessfulSet">
<summary>
Gets a value indicating whether this collection contains a set without any failures at all.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.AssertionRule`1">
<summary>
General purpose implementation of <see cref="T:FluentAssertions.Equivalency.IAssertionRule"/> that uses a predicate to determine whether
this rule applies to a particular property and executes an action to assert equality.
</summary>
<typeparam name="TSubject">The type of the subject.</typeparam>
</member>
<member name="M:FluentAssertions.Equivalency.IAssertionRule.AssertEquality(FluentAssertions.Equivalency.IEquivalencyValidationContext)">
<summary>
Defines how a subject's property is compared for equality with the same property of the expectation.
</summary>
<param name="subjectProperty">
Provides details about the subject's property.
</param>
<param name="subject">
The value of the subject's property.
</param>
<param name="expectation">
The value of a property on expectation object that was identified
</param>
<returns>
Returns <c>true</c> if the rule was applied correctly and the assertion didn't cause any exceptions.
Returns <c>false</c> if this rule doesn't support the subject's type.
Throws if the rule did support the data type but assertion fails.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.AssertionRule`1.AssertEquality(FluentAssertions.Equivalency.IEquivalencyValidationContext)">
<summary>
Defines how a subject's property is compared for equality with the same property of the expectation.
</summary>
<param name="subjectProperty">
Provides details about the subject's property.
</param>
<param name="subject">
The value of the subject's property.
</param>
<param name="expectation">
The value of a property on expectation object that was identified
</param>
<returns>
Returns <c>true</c> if the rule was applied correctly and the assertion didn't cause any exceptions.
Returns <c>false</c> if this rule doesn't support the subject's type.
Throws if the rule did support the data type but assertion fails.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.AssertionRule`1.ToString">
<summary>
Returns a string that represents the current object.
</summary>
<returns>
A string that represents the current object.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="T:FluentAssertions.Equivalency.IAssertionContext`1">
<summary>
Provides the required information for executing an equality assertion between a subject and an expectation.
</summary>
<typeparam name="TSubject">The type of the subject.</typeparam>
</member>
<member name="P:FluentAssertions.Equivalency.IAssertionContext`1.SubjectProperty">
<summary>
Gets the <see cref="T:System.Reflection.PropertyInfo"/> of the property that returned the current object, or <c>null</c> if the current
object represents the root object.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IAssertionContext`1.Subject">
<summary>
Gets the value of the <see cref="P:FluentAssertions.Equivalency.IAssertionContext`1.SubjectProperty"/>
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IAssertionContext`1.Expectation">
<summary>
Gets the value of the expectation object that was matched with the subject using a <see cref="T:FluentAssertions.Equivalency.IMatchingRule"/>.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IAssertionContext`1.Reason">
<summary>
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IAssertionContext`1.ReasonArgs">
<summary>
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.ByteArrayOrderingRule">
<summary>
Ordering rule that ensures that byte arrays are always compared in strict ordering since it would cause a
severe performance impact otherwise.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.IOrderingRule">
<summary>
Defines a rule that is used to determine whether the order of items in collections is relevant or not.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.IOrderingRule.AppliesTo(FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Determines if ordering of the property refered to by the current <paramref name="subjectInfo"/> is relevant.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.StructuralEqualityEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.StructuralEqualityEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="T:FluentAssertions.Equivalency.CyclicReferenceHandling">
<summary>
Indication of how cyclic references should be handled when validating equality of nested properties.
</summary>
</member>
<member name="F:FluentAssertions.Equivalency.CyclicReferenceHandling.Ignore">
<summary>
Cyclic references will be ignored.
</summary>
</member>
<member name="F:FluentAssertions.Equivalency.CyclicReferenceHandling.ThrowException">
<summary>
Cyclic references will result in an exception.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.DictionaryEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.DictionaryEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.GenericEnumerableEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the verificationScope subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.GenericEnumerableEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="T:FluentAssertions.Equivalency.EnumerableEquivalencyValidator">
<summary>
Executes a single equivalency assertion on two collections, optionally recursive and with or without strict ordering.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1">
<summary>
Is responsible for the exact run-time behavior of a structural equality comparison.
</summary>
<typeparam name="TSubject">The type of the subject.</typeparam>
</member>
<member name="T:FluentAssertions.Equivalency.IEquivalencyAssertionOptions">
<summary>
Provides the run-time details of the <see cref="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1"/> class.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.SelectionRules">
<summary>
Gets an ordered collection of selection rules that define what properties are included.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.MatchingRules">
<summary>
Gets an ordered collection of matching rules that determine which subject properties are matched with which
expectation properties.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.AssertionRules">
<summary>
Gets an ordered collection of assertion rules that determine how subject properties are compared for equality with
expectation properties.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.IsRecursive">
<summary>
Gets or sets a value indicating whether or not the assertion must perform a deep comparison.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.AllowInfiniteRecursion">
<summary>
Gets a value indicating whether recursion is allowed to continue indefinitely.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.CyclicReferenceHandling">
<summary>
Gets value indicating how cyclic references should be handled. By default, it will throw an exception.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyAssertionOptions.OrderingRules">
<summary>
Gets an ordered collection of rules that determine whether or not the order of collections is important. By default,
ordering is irrelevant.
</summary>
</member>
<member name="F:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Empty">
<summary>
Gets a configuration that by default doesn't include any of the subject's properties and doesn't consider any nested objects
or collections.
</summary>
</member>
<member name="F:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Default">
<summary>
Gets a configuration that compares all declared properties of the subject with equally named properties of the expectation,
and includes the entire object graph. The names of the properties between the subject and expectation must match.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.IncludingAllDeclaredProperties">
<summary>
Adds all public properties of the subject as far as they are defined on the declared type.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.IncludingAllRuntimeProperties">
<summary>
Adds all public properties of the subject based on its run-time type rather than its declared type.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.ExcludingMissingProperties">
<summary>
Tries to match the properties of the subject with equally named properties on the expectation. Ignores those
properties that don't exist on the expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.ThrowingOnMissingProperties">
<summary>
Requires the expectation to have properties which are equally named to properties on the subject.
</summary>
<returns></returns>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Excluding(System.Linq.Expressions.Expression{System.Func{`0,System.Object}})">
<summary>
Excludes the specified (nested) property from the structural equality check.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Excluding(System.Linq.Expressions.Expression{System.Func{FluentAssertions.Equivalency.ISubjectInfo,System.Boolean}})">
<summary>
Excludes a (nested) property based on a predicate from the structural equality check.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Including(System.Linq.Expressions.Expression{System.Func{`0,System.Object}})">
<summary>
Includes the specified property in the equality check.
</summary>
<remarks>
This overrides the default behavior of including all declared properties.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Including(System.Linq.Expressions.Expression{System.Func{FluentAssertions.Equivalency.ISubjectInfo,System.Boolean}})">
<summary>
Includes the specified property in the equality check.
</summary>
<remarks>
This overrides the default behavior of including all declared properties.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Using``1(System.Action{FluentAssertions.Equivalency.IAssertionContext{``0}})">
<param name="action">
The assertion to execute when the predicate is met.
</param>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.IncludingNestedObjects">
<summary>
Causes the structural equality check to include nested collections and complex types.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.ExcludingNestedObjects">
<summary>
Causes the structural equality check to exclude nested collections and complex types.
</summary>
<remarks>
Behaves similarly to the old property assertions API.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.IgnoringCyclicReferences">
<summary>
Causes the structural equality check to ignore any cyclic references.
</summary>
<remarks>
By default, cyclic references within the object graph will cause an exception to be thrown.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.AllowingInfiniteRecursion">
<summary>
Disables limitations on recursion depth when the structural equality check is configured to include nested objects
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.WithoutSelectionRules">
<summary>
Clears all selection rules, including those that were added by default.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.WithoutMatchingRules">
<summary>
Clears all matching rules, including those that were added by default.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Using(FluentAssertions.Equivalency.ISelectionRule)">
<summary>
Adds a selection rule to the ones already added by default, and which is evaluated after all existing rules.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Using(FluentAssertions.Equivalency.IMatchingRule)">
<summary>
Adds a matching rule to the ones already added by default, and which is evaluated before all existing rules.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Using(FluentAssertions.Equivalency.IAssertionRule)">
<summary>
Adds a matching rule to the ones already added by default, and which is evaluated before all existing rules.
NOTE: These matching rules do not apply to the root object.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.WithStrictOrdering">
<summary>
Causes all collections to be compared in the order in which the items appear in the expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.WithStrictOrderingFor(System.Linq.Expressions.Expression{System.Func{`0,System.Object}})">
<summary>
Causes the collection identified by <paramref name="propertyExpression"/> to be compared in the order
in which the items appear in the expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.WithStrictOrderingFor(System.Linq.Expressions.Expression{System.Func{FluentAssertions.Equivalency.ISubjectInfo,System.Boolean}})">
<summary>
Causes the collection identified by the provided <paramref name="predicate"/> to be compared in the order
in which the items appear in the expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.ToString">
<summary>
Returns a string that represents the current object.
</summary>
<returns>
A string that represents the current object.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.FluentAssertions#Equivalency#IEquivalencyAssertionOptions#SelectionRules">
<summary>
Gets an ordered collection of selection rules that define what properties are included.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.FluentAssertions#Equivalency#IEquivalencyAssertionOptions#MatchingRules">
<summary>
Gets an ordered collection of matching rules that determine which subject properties are matched with which
expectation properties.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.FluentAssertions#Equivalency#IEquivalencyAssertionOptions#AssertionRules">
<summary>
Gets an ordered collection of assertion rules that determine how subject properties are compared for equality with
expectation properties.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.FluentAssertions#Equivalency#IEquivalencyAssertionOptions#OrderingRules">
<summary>
Gets an ordered collection of rules that determine whether or not the order of collections is important. By default,
ordering is irrelevant.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.FluentAssertions#Equivalency#IEquivalencyAssertionOptions#IsRecursive">
<summary>
Gets value indicating whether the equality check will include nested collections and complex types.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.FluentAssertions#Equivalency#IEquivalencyAssertionOptions#CyclicReferenceHandling">
<summary>
Gets value indicating how cyclic references should be handled. By default, it will throw an exception.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Restriction`1">
<summary>
Defines additional overrides when used with <see cref="!:EquivalencyAssertionOptions<TSubject>.When"/>
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Restriction`1.WhenTypeIs``1">
<summary>
Allows overriding the way structural equality is applied to (nested) objects of tyoe <typeparamref name="TPropertyType"/>
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Restriction`1.When(System.Linq.Expressions.Expression{System.Func{FluentAssertions.Equivalency.ISubjectInfo,System.Boolean}})">
<summary>
Allows overriding the way structural equality is applied to particular properties.
</summary>
<param name="predicate">
A predicate based on the <see cref="T:FluentAssertions.Equivalency.ISubjectInfo"/> of the subject that is used to identify the property for which the
override applies.
</param>
</member>
<member name="T:FluentAssertions.Equivalency.IEquivalencyValidationContext">
<summary>
Provides information on a particular property during an assertion for structural equality of two object graphs.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.ISubjectInfo">
<summary>
Provides details about the subject's root or nested property.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyInfo">
<summary>
Gets the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyInfo"/> of the property that returned the current object, or <c>null</c> if the current
object represents the root object.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyPath">
<summary>
Gets the full path from the root object until the current object separated by dots.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyDescription">
<summary>
Gets a display-friendly representation of the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyPath"/>.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.ISubjectInfo.CompileTimeType">
<summary>
Gets the compile-time type of the current object. If the current object is not the root object, then it returns the
same <see cref="T:System.Type"/> as the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.RuntimeType"/> property does.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.ISubjectInfo.RuntimeType">
<summary>
Gets the run-time type of the current object.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyValidationContext.Expectation">
<summary>
Gets the value of the <see cref="!:MatchingExpectationProperty"/>.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyValidationContext.Reason">
<summary>
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyValidationContext.ReasonArgs">
<summary>
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyValidationContext.IsRoot">
<summary>
Gets a value indicating whether the current context represents the root of the object graph.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.IEquivalencyValidationContext.Subject">
<summary>
Gets the value of the <see cref="!:ISelectionContext.PropertyInfo"/>
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.PropertyInfo">
<summary>
Gets the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyInfo"/> of the property that returned the current object, or
<c>null</c> if the current object represents the root object.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.PropertyPath">
<summary>
Gets the full path from the root object until the current property, separated by dots.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.PropertyDescription">
<summary>
Gets a textual description of the current property based on the <see cref="P:FluentAssertions.Equivalency.EquivalencyValidationContext.PropertyPath"/>.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.Subject">
<summary>
Gets the value of the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyInfo"/>
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.Expectation">
<summary>
Gets the value of the <see cref="!:IEquivalencyValidationContext.MatchingExpectationProperty"/>.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.Reason">
<summary>
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.ReasonArgs">
<summary>
Zero or more objects to format using the placeholders in <see cref="P:FluentAssertions.Equivalency.IEquivalencyValidationContext.Reason"/>.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.IsRoot">
<summary>
Gets a value indicating whether the current context represents the root of the object graph.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.CompileTimeType">
<summary>
Gets the compile-time type of the current object. If the current object is not the root object, then it returns the
same <see cref="T:System.Type"/> as the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.RuntimeType"/> property does.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidationContext.RuntimeType">
<summary>
Gets the run-time type of the current object.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.EquivalencyValidator">
<summary>
Is responsible for validating the equality of one or more properties of a subject with another object.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.EquivalencyValidator.Steps">
<summary>
Provides access the list of steps that are executed in the order of appearance during an equivalency test.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.ExcludePropertyByPathSelectionRule">
<summary>
Selection rule that removes a particular property from the structural comparison.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.ExcludePropertyByPathSelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Adds or removes properties to/from the collection of subject properties that must be included while
comparing two objects for structural equality.
</summary>
<param name="selectedProperties">
A collection of properties that was prepopulated by other selection rules. Can be empty.
</param>
<returns>
The collection of properties after applying this rule. Can contain less or more than was passed in.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.ExcludePropertyByPathSelectionRule.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="T:FluentAssertions.Equivalency.ExcludePropertyByPredicateSelectionRule">
<summary>
Selection rule that removes a particular property from the structural comparison based on a predicate.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.ExcludePropertyByPredicateSelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Adds or removes properties to/from the collection of subject properties that must be included while
comparing two objects for structural equality.
</summary>
<param name="selectedProperties">
A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
<returns>
The collection of properties after applying this rule. Can contain less or more than was passed in.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.ExcludePropertyByPredicateSelectionRule.ToString">
<summary>
Returns a string that represents the current object.
</summary>
<returns>
A string that represents the current object.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="T:FluentAssertions.Equivalency.IMatchingRule">
<summary>
Represents a rule that defines how to map the properties from the subject-under-test with the properties
on the expectation object.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.IMatchingRule.Match(System.Reflection.PropertyInfo,System.Object,System.String)">
<summary>
Attempts to find a property on the expectation that should be compared with the
<paramref name="subjectProperty"/> during a structural equality.
</summary>
<remarks>
Whether or not a match is required or optional is up to the specific rule. If no match is found and this is not an issue,
simply return <c>null</c>.
</remarks>
<param name="subjectProperty">
The <see cref="T:System.Reflection.PropertyInfo"/> of the subject's property for which a match must be found. Can never
be <c>null</c>.
</param>
<param name="expectation">
The expectation object for which a matching property must be returned. Can never be <c>null</c>.
</param>
<param name="propertyPath">
The dotted path from the root object to the current property. Will never be <c>null</c>.
</param>
<returns>
Returns the <see cref="T:System.Reflection.PropertyInfo"/> of the property with which to compare the subject with, or <c>null</c>
if no match was found.
</returns>
</member>
<member name="T:FluentAssertions.Equivalency.IncludePropertyByPathSelectionRule">
<summary>
Selection rule that includes a particular property in the structural comparison.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.IncludePropertyByPathSelectionRule.SelectProperties(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo},FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Adds or removes properties to/from the collection of subject properties that must be included while
comparing two objects for structural equality.
</summary>
<param name="selectedProperties">
A collection of properties that was prepopulated by other selection rules. Can be empty.</param>
<returns>
The collection of properties after applying this rule. Can contain less or more than was passed in.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.IncludePropertyByPathSelectionRule.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="T:FluentAssertions.Equivalency.MatchAllOrderingRule">
<summary>
An ordering rule that basically states that the order of items in all collections is important.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.MatchAllOrderingRule.AppliesTo(FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Determines if ordering of the property refered to by the current <paramref name="subjectInfo"/> is relevant.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.MustMatchByNameRule">
<summary>
Requires the expectation object to have a property with the exact same name.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.MustMatchByNameRule.Match(System.Reflection.PropertyInfo,System.Object,System.String)">
<summary>
Attempts to find a property on the expectation that should be compared with the
<paramref name="subjectProperty"/> during a structural equality.
</summary>
<remarks>
Whether or not a match is required or optional is up to the specific rule. If no match is found and this is not an issue,
simply return <c>null</c>.
</remarks>
<param name="subjectProperty">
The <see cref="T:System.Reflection.PropertyInfo"/> of the subject's property for which a match must be found. Can never
be <c>null</c>.
</param>
<param name="expectation">
The expectation object for which a matching property must be returned. Can never be <c>null</c>.
</param>
<param name="propertyPath">
The dotted path from the root object to the current property. Will never be <c>null</c>.
</param>
<returns>
Returns the <see cref="T:System.Reflection.PropertyInfo"/> of the property with which to compare the subject with, or <c>null</c>
if no match was found.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.MustMatchByNameRule.ToString">
<summary>
Returns a string that represents the current object.
</summary>
<returns>
A string that represents the current object.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="T:FluentAssertions.Equivalency.NestedSelectionContext">
<summary>
Represents a selection context of a nested property
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.NestedSelectionContext.PropertyInfo">
<summary>
Gets the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyInfo"/> of the property that returned the current object, or
<c>null</c> if the current object represents the root object.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.NestedSelectionContext.PropertyPath">
<summary>
Gets the full path from the root object until the current property, separated by dots.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.NestedSelectionContext.PropertyDescription">
<summary>
Gets a textual description of the current property based on the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.PropertyPath"/>.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.NestedSelectionContext.CompileTimeType">
<summary>
Gets the compile-time type of the current object. If the current object is not the root object, then it returns the
same <see cref="T:System.Type"/> as the <see cref="P:FluentAssertions.Equivalency.ISubjectInfo.RuntimeType"/> property does.
</summary>
</member>
<member name="P:FluentAssertions.Equivalency.NestedSelectionContext.RuntimeType">
<summary>
Gets the run-time type of the current object.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.ObjectReference">
<summary>
Represents an object tracked by the <see cref="T:FluentAssertions.Equivalency.ObjectTracker"/> including it's location within an object graph.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.ObjectReference.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
</summary>
<returns>
true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
</returns>
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>. </param><filterpriority>2</filterpriority>
</member>
<member name="M:FluentAssertions.Equivalency.ObjectReference.GetHashCode">
<summary>
Serves as a hash function for a particular type.
</summary>
<returns>
A hash code for the current <see cref="T:System.Object"/>.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="T:FluentAssertions.Equivalency.ObjectTracker">
<summary>
Keeps track of objects and their location within an object graph so that cyclic references can be detected
and handled upon.
</summary>
</member>
<member name="T:FluentAssertions.Execution.ICloneable2">
<summary>
Custom version of ICloneable that works on all frameworks.
</summary>
</member>
<member name="M:FluentAssertions.Execution.ICloneable2.Clone">
<summary>
Creates a new object that is a copy of the current instance.
</summary>
<returns>
A new object that is a copy of this instance.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.ObjectTracker.IsCyclicReference(FluentAssertions.Equivalency.ObjectReference)">
<summary>
Determines whether the specified object reference is a cyclic reference to the same object earlier in the
equivalency validation.
</summary>
<remarks>
The behavior of a cyclic reference is determined byt he <see cref="T:FluentAssertions.Equivalency.CyclicReferenceHandling"/> constructor
parameter.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.ObjectTracker.Clone">
<summary>
Creates a new object that is a copy of the current instance.
</summary>
<returns>
A new object that is a copy of this instance.
</returns>
</member>
<member name="T:FluentAssertions.Equivalency.OrderingRuleCollection">
<summary>
Collection of <see cref="T:FluentAssertions.Equivalency.PropertyPathOrderingRule"/>s.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.OrderingRuleCollection.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
</returns>
<filterpriority>1</filterpriority>
</member>
<member name="M:FluentAssertions.Equivalency.OrderingRuleCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="M:FluentAssertions.Equivalency.OrderingRuleCollection.IsOrderingStrictFor(FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Determines whether the rules in this collection dictate strict ordering during the equivalency assertion on
the collection pointed to by <paramref name="subjectInfo"/>.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.PredicateBasedOrderingRule.AppliesTo(FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Determines if ordering of the property refered to by the current <paramref name="subjectInfo"/> is relevant.
</summary>
</member>
<member name="T:FluentAssertions.Equivalency.PropertyPathOrderingRule">
<summary>
Represents a rule for determining whether or not a certain collection within the object graph should be compared using
strict ordering.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.PropertyPathOrderingRule.AppliesTo(FluentAssertions.Equivalency.ISubjectInfo)">
<summary>
Determines if ordering of the property refered to by the current <paramref name="subjectInfo"/> is relevant.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.ReferenceEqualityEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.ReferenceEqualityEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.SimpleEqualityEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.SimpleEqualityEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="M:FluentAssertions.Equivalency.TryConversionEquivalencyStep.CanHandle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Gets a value indicating whether this step can handle the current subject and/or expectation.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.TryConversionEquivalencyStep.Handle(FluentAssertions.Equivalency.EquivalencyValidationContext,FluentAssertions.Equivalency.IEquivalencyValidator,FluentAssertions.Equivalency.IEquivalencyAssertionOptions)">
<summary>
Applies a step as part of the task to compare two objects for structural equality.
</summary>
<value>
Should return <c>true</c> if the subject matches the expectation or if no additional assertions
have to be executed. Should return <c>false</c> otherwise.
</value>
<remarks>
May throw when preconditions are not met or if it detects mismatching data.
</remarks>
</member>
<member name="T:FluentAssertions.Equivalency.TryMatchByNameRule">
<summary>
Finds a property of the expectation with the exact same name, but doesn't require it.
</summary>
</member>
<member name="M:FluentAssertions.Equivalency.TryMatchByNameRule.Match(System.Reflection.PropertyInfo,System.Object,System.String)">
<summary>
Attempts to find a property on the expectation that should be compared with the
<paramref name="subjectProperty"/> during a structural equality.
</summary>
<remarks>
Whether or not a match is required or optional is up to the specific rule. If no match is found and this is not an issue,
simply return <c>null</c>.
</remarks>
<param name="subjectProperty">
The <see cref="T:System.Reflection.PropertyInfo"/> of the subject's property for which a match must be found. Can never
be <c>null</c>.
</param>
<param name="expectation">
The expectation object for which a matching property must be returned. Can never be <c>null</c>.
</param>
<param name="propertyPath">
The dotted path from the root object to the current property. Will never be <c>null</c>.
</param>
<returns>
Returns the <see cref="T:System.Reflection.PropertyInfo"/> of the property with which to compare the subject with, or <c>null</c>
if no match was found.
</returns>
</member>
<member name="M:FluentAssertions.Equivalency.TryMatchByNameRule.ToString">
<summary>
Returns a string that represents the current object.
</summary>
<returns>
A string that represents the current object.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="T:FluentAssertions.Events.EventMonitor">
<summary>
</summary>
</member>
<member name="M:FluentAssertions.Events.EventMonitor.GetRecorderForEvent``1(``0,System.String)">
<summary>
Obtains the <see cref="T:FluentAssertions.Events.EventRecorder"/> for a particular event of the <paramref name="eventSource"/>.
</summary>
<param name="eventSource">The object for which to get an event recorder.</param>
<param name="eventName">The name of the event.</param>
<returns></returns>
</member>
<member name="T:FluentAssertions.Events.EventRecorder">
<summary>
Records activity for a single event.
</summary>
</member>
<member name="T:FluentAssertions.Events.IEventRecorder">
<summary>
Records raised events for one event on one object
</summary>
</member>
<member name="M:FluentAssertions.Events.IEventRecorder.RecordEvent(System.Object[])">
<summary>
Store information about a raised event
</summary>
<param name = "parameters">Parameters the event was raised with</param>
</member>
<member name="P:FluentAssertions.Events.IEventRecorder.EventObject">
<summary>
The object events are recorded from
</summary>
</member>
<member name="P:FluentAssertions.Events.IEventRecorder.EventName">
<summary>
The name of the event that's recorded
</summary>
</member>
<member name="M:FluentAssertions.Events.EventRecorder.#ctor(System.Object,System.String)">
<summary>
</summary>
<param name = "eventRaiser">The object events are recorded from</param>
<param name = "eventName">The name of the event that's recorded</param>
</member>
<member name="M:FluentAssertions.Events.EventRecorder.GetEnumerator">
<summary>
Enumerate raised events
</summary>
</member>
<member name="M:FluentAssertions.Events.EventRecorder.System#Collections#IEnumerable#GetEnumerator">
<summary>
Enumerate raised events
</summary>
<returns></returns>
</member>
<member name="M:FluentAssertions.Events.EventRecorder.RecordEvent(System.Object[])">
<summary>
Called by the auto-generated IL, to record information about a raised event.
</summary>
</member>
<member name="P:FluentAssertions.Events.EventRecorder.EventObject">
<summary>
The object events are recorded from
</summary>
</member>
<member name="P:FluentAssertions.Events.EventRecorder.EventName">
<summary>
The name of the event that's recorded
</summary>
</member>
<member name="T:FluentAssertions.Events.EventRecordersMap">
<summary>
Simple dictionary that uses a <see cref="T:System.WeakReference"/> to the event source as the key.
This should ensure the Garbage Collector can still clean-up the event source object.
</summary>
</member>
<member name="T:FluentAssertions.Events.RecordedEvent">
<summary>
This class is used to store data about an intercepted event
</summary>
</member>
<member name="M:FluentAssertions.Events.RecordedEvent.#ctor(System.Object,System.Object[])">
<summary>
Default constructor stores the parameters the event was raised with
</summary>
</member>
<member name="P:FluentAssertions.Events.RecordedEvent.Parameters">
<summary>
Parameters for the event
</summary>
</member>
<member name="T:FluentAssertions.Execution.AssertionScope">
<summary>
Represents an implicit or explicit scope within which multiple assertions can be collected.
</summary>
</member>
<member name="F:FluentAssertions.Execution.AssertionScope.ReasonTag">
<summary>
Represents the phrase that can be used in <see cref="M:FluentAssertions.Execution.AssertionScope.FailWith(System.String,System.Object[])"/> as a placeholder for the reason of an assertion.
</summary>
</member>
<member name="M:FluentAssertions.Execution.AssertionScope.#ctor">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Execution.AssertionScope"/> class.
</summary>
</member>
<member name="M:FluentAssertions.Execution.AssertionScope.ForCondition(System.Boolean)">
<summary>
Specify the condition that must be satisfied.
</summary>
<param name="condition">If <c>true</c> the assertion will be succesful.</param>
</member>
<member name="M:FluentAssertions.Execution.AssertionScope.BecauseOf(System.String,System.Object[])">
<summary>
Specify the reason why you expect the condition to be <c>true</c>.
</summary>
<param name="because">
A formatted phrase explaining why the condition should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Execution.AssertionScope.FailWith(System.String,System.Object[])">
<summary>
Define the failure message for the assertion.
</summary>
<remarks>
If the <paramref name="failureMessage"/> contains the text "{reason}", this will be replaced by the reason as
defined through <see cref="M:FluentAssertions.Execution.AssertionScope.BecauseOf(System.String,System.Object[])"/>. Only 10 <paramref name="failureArgs"/> are supported in combination with
a {reason}.
</remarks>
<param name="failureMessage">The format string that represents the failure message.</param>
<param name="failureArgs">Optional arguments for the <paramref name="failureMessage"/></param>
</member>
<member name="M:FluentAssertions.Execution.AssertionScope.Discard">
<summary>
Discards and returns the failures that happened up to now.
</summary>
</member>
<member name="M:FluentAssertions.Execution.AssertionScope.Dispose">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
</member>
<member name="M:FluentAssertions.Execution.AssertionScope.Get``1(System.String)">
<summary>
Gets data associated with the current scope and identified by <paramref name="key"/>.
</summary>
</member>
<member name="P:FluentAssertions.Execution.AssertionScope.UsingLineBreaks">
<summary>
Indicates that every argument passed into <see cref="M:FluentAssertions.Execution.AssertionScope.FailWith(System.String,System.Object[])"/> is displayed on a separate line.
</summary>
</member>
<member name="T:FluentAssertions.Execution.IAssertionStrategy">
<summary>
Defines a strategy for handling failures in a <see cref="T:FluentAssertions.Execution.AssertionScope"/>.
</summary>
</member>
<member name="M:FluentAssertions.Execution.IAssertionStrategy.HandleFailure(System.String)">
<summary>
Instructs the strategy to handle a assertion failure.
</summary>
</member>
<member name="M:FluentAssertions.Execution.IAssertionStrategy.DiscardFailures">
<summary>
Discards and returns the failure messages that happened up to now.
</summary>
</member>
<member name="M:FluentAssertions.Execution.IAssertionStrategy.ThrowIfAny(System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Will throw a combined exception for any failures have been collected since <see cref="!:StartCollecting"/> was called.
</summary>
</member>
<member name="P:FluentAssertions.Execution.IAssertionStrategy.FailureMessages">
<summary>
Returns the messages for the assertion failures that happened until now.
</summary>
</member>
<member name="M:FluentAssertions.Execution.CollectingAssertionStrategy.DiscardFailures">
<summary>
Discards and returns the failure messages that happened up to now.
</summary>
</member>
<member name="M:FluentAssertions.Execution.CollectingAssertionStrategy.ThrowIfAny(System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Will throw a combined exception for any failures have been collected since <see cref="!:StartCollecting"/> was called.
</summary>
</member>
<member name="M:FluentAssertions.Execution.CollectingAssertionStrategy.HandleFailure(System.String)">
<summary>
Instructs the strategy to handle a assertion failure.
</summary>
</member>
<member name="P:FluentAssertions.Execution.CollectingAssertionStrategy.FailureMessages">
<summary>
Returns the messages for the assertion failures that happened until now.
</summary>
</member>
<member name="T:FluentAssertions.Execution.ContextDataItems">
<summary>
Represents a collection of data items that are associated with an <see cref="T:FluentAssertions.Execution.AssertionScope"/>.
</summary>
</member>
<member name="M:FluentAssertions.Execution.DefaultAssertionStrategy.HandleFailure(System.String)">
<summary>
Instructs the strategy to handle a assertion failure.
</summary>
</member>
<member name="M:FluentAssertions.Execution.DefaultAssertionStrategy.DiscardFailures">
<summary>
Discards and returns the failure messages that happened up to now.
</summary>
</member>
<member name="M:FluentAssertions.Execution.DefaultAssertionStrategy.ThrowIfAny(System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Will throw a combined exception for any failures have been collected since <see cref="!:StartCollecting"/> was called.
</summary>
</member>
<member name="P:FluentAssertions.Execution.DefaultAssertionStrategy.FailureMessages">
<summary>
Returns the messages for the assertion failures that happened until now.
</summary>
</member>
<member name="T:FluentAssertions.Execution.Execute">
<summary>
Helper class for verifying a condition and/or throwing a test harness specific exception representing an assertion failure.
</summary>
</member>
<member name="P:FluentAssertions.Execution.Execute.Assertion">
<summary>
Gets an object that wraps and executes a conditional or unconditional assertion.
</summary>
</member>
<member name="T:FluentAssertions.Execution.Reportability">
<summary>
Determines whether data associated with an <see cref="T:FluentAssertions.Execution.AssertionScope"/> should be included in the assertion failure.
</summary>
</member>
<member name="T:FluentAssertions.FluentDateTimeExtensions">
<summary>
Extension methods on <see cref="T:System.Int32"/> to allow for a more fluent way of specifying a <see cref="T:System.DateTime"/>.
</summary>
<example>
Instead of<br/>
<br/>
new DateTime(2011, 3, 10)<br/>
<br/>
you can write 3.March(2011)<br/>
<br/>
Or even<br/>
<br/>
3.March(2011).At(09, 30)
</example>
<seealso cref="T:FluentAssertions.TimeSpanConversionExtensions"/>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.January(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month January.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.February(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month February.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.March(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month March.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.April(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month April.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.May(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month May.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.June(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month June.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.July(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month July.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.August(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month August.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.September(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month September.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.October(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month October.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.November(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month November.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.December(System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="day"/> and <paramref name="year"/>
in the month December.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.At(System.DateTime,System.TimeSpan)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="date"/> and <paramref name="time"/>.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.At(System.DateTime,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value for the specified <paramref name="date"/> and time with the specified
<paramref name="hours"/>, <paramref name="minutes"/> and optionally <paramref name="seconds"/>.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.Before(System.TimeSpan,System.DateTime)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value that is the current <see cref="T:System.TimeSpan"/> before the
specified <paramref name="sourceDateTime"/>.
</summary>
</member>
<member name="M:FluentAssertions.FluentDateTimeExtensions.After(System.TimeSpan,System.DateTime)">
<summary>
Returns a new <see cref="T:System.DateTime"/> value that is the current <see cref="T:System.TimeSpan"/> after the
specified <paramref name="sourceDateTime"/>.
</summary>
</member>
<member name="M:FluentAssertions.Formatting.IValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.IValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.AggregateExceptionValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.AggregateExceptionValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="T:FluentAssertions.Formatting.AttributeBasedFormatter">
<summary>
Specialized value formatter that looks for static methods in the caller's assembly marked with the
<see cref="T:FluentAssertions.Formatting.ValueFormatterAttribute"/>.
</summary>
</member>
<member name="M:FluentAssertions.Formatting.AttributeBasedFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.AttributeBasedFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.DateTimeOffsetValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.DateTimeOffsetValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.DefaultValueFormatter.CanHandle(System.Object)">
<summary>
Determines whether this instance can handle the specified value.
</summary>
<param name = "value">The value.</param>
<returns>
<c>true</c> if this instance can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.DefaultValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.EnumerableValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.EnumerableValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.ExceptionValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.ExceptionValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.ExpressionValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.ExpressionValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="T:FluentAssertions.Formatting.Formatter">
<summary>
Provides services for formatting an object being used in an assertion in a human readable format.
</summary>
</member>
<member name="M:FluentAssertions.Formatting.Formatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a human-readable representation of a particular object.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<param name="useLineBreaks">
Indicates whether the formatter should use line breaks when the specific <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> supports it.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.Formatter.RemoveFormatter(FluentAssertions.Formatting.IValueFormatter)">
<summary>
Removes a custom formatter that was previously added though <see cref="M:FluentAssertions.Formatting.Formatter.AddFormatter(FluentAssertions.Formatting.IValueFormatter)"/>.
</summary>
</member>
<member name="M:FluentAssertions.Formatting.Formatter.AddFormatter(FluentAssertions.Formatting.IValueFormatter)">
<summary>
Ensures a custom formatter is included in the chain, just before the default formatter is executed.
</summary>
</member>
<member name="M:FluentAssertions.Formatting.Formatter.AddPlatformFormatters(FluentAssertions.Formatting.IValueFormatter[])">
<summary>
Allows a platform-specific assembly to add formatters without affecting the ones added by callers of <see cref="M:FluentAssertions.Formatting.Formatter.AddFormatter(FluentAssertions.Formatting.IValueFormatter)"/>.
</summary>
<param name="formatters"></param>
</member>
<member name="P:FluentAssertions.Formatting.Formatter.Formatters">
<summary>
A list of objects responsible for formatting the objects represented by placeholders.
</summary>
</member>
<member name="M:FluentAssertions.Formatting.GuidValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.GuidValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.NullValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.NullValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.NumericValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.NumericValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.PropertyInfoFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.PropertyInfoFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.StringValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.StringValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.TimeSpanValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.TimeSpanValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="T:FluentAssertions.Formatting.ValueFormatterAttribute">
<summary>
Marks a static method as a kind of <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> for a particular type.
</summary>
</member>
<member name="T:FluentAssertions.NumericAssertionsExtensions">
<summary>
Contains a number of extension methods for floating point <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/>.
</summary>
</member>
<member name="M:FluentAssertions.NumericAssertionsExtensions.BeApproximately(FluentAssertions.Numeric.NullableNumericAssertions{System.Single},System.Single,System.Single,System.String,System.Object[])">
<summary>
Asserts a floating point value approximates another value as close as possible.
</summary>
<param name="parent">The <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that is being extended.</param>
<param name="expectedValue">
The expected value to compare the actual value with.
</param>
<param name="precision">
The maximum amount of which the two values may differ.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.NumericAssertionsExtensions.BeApproximately(FluentAssertions.Numeric.NumericAssertions{System.Single},System.Single,System.Single,System.String,System.Object[])">
<summary>
Asserts a floating point value approximates another value as close as possible.
</summary>
<param name="parent">The <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that is being extended.</param>
<param name="expectedValue">
The expected value to compare the actual value with.
</param>
<param name="precision">
The maximum amount of which the two values may differ.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.NumericAssertionsExtensions.BeApproximately(FluentAssertions.Numeric.NullableNumericAssertions{System.Double},System.Double,System.Double,System.String,System.Object[])">
<summary>
Asserts a double value approximates another value as close as possible.
</summary>
<param name="parent">The <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that is being extended.</param>
<param name="expectedValue">
The expected value to compare the actual value with.
</param>
<param name="precision">
The maximum amount of which the two values may differ.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.NumericAssertionsExtensions.BeApproximately(FluentAssertions.Numeric.NumericAssertions{System.Double},System.Double,System.Double,System.String,System.Object[])">
<summary>
Asserts a double value approximates another value as close as possible.
</summary>
<param name="parent">The <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that is being extended.</param>
<param name="expectedValue">
The expected value to compare the actual value with.
</param>
<param name="precision">
The maximum amount of which the two values may differ.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.NumericAssertionsExtensions.BeApproximately(FluentAssertions.Numeric.NullableNumericAssertions{System.Decimal},System.Decimal,System.Decimal,System.String,System.Object[])">
<summary>
Asserts a decimal value approximates another value as close as possible.
</summary>
<param name="parent">The <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that is being extended.</param>
<param name="expectedValue">
The expected value to compare the actual value with.
</param>
<param name="precision">
The maximum amount of which the two values may differ.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.NumericAssertionsExtensions.BeApproximately(FluentAssertions.Numeric.NumericAssertions{System.Decimal},System.Decimal,System.Decimal,System.String,System.Object[])">
<summary>
Asserts a decimal value approximates another value as close as possible.
</summary>
<param name="parent">The <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that is being extended.</param>
<param name="expectedValue">
The expected value to compare the actual value with.
</param>
<param name="precision">
The maximum amount of which the two values may differ.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="T:FluentAssertions.Numeric.ComparableTypeAssertions`1">
<summary>
Contains a number of methods to assert that an <see cref="T:System.IComparable`1"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.Be(`0,System.String,System.Object[])">
<summary>
Asserts that the subject is considered equal to another object according to the implementation of <see cref="T:System.IComparable`1"/>.
</summary>
<param name="expected">
The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.NotBe(`0,System.String,System.Object[])">
<summary>
Asserts that the subject is not equal to another object according to its implementation of <see cref="T:System.IComparable`1"/>.
</summary>
<param name="expected">
The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeLessThan(`0,System.String,System.Object[])">
<summary>
Asserts that the subject is less than another object according to its implementation of <see cref="T:System.IComparable`1"/>.
</summary>
<param name="expected">
The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeLessOrEqualTo(`0,System.String,System.Object[])">
<summary>
Asserts that the subject is less than or equal to another object according to its implementation of <see cref="T:System.IComparable`1"/>.
</summary>
<param name="expected">
The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeGreaterThan(`0,System.String,System.Object[])">
<summary>
Asserts that the subject is greater than another object according to its implementation of <see cref="T:System.IComparable`1"/>.
</summary>
<param name="expected">
The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeGreaterOrEqualTo(`0,System.String,System.Object[])">
<summary>
Asserts that the subject is greater than or equal to another object according to its implementation of <see cref="T:System.IComparable`1"/>.
</summary>
<param name="expected">
The object to pass to the subject's <see cref="M:System.IComparable`1.CompareTo(`0)"/> method.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.ComparableTypeAssertions`1.BeInRange(`0,`0,System.String,System.Object[])">
<summary>
Asserts that a value is within a range.
</summary>
<remarks>
Where the range is continuous or incremental depends on the actual type of the value.
</remarks>
<param name="minimumValue">
The minimum valid value of the range.
</param>
<param name="maximumValue">
The maximum valid value of the range.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Numeric.ComparableTypeAssertions`1.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Numeric.NumericAssertions`1">
<summary>
Contains a number of methods to assert that an <see cref="T:System.IComparable"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.Be(`0,System.String,System.Object[])">
<summary>
Asserts that the integral number value is exactly the same as the <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.Be(System.Nullable{`0},System.String,System.Object[])">
<summary>
Asserts that the integral number value is exactly the same as the <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.NotBe(`0,System.String,System.Object[])">
<summary>
Asserts that the integral number value is not the same as the <paramref name="unexpected"/> value.
</summary>
<param name="unexpected">The unexpected value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.NotBe(System.Nullable{`0},System.String,System.Object[])">
<summary>
Asserts that the integral number value is not the same as the <paramref name="unexpected"/> value.
</summary>
<param name="unexpected">The unexpected value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.BePositive(System.String,System.Object[])">
<summary>
Asserts that the numeric value is greater than or equal to zero.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.BeNegative(System.String,System.Object[])">
<summary>
Asserts that the numeric value is less than zero.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.BeLessThan(`0,System.String,System.Object[])">
<summary>
Asserts that the numeric value is less than the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The value to compare the current numeric value with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.BeLessOrEqualTo(`0,System.String,System.Object[])">
<summary>
Asserts that the numeric value is less than or equal to the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The value to compare the current numeric value with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.BeGreaterThan(`0,System.String,System.Object[])">
<summary>
Asserts that the numeric value is greater than the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The value to compare the current numeric value with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.BeGreaterOrEqualTo(`0,System.String,System.Object[])">
<summary>
Asserts that the numeric value is greater than or equal to the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The value to compare the current numeric value with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.BeInRange(`0,`0,System.String,System.Object[])">
<summary>
Asserts that a value is within a range.
</summary>
<remarks>
Where the range is continuous or incremental depends on the actual type of the value.
</remarks>
<param name="minimumValue">
The minimum valid value of the range.
</param>
<param name="maximumValue">
The maximum valid value of the range.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.BeOneOf(`0[])">
<summary>
Asserts that a value is one of the specified <paramref name="validValues"/>.
</summary>
<param name="validValues">
The values that are valid.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NumericAssertions`1.BeOneOf(System.Collections.Generic.IEnumerable{`0},System.String,System.Object[])">
<summary>
Asserts that a value is one of the specified <paramref name="validValues"/>.
</summary>
<param name="validValues">
The values that are valid.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NullableNumericAssertions`1.HaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable numeric value is not <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Numeric.NullableNumericAssertions`1.NotHaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable numeric value is <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="T:FluentAssertions.Primitives.BooleanAssertions">
<summary>
Contains a number of methods to assert that a <see cref="T:System.Boolean"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.BooleanAssertions.BeFalse(System.String,System.Object[])">
<summary>
Asserts that the value is <c>false</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.BooleanAssertions.BeTrue(System.String,System.Object[])">
<summary>
Asserts that the value is <c>true</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.BooleanAssertions.Be(System.Boolean,System.String,System.Object[])">
<summary>
Asserts that the value is equal to the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Primitives.BooleanAssertions.Subject">
<summary>
Gets the object which value is being asserted.
</summary>
</member>
<member name="T:FluentAssertions.Primitives.DateTimeOffsetAssertions">
<summary>
Contains a number of methods to assert that a <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is in the expected state.
</summary>
<remarks>
You can use the <see cref="T:FluentAssertions.FluentDateTimeExtensions"/> for a more fluent way of specifying a <see cref="T:System.DateTime"/>.
</remarks>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.Be(System.DateTime,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is exactly equal to the <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.Be(System.DateTimeOffset,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is exactly equal to the <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.NotBe(System.DateTime,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is not equal to the <paramref name="unexpected"/> value.
</summary>
<param name="unexpected">The unexpected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.NotBe(System.DateTimeOffset,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is not equal to the <paramref name="unexpected"/> value.
</summary>
<param name="unexpected">The unexpected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeCloseTo(System.DateTime,System.Int32,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is within the specified number of milliseconds (default = 20 ms)
from the specified <paramref name="nearbyTime"/> value.
</summary>
<remarks>
Use this assertion when, for example the database truncates datetimes to nearest 20ms. If you want to assert to the exact datetime,
use <see cref="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.Be(System.DateTime,System.String,System.Object[])"/>.
</remarks>
<param name="nearbyTime">
The expected time to compare the actual value with.
</param>
<param name="precision">
The maximum amount of milliseconds which the two values may differ.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeCloseTo(System.DateTimeOffset,System.Int32,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is within the specified number of milliseconds (default = 20 ms)
from the specified <paramref name="nearbyTime"/> value.
</summary>
<remarks>
Use this assertion when, for example the database truncates datetimes to nearest 20ms. If you want to assert to the exact datetime,
use <see cref="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.Be(System.DateTime,System.String,System.Object[])"/>.
</remarks>
<param name="nearbyTime">
The expected time to compare the actual value with.
</param>
<param name="precision">
The maximum amount of milliseconds which the two values may differ.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeBefore(System.DateTime,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is before the specified value.
</summary>
<param name="expected">The <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> that the current value is expected to be before.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeBefore(System.DateTimeOffset,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is before the specified value.
</summary>
<param name="expected">The <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> that the current value is expected to be before.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeOnOrBefore(System.DateTime,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is either on, or before the specified value.
</summary>
<param name="expected">The <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> that the current value is expected to be on or before.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeOnOrBefore(System.DateTimeOffset,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is either on, or before the specified value.
</summary>
<param name="expected">The <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> that the current value is expected to be on or before.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeAfter(System.DateTime,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is after the specified value.
</summary>
<param name="expected">The <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> that the current value is expected to be after.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeAfter(System.DateTimeOffset,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is after the specified value.
</summary>
<param name="expected">The <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> that the current value is expected to be after.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeOnOrAfter(System.DateTime,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is either on, or after the specified value.
</summary>
<param name="expected">The <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> that the current value is expected to be on or after.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeOnOrAfter(System.DateTimeOffset,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is either on, or after the specified value.
</summary>
<param name="expected">The <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> that the current value is expected to be on or after.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.HaveYear(System.Int32,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> has the <paramref name="expected"/> year.
</summary>
<param name="expected">The expected year of the current value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.HaveMonth(System.Int32,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> has the <paramref name="expected"/> month.
</summary>
<param name="expected">The expected month of the current value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.HaveDay(System.Int32,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> has the <paramref name="expected"/> day.
</summary>
<param name="expected">The expected day of the current value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.HaveHour(System.Int32,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> has the <paramref name="expected"/> hour.
</summary>
<param name="expected">The expected hour of the current value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.HaveMinute(System.Int32,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> has the <paramref name="expected"/> minute.
</summary>
<param name="expected">The expected minutes of the current value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.HaveSecond(System.Int32,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> has the <paramref name="expected"/> second.
</summary>
<param name="expected">The expected seconds of the current value.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeMoreThan(System.TimeSpan)">
<summary>
Returns a <see cref="T:FluentAssertions.Primitives.TimeSpanAssertions"/> object that can be used to assert that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>
exceeds the specified <paramref name="timeSpan"/> compared to another <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="timeSpan">
The amount of time that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> should exceed compared to another <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeAtLeast(System.TimeSpan)">
<summary>
Returns a <see cref="T:FluentAssertions.Primitives.TimeSpanAssertions"/> object that can be used to assert that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>
is equal to or exceeds the specified <paramref name="timeSpan"/> compared to another <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="timeSpan">
The amount of time that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> should be equal or exceed compared to
another <see cref="T:System.DateTime"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeExactly(System.TimeSpan)">
<summary>
Returns a <see cref="T:FluentAssertions.Primitives.TimeSpanAssertions"/> object that can be used to assert that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>
differs exactly the specified <paramref name="timeSpan"/> compared to another <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="timeSpan">
The amount of time that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> should differ exactly compared to another <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeWithin(System.TimeSpan)">
<summary>
Returns a <see cref="T:FluentAssertions.Primitives.TimeSpanAssertions"/> object that can be used to assert that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>
is within the specified <paramref name="timeSpan"/> compared to another <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="timeSpan">
The amount of time that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> should be within another <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.DateTimeOffsetAssertions.BeLessThan(System.TimeSpan)">
<summary>
Returns a <see cref="T:FluentAssertions.Primitives.TimeSpanAssertions"/> object that can be used to assert that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>
differs at maximum the specified <paramref name="timeSpan"/> compared to another <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="timeSpan">
The maximum amount of time that the current <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> should differ compared to another <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/>.
</param>
</member>
<member name="P:FluentAssertions.Primitives.DateTimeOffsetAssertions.Subject">
<summary>
Gets the object which value is being asserted.
</summary>
</member>
<member name="T:FluentAssertions.Primitives.GuidAssertions">
<summary>
Contains a number of methods to assert that a <see cref="T:System.Guid"/> is in the correct state.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.GuidAssertions.BeEmpty(System.String,System.Object[])">
<summary>
Asserts that the <see cref="T:System.Guid"/> is <see cref="F:System.Guid.Empty"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.GuidAssertions.NotBeEmpty(System.String,System.Object[])">
<summary>
Asserts that the <see cref="T:System.Guid"/> is not <see cref="F:System.Guid.Empty"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.GuidAssertions.Be(System.String,System.String,System.Object[])">
<summary>
Asserts that the <see cref="T:System.Guid"/> is equal to the <paramref name="expected"/> GUID.
</summary>
<param name="expected">The expected <see cref="T:System.String"/> value to compare the actual value with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.GuidAssertions.Be(System.Guid,System.String,System.Object[])">
<summary>
Asserts that the <see cref="T:System.Guid"/> is equal to the <paramref name="expected"/> GUID.
</summary>
<param name="expected">The expected value to compare the actual value with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.GuidAssertions.NotBe(System.Guid,System.String,System.Object[])">
<summary>
Asserts that the <see cref="T:System.Guid"/> is not equal to the <paramref name="unexpected"/> GUID.
</summary>
<param name="unexpected">The unexpected value to compare the actual value with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Primitives.GuidAssertions.Subject">
<summary>
Gets the object which value is being asserted.
</summary>
</member>
<member name="T:FluentAssertions.Primitives.StringValidator">
<summary>
Dedicated class for comparing two strings and generating consistent error messages.
</summary>
</member>
<member name="T:FluentAssertions.Primitives.NullableBooleanAssertions">
<summary>
Contains a number of methods to assert that a nullable <see cref="T:System.Boolean"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.NullableBooleanAssertions.HaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable boolean value is not <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableBooleanAssertions.NotHaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable boolean value is <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableBooleanAssertions.Be(System.Nullable{System.Boolean},System.String,System.Object[])">
<summary>
Asserts that the value is equal to the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableBooleanAssertions.NotBeFalse(System.String,System.Object[])">
<summary>
Asserts that the value is not <c>false</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableBooleanAssertions.NotBeTrue(System.String,System.Object[])">
<summary>
Asserts that the value is not <c>true</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="T:FluentAssertions.Primitives.NullableDateTimeOffsetAssertions">
<summary>
Contains a number of methods to assert that a nullable <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> is in the expected state.
</summary>
<remarks>
You can use the <see cref="T:FluentAssertions.FluentDateTimeExtensions"/> for a more fluent way of specifying a <see cref="T:System.DateTime"/>.
</remarks>
</member>
<member name="M:FluentAssertions.Primitives.NullableDateTimeOffsetAssertions.HaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> value is not <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableDateTimeOffsetAssertions.NotHaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable <see cref="T:System.DateTime"/> or <see cref="T:System.DateTimeOffset"/> value is <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableDateTimeOffsetAssertions.Be(System.Nullable{System.DateTimeOffset},System.String,System.Object[])">
<summary>
Asserts that the value is equal to the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableDateTimeOffsetAssertions.Be(System.Nullable{System.DateTime},System.String,System.Object[])">
<summary>
Asserts that the value is equal to the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="T:FluentAssertions.Primitives.NullableGuidAssertions">
<summary>
Contains a number of methods to assert that a nullable <see cref="T:System.Guid"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.NullableGuidAssertions.HaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable <see cref="T:System.Guid"/> value is not <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableGuidAssertions.NotHaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable <see cref="T:System.Guid"/> value is <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableGuidAssertions.Be(System.Nullable{System.Guid},System.String,System.Object[])">
<summary>
Asserts that the value is equal to the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="T:FluentAssertions.Primitives.NullableSimpleTimeSpanAssertions">
<summary>
Contains a number of methods to assert that a nullable <see cref="T:System.TimeSpan"/> is in the expected state.
</summary>
<remarks>
You can use the <see cref="T:FluentAssertions.TimeSpanConversionExtensions"/> for a more fluent way of specifying a <see cref="T:System.TimeSpan"/>.
</remarks>
</member>
<member name="T:FluentAssertions.Primitives.SimpleTimeSpanAssertions">
<summary>
Contains a number of methods to assert that a nullable <see cref="T:System.TimeSpan"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.BePositive(System.String,System.Object[])">
<summary>
Asserts that the time difference of the current <see cref="T:System.TimeSpan"/> is greater than zero.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.BeNegative(System.String,System.Object[])">
<summary>
Asserts that the time difference of the current <see cref="T:System.TimeSpan"/> is less than zero.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.Be(System.TimeSpan,System.String,System.Object[])">
<summary>
Asserts that the time difference of the current <see cref="T:System.TimeSpan"/> is equal to the
specified <paramref name="expected"/> time.
</summary>
<param name="expected">The expected time difference</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.NotBe(System.TimeSpan,System.String,System.Object[])">
<summary>
Asserts that the time difference of the current <see cref="T:System.TimeSpan"/> is not equal to the
specified <paramref name="unexpected"/> time.
</summary>
<param name="unexpected">The unexpected time difference</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.BeLessThan(System.TimeSpan,System.String,System.Object[])">
<summary>
Asserts that the time difference of the current <see cref="T:System.TimeSpan"/> is less than the
specified <paramref name="expected"/> time.
</summary>
<param name="expected">The time difference to which the current value will be compared</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.BeLessOrEqualTo(System.TimeSpan,System.String,System.Object[])">
<summary>
Asserts that the time difference of the current <see cref="T:System.TimeSpan"/> is less than or equal to the
specified <paramref name="expected"/> time.
</summary>
<param name="expected">The time difference to which the current value will be compared</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.BeGreaterThan(System.TimeSpan,System.String,System.Object[])">
<summary>
Asserts that the time difference of the current <see cref="T:System.TimeSpan"/> is greater than the
specified <paramref name="expected"/> time.
</summary>
<param name="expected">The time difference to which the current value will be compared</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.BeGreaterOrEqualTo(System.TimeSpan,System.String,System.Object[])">
<summary>
Asserts that the time difference of the current <see cref="T:System.TimeSpan"/> is greater than or equal to the
specified <paramref name="expected"/> time.
</summary>
<param name="expected">The time difference to which the current value will be compared</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.BeCloseTo(System.TimeSpan,System.Int32,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.TimeSpan"/> is within the specified number of milliseconds (default = 20 ms)
from the specified <paramref name="nearbyTime"/> value.
</summary>
<remarks>
Use this assertion when, for example the database truncates datetimes to nearest 20ms. If you want to assert to the exact datetime,
use <see cref="M:FluentAssertions.Primitives.SimpleTimeSpanAssertions.Be(System.TimeSpan,System.String,System.Object[])"/>.
</remarks>
<param name="expected"></param>
<param name="i"></param>
<param name="nearbyTime">
The expected time to compare the actual value with.
</param>
<param name="precision">
The maximum amount of milliseconds which the two values may differ.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Primitives.SimpleTimeSpanAssertions.Subject">
<summary>
Gets the object which value is being asserted.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.NullableSimpleTimeSpanAssertions.HaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable <see cref="T:System.TimeSpan"/> value is not <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableSimpleTimeSpanAssertions.NotHaveValue(System.String,System.Object[])">
<summary>
Asserts that a nullable <see cref="T:System.TimeSpan"/> value is <c>null</c>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.NullableSimpleTimeSpanAssertions.Be(System.Nullable{System.TimeSpan},System.String,System.Object[])">
<summary>
Asserts that the value is equal to the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="T:FluentAssertions.Primitives.ObjectAssertions">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Object"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.ObjectAssertions.Be(System.Object,System.String,System.Object[])">
<summary>
Asserts that an object equals another object using its <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.ObjectAssertions.NotBe(System.Object,System.String,System.Object[])">
<summary>
Asserts that an object does not equal another object using it's <see cref="M:System.Object.Equals(System.Object)"/> method.
</summary>
<param name="unexpected">The unexpected value</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="P:FluentAssertions.Primitives.ObjectAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Primitives.StringAssertions">
<summary>
Contains a number of methods to assert that a <see cref="T:System.String"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:System.Object" /> class.
</summary>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.Be(System.String,System.String,System.Object[])">
<summary>
Asserts that a string is exactly the same as another string, including the casing and any leading or trailing whitespace.
</summary>
<param name="expected">The expected string.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.BeOneOf(System.String[])">
<summary>
Asserts that the <see cref="T:System.String"/> is one of the specified <paramref name="validValues"/>.
</summary>
<param name="validValues">
The values that are valid.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.BeOneOf(System.Collections.Generic.IEnumerable{System.String},System.String,System.Object[])">
<summary>
Asserts that the <see cref="T:System.String"/> is one of the specified <paramref name="validValues"/>.
</summary>
<param name="validValues">
The values that are valid.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.BeEquivalentTo(System.String,System.String,System.Object[])">
<summary>
Asserts that a string is exactly the same as another string, including any leading or trailing whitespace, with
the exception of the casing.
</summary>
<param name="expected">
The string that the subject is expected to be equivalent to.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotBe(System.String,System.String,System.Object[])">
<summary>
Asserts that a string is not exactly the same as the specified <paramref name="unexpected"/>,
including any leading or trailing whitespace, with the exception of the casing.
</summary>
<param name="unexpected">The string that the subject is not expected to be equivalent to.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.Match(System.String,System.String,System.Object[])">
<summary>
Asserts that a string matches a wildcard pattern.
</summary>
<param name="wildcardPattern">
The wildcard pattern with which the subject is matched, where * and ? have special meanings.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotMatch(System.String,System.String,System.Object[])">
<summary>
Asserts that a string does not match a wildcard pattern.
</summary>
<param name="wildcardPattern">
The wildcard pattern with which the subject is matched, where * and ? have special meanings.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.MatchEquivalentOf(System.String,System.String,System.Object[])">
<summary>
Asserts that a string matches a wildcard pattern.
</summary>
<param name="wildcardPattern">
The wildcard pattern with which the subject is matched, where * and ? have special meanings.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotMatchEquivalentOf(System.String,System.String,System.Object[])">
<summary>
Asserts that a string does not match a wildcard pattern.
</summary>
<param name="wildcardPattern">
The wildcard pattern with which the subject is matched, where * and ? have special meanings.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.MatchRegex(System.String,System.String,System.Object[])">
<summary>
Asserts that a string matches a regular expression.
</summary>
<param name="regularExpression">
The regular expression with which the subject is matched.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotMatchRegex(System.String,System.String,System.Object[])">
<summary>
Asserts that a string does not match a regular expression.
</summary>
<param name="regularExpression">
The regular expression with which the subject is matched.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.StartWith(System.String,System.String,System.Object[])">
<summary>
Asserts that a string starts exactly with the specified <paramref name="expected"/> value,
including the casing and any leading or trailing whitespace.
</summary>
<param name="expected">The string that the subject is expected to start with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotStartWith(System.String,System.String,System.Object[])">
<summary>
Asserts that a string does not start with the specified <paramref name="unexpected"/> value,
including the casing and any leading or trailing whitespace.
</summary>
<param name="unexpected">The string that the subject is not expected to start with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.StartWithEquivalent(System.String,System.String,System.Object[])">
<summary>
Asserts that a string starts with the specified <paramref name="expected"/>,
including any leading or trailing whitespace, with the exception of the casing.
</summary>
<param name="expected">The string that the subject is expected to start with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotStartWithEquivalentOf(System.String,System.String,System.Object[])">
<summary>
Asserts that a string does not start with the specified <paramref name="unexpected"/> value,
including any leading or trailing whitespace, with the exception of the casing.
</summary>
<param name="unexpected">The string that the subject is not expected to start with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.EndWith(System.String,System.String,System.Object[])">
<summary>
Asserts that a string ends exactly with the specified <paramref name="expected"/>,
including the casing and any leading or trailing whitespace.
</summary>
<param name="expected">The string that the subject is expected to end with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotEndWith(System.String,System.String,System.Object[])">
<summary>
Asserts that a string does not end exactly with the specified <paramref name="unexpected"/>,
including the casing and any leading or trailing whitespace.
</summary>
<param name="unexpected">The string that the subject is not expected to end with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.EndWithEquivalent(System.String,System.String,System.Object[])">
<summary>
Asserts that a string ends with the specified <paramref name="expected"/>,
including any leading or trailing whitespace, with the exception of the casing.
</summary>
<param name="expected">The string that the subject is expected to end with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotEndWithEquivalentOf(System.String,System.String,System.Object[])">
<summary>
Asserts that a string does not end with the specified <paramref name="unexpected"/>,
including any leading or trailing whitespace, with the exception of the casing.
</summary>
<param name="unexpected">The string that the subject is not expected to end with.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.Contain(System.String,System.String,System.Object[])">
<summary>
Asserts that a string contains another (fragment of a) string.
</summary>
<param name="expected">
The (fragement of a) string that the current string should contain.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.ContainEquivalentOf(System.String,System.String,System.Object[])">
<summary>
Asserts that a string contains the specified <paramref name="expected"/>,
including any leading or trailing whitespace, with the exception of the casing.
</summary>
<param name="expected">The string that the subject is expected to contain.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotContain(System.String,System.String,System.Object[])">
<summary>
Asserts that a string does not contain another (fragment of a) string.
</summary>
<param name="expected">
The (fragement of a) string that the current string should not contain.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotContainEquivalentOf(System.String,System.String,System.Object[])">
<summary>
Asserts that a string does not contain the specified <paramref name="unexpected"/> string,
including any leading or trailing whitespace, with the exception of the casing.
</summary>
<param name="unexpected">The string that the subject is not expected to contain.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.BeEmpty(System.String,System.Object[])">
<summary>
Asserts that a string is <see cref="F:System.String.Empty"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotBeEmpty(System.String,System.Object[])">
<summary>
Asserts that a string is not <see cref="F:System.String.Empty"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.HaveLength(System.Int32,System.String,System.Object[])">
<summary>
Asserts that a string has the specified <paramref name="expected"/> length.
</summary>
<param name="expected">The expected length of the string</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotBeNullOrEmpty(System.String,System.Object[])">
<summary>
Asserts that a string is neither <c>null</c> nor <see cref="F:System.String.Empty"/>.
</summary>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.BeNullOrEmpty(System.String,System.Object[])">
<summary>
Asserts that a string is either <c>null</c> or <see cref="F:System.String.Empty"/>.
</summary>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.NotBeNullOrWhiteSpace(System.String,System.Object[])">
<summary>
Asserts that a string is neither <c>null</c> nor <see cref="F:System.String.Empty"/> nor white space
</summary>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Primitives.StringAssertions.BeNullOrWhiteSpace(System.String,System.Object[])">
<summary>
Asserts that a string is either <c>null</c> or <see cref="F:System.String.Empty"/> or white space
</summary>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="P:FluentAssertions.Primitives.StringAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="P:FluentAssertions.Primitives.StringWildcardMatchingValidator.Negate">
<summary>
Gets or sets a value indicating whether the subject should not match the pattern.
</summary>
</member>
<member name="P:FluentAssertions.Primitives.StringWildcardMatchingValidator.IgnoreCase">
<summary>
Gets or sets a value indicating whether the matching process should ignore any casing difference.
</summary>
</member>
<member name="P:FluentAssertions.Primitives.StringWildcardMatchingValidator.IgnoreNewLineDifferences">
<summary>
Ignores the difference betweeen environment newline differences
</summary>
</member>
<member name="T:FluentAssertions.Primitives.TimeSpanAssertions">
<summary>
Contains a number of methods to assert that two <see cref="T:System.DateTime"/> objects differ in the expected way.
</summary>
<remarks>
You can use the <see cref="T:FluentAssertions.FluentDateTimeExtensions"/> and <see cref="T:FluentAssertions.TimeSpanConversionExtensions"/> for a more fluent
way of specifying a <see cref="T:System.DateTime"/> or a <see cref="T:System.TimeSpan"/>.
</remarks>
</member>
<member name="M:FluentAssertions.Primitives.TimeSpanAssertions.Before(System.DateTime,System.String,System.Object[])">
<summary>
Asserts that a <see cref="T:System.DateTime"/> occurs a specified amount of time before another <see cref="T:System.DateTime"/>.
</summary>
<param name="target">
The <see cref="T:System.DateTime"/> to compare the subject with.
</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Primitives.TimeSpanAssertions.Before(System.DateTimeOffset,System.String,System.Object[])">
<summary>
Asserts that a <see cref="T:System.DateTimeOffset"/> occurs a specified amount of time before another <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="target">
The <see cref="T:System.DateTimeOffset"/> to compare the subject with.
</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Primitives.TimeSpanAssertions.After(System.DateTime,System.String,System.Object[])">
<summary>
Asserts that a <see cref="T:System.DateTime"/> occurs a specified amount of time after another <see cref="T:System.DateTime"/>.
</summary>
<param name="target">
The <see cref="T:System.DateTime"/> to compare the subject with.
</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.Primitives.TimeSpanAssertions.After(System.DateTimeOffset,System.String,System.Object[])">
<summary>
Asserts that a <see cref="T:System.DateTimeOffset"/> occurs a specified amount of time after another <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="target">
The <see cref="T:System.DateTimeOffset"/> to compare the subject with.
</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="T:FluentAssertions.Primitives.TimeSpanAssertions.TimeSpanPredicate">
<summary>
Provides the logic and the display text for a <see cref="T:FluentAssertions.Primitives.TimeSpanCondition"/>.
</summary>
</member>
<member name="T:FluentAssertions.PropertyChangedSourceExtensions">
<summary>
Provides extension methods for monitoring and querying events.
</summary>
</member>
<member name="M:FluentAssertions.PropertyChangedSourceExtensions.ShouldRaisePropertyChangeFor``1(``0,System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
<summary>
Asserts that an object has raised the <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged"/> event for a particular property.
</summary>
<remarks>
You must call <see cref="!:MonitorEvents"/> on the same object prior to this call so that Fluent Assertions can
subscribe for the events of the object.
</remarks>
</member>
<member name="M:FluentAssertions.PropertyChangedSourceExtensions.ShouldRaisePropertyChangeFor``1(``0,System.Linq.Expressions.Expression{System.Func{``0,System.Object}},System.String,System.Object[])">
<summary>
Asserts that an object has raised the <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged"/> event for a particular property.
</summary>
<param name="eventSource">The object exposing the event.</param>
<param name="propertyExpression">
A lambda expression referring to the property for which the property changed event should have been raised, or
<c>null</c> to refer to all properties.
</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
<remarks>
You must call <see cref="!:MonitorEvents"/> on the same object prior to this call so that Fluent Assertions can
subscribe for the events of the object.
</remarks>
</member>
<member name="M:FluentAssertions.PropertyChangedSourceExtensions.ShouldNotRaisePropertyChangeFor``1(``0,System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
<summary>
Asserts that an object has not raised the <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged"/> event for a particular property.
</summary>
<remarks>
You must call <see cref="!:MonitorEvents"/> on the same object prior to this call so that Fluent Assertions can
subscribe for the events of the object.
</remarks>
</member>
<member name="M:FluentAssertions.PropertyChangedSourceExtensions.ShouldNotRaisePropertyChangeFor``1(``0,System.Linq.Expressions.Expression{System.Func{``0,System.Object}},System.String,System.Object[])">
<summary>
Asserts that an object has not raised the <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged"/> event for a particular property.
</summary>
<param name="eventSource">The object exposing the event.</param>
<param name="propertyExpression">
A lambda expression referring to the property for which the property changed event should have been raised.
</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
<remarks>
You must call <see cref="!:MonitorEvents"/> on the same object prior to this call so that Fluent Assertions can
subscribe for the events of the object.
</remarks>
</member>
<member name="M:FluentAssertions.PropertyChangedSourceExtensions.WithSender(FluentAssertions.Events.IEventRecorder,System.Object)">
<summary>
Asserts that all occurences of the event originated from the <param name="expectedSender"/>.
</summary>
</member>
<member name="M:FluentAssertions.PropertyChangedSourceExtensions.WithArgs``1(FluentAssertions.Events.IEventRecorder,System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})">
<summary>
Asserts that at least one occurrence of the event had an <see cref="T:System.EventArgs"/> object matching a predicate.
</summary>
</member>
<member name="T:FluentAssertions.Specialized.ActionAssertions">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Action"/> yields the expected result.
</summary>
</member>
<member name="M:FluentAssertions.Specialized.ActionAssertions.ShouldThrow``1(System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Action"/> throws an exception of type <typeparamref name="TException"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Specialized.ActionAssertions.ShouldNotThrow``1(System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Action"/> does not throw an exception of type <typeparamref name="TException"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Specialized.ActionAssertions.ShouldNotThrow(System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Action"/> does not throw any exception.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Specialized.ActionAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Specialized.AsyncFunctionAssertions">
<summary>
Contains a number of methods to assert that an asynchronous method yields the expected result.
</summary>
</member>
<member name="M:FluentAssertions.Specialized.AsyncFunctionAssertions.ShouldThrow``1(System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Func`1"/> throws an exception of type <typeparamref name="TException"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Specialized.AsyncFunctionAssertions.ShouldNotThrow(System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Func`1"/> does not throw any exception.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Specialized.AsyncFunctionAssertions.ShouldNotThrow``1(System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Func`1"/> does not throw an exception of type <typeparamref name="TException"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Specialized.AsyncFunctionAssertions.Subject">
<summary>
Gets the <see cref="T:System.Func`1"/> that is being asserted.
</summary>
</member>
<member name="T:FluentAssertions.Specialized.ExceptionAssertions`1">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Exception"/> is in the correct state.
</summary>
</member>
<member name="M:FluentAssertions.Specialized.ExceptionAssertions`1.WithMessage(System.String,System.String,System.Object[])">
<summary>
Asserts that the thrown exception has a message that matches <paramref name="expectedMessage"/>
depending on the specified matching mode.
</summary>
<param name="expectedMessage">
The expected message of the exception.
</param>
<param name="reason">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
</param>
</member>
<member name="M:FluentAssertions.Specialized.ExceptionAssertions`1.WithInnerException``1">
<summary>
Asserts that the thrown exception contains an inner exception of type <typeparamref name = "TInnerException" />.
</summary>
<typeparam name = "TInnerException">The expected type of the inner exception.</typeparam>
</member>
<member name="M:FluentAssertions.Specialized.ExceptionAssertions`1.WithInnerException``1(System.String,System.Object[])">
<summary>
Asserts that the thrown exception contains an inner exception of type <typeparamref name = "TInnerException" />.
</summary>
<typeparam name = "TInnerException">The expected type of the inner exception.</typeparam>
<param name = "reason">The reason why the inner exception should be of the supplied type.</param>
<param name = "reasonArgs">The parameters used when formatting the <paramref name = "because" />.</param>
</member>
<member name="M:FluentAssertions.Specialized.ExceptionAssertions`1.WithInnerMessage(System.String,System.String,System.Object[])">
<summary>
Asserts that the thrown exception contains an inner exception with the <paramref name = "expectedInnerMessage" />.
</summary>
<param name = "expectedInnerMessage">The expected message of the inner exception.</param>
<param name = "reason">
The reason why the message of the inner exception should match <paramref name = "expectedInnerMessage" />.
</param>
<param name = "reasonArgs">The parameters used when formatting the <paramref name = "because" />.</param>
</member>
<member name="M:FluentAssertions.Specialized.ExceptionAssertions`1.Where(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the exception matches a particular condition.
</summary>
<param name="exceptionExpression">
The condition that the exception must match.
</param>
<param name="reason">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="P:FluentAssertions.Specialized.ExceptionAssertions`1.And">
<summary>
Gets the exception object of the exception thrown.
</summary>
</member>
<member name="P:FluentAssertions.Specialized.ExceptionAssertions`1.Which">
<summary>
Gets the exception object of the exception thrown.
</summary>
</member>
<member name="P:FluentAssertions.Specialized.ExceptionAssertions`1.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.TimeSpanConversionExtensions">
<summary>
Extension methods on <see cref="T:System.Int32"/> to allow for a more fluent way of specifying a <see cref="T:System.TimeSpan"/>.
</summary>
<example>
Instead of<br/>
<br/>
TimeSpan.FromHours(12)<br/>
<br/>
you can write<br/>
<br/>
12.Hours()<br/>
<br/>
Or even<br/>
<br/>
12.Hours().And(30.Minutes()).
</example>
<seealso cref="T:FluentAssertions.FluentDateTimeExtensions"/>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.Milliseconds(System.Int32)">
<summary>
Returns a <see cref="T:System.TimeSpan"/> based on a number of milliseconds.
</summary>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.Seconds(System.Int32)">
<summary>
Returns a <see cref="T:System.TimeSpan"/> based on a number of seconds.
</summary>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.Seconds(System.Int32,System.TimeSpan)">
<summary>
Returns a <see cref="T:System.TimeSpan"/> based on a number of seconds, and add the specified
<paramref name="offset"/>.
</summary>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.Minutes(System.Int32)">
<summary>
Returns a <see cref="T:System.TimeSpan"/> based on a number of minutes.
</summary>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.Minutes(System.Int32,System.TimeSpan)">
<summary>
Returns a <see cref="T:System.TimeSpan"/> based on a number of minutes, and add the specified
<paramref name="offset"/>.
</summary>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.Hours(System.Int32)">
<summary>
Returns a <see cref="T:System.TimeSpan"/> based on a number of hours.
</summary>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.Hours(System.Int32,System.TimeSpan)">
<summary>
Returns a <see cref="T:System.TimeSpan"/> based on a number of hours, and add the specified
<paramref name="offset"/>.
</summary>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.Days(System.Int32)">
<summary>
Returns a <see cref="T:System.TimeSpan"/> based on a number of days.
</summary>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.Days(System.Int32,System.TimeSpan)">
<summary>
Returns a <see cref="T:System.TimeSpan"/> based on a number of days, and add the specified
<paramref name="offset"/>.
</summary>
</member>
<member name="M:FluentAssertions.TimeSpanConversionExtensions.And(System.TimeSpan,System.TimeSpan)">
<summary>
Convenience method for chaining multiple calls to the methods provided by this class.
</summary>
<example>
23.Hours().And(59.Minutes())
</example>
</member>
<member name="T:FluentAssertions.TypeExtensions">
<summary>
Extension methods for getting method and property selectors for a type.
</summary>
</member>
<member name="M:FluentAssertions.TypeExtensions.Types(System.Reflection.Assembly)">
<summary>
Returns the types that are visible outside the specified <see cref="T:System.Reflection.Assembly"/>.
</summary>
</member>
<member name="M:FluentAssertions.TypeExtensions.Methods(System.Type)">
<summary>
Returns a method selector for the current <see cref="T:System.Type"/>.
</summary>
</member>
<member name="M:FluentAssertions.TypeExtensions.Methods(FluentAssertions.Types.TypeSelector)">
<summary>
Returns a method selector for the current <see cref="T:System.Type"/>.
</summary>
</member>
<member name="M:FluentAssertions.TypeExtensions.Properties(System.Type)">
<summary>
Returns a property selector for the current <see cref="T:System.Type"/>.
</summary>
</member>
<member name="M:FluentAssertions.TypeExtensions.Properties(FluentAssertions.Types.TypeSelector)">
<summary>
Returns a property selector for the current <see cref="T:System.Type"/>.
</summary>
</member>
<member name="T:FluentAssertions.Types.AllTypes">
<summary>
Static class that allows for a 'fluent' selection of the types from an <see cref="T:System.Reflection.Assembly"/>.
</summary>
<example>
AllTypes.From(myAssembly)<br/>
.ThatImplement<ISomeInterface><br/>
.Should()<br/>
.BeDecoratedWith<SomeAttribute>()
</example>
</member>
<member name="M:FluentAssertions.Types.AllTypes.From(System.Reflection.Assembly)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.TypeSelector"/> for selecting the types that are visible outside the
specified <paramref name="assembly"/>.
</summary>
<param name="assembly">The assembly from which to select the types.</param>
</member>
<member name="T:FluentAssertions.Types.MethodInfoAssertions">
<summary>
Contains a number of methods to assert that a <see cref="T:System.Reflection.MethodInfo"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Types.MethodInfoAssertions.BeDecoratedWith``1(System.String,System.Object[])">
<summary>
Asserts that the selected method is decorated with the specified <typeparamref name="TAttribute"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.MethodInfoAssertions.BeDecoratedWith``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the selected method is decorated with an attribute of type <typeparamref name="TAttribute"/>
that matches the specified <paramref name="isMatchingAttributePredicate"/>.
</summary>
<param name="isMatchingAttributePredicate">
The predicate that the attribute must match.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.MethodInfoAssertions.BeVirtual(System.String,System.Object[])">
<summary>
Asserts that the selected method is virtual.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="T:FluentAssertions.Types.MethodInfoSelector">
<summary>
Allows for fluent selection of methods of a type through reflection.
</summary>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelector.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Types.MethodInfoSelector"/> class.
</summary>
<param name="type">The type from which to select methods.</param>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelector.#ctor(System.Collections.Generic.IEnumerable{System.Type})">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Types.MethodInfoSelector"/> class.
</summary>
<param name="types">The types from which to select methods.</param>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelector.ThatReturn``1">
<summary>
Only select the methods that return the specified type
</summary>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelector.ThatAreDecoratedWith``1">
<summary>
Only select the methods that are decorated with an attribute of the specified type.
</summary>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelector.ToArray">
<summary>
The resulting <see cref="T:System.Reflection.MethodInfo"/> objects.
</summary>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelector.HasSpecialName(System.Reflection.MethodInfo)">
<summary>
Determines whether the specified method has a special name (like properties and events).
</summary>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelector.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
</returns>
<filterpriority>1</filterpriority>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelector.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="P:FluentAssertions.Types.MethodInfoSelector.ThatArePublicOrInternal">
<summary>
Only select the methods that are public or internal.
</summary>
</member>
<member name="P:FluentAssertions.Types.MethodInfoSelector.ThatReturnVoid">
<summary>
Only select the methods without a return value
</summary>
</member>
<member name="T:FluentAssertions.Types.MethodInfoSelectorAssertions">
<summary>
Contains assertions for the <see cref="T:System.Reflection.MethodInfo"/> objects returned by the parent <see cref="T:FluentAssertions.Types.MethodInfoSelector"/>.
</summary>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelectorAssertions.#ctor(System.Collections.Generic.IEnumerable{System.Reflection.MethodInfo})">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Types.MethodInfoSelectorAssertions"/> class.
</summary>
<param name="methodInfo">The methods to assert.</param>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelectorAssertions.BeVirtual(System.String,System.Object[])">
<summary>
Asserts that the selected methods are virtual.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelectorAssertions.BeDecoratedWith``1(System.String,System.Object[])">
<summary>
Asserts that the selected methods are decorated with the specified <typeparamref name="TAttribute"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.MethodInfoSelectorAssertions.BeDecoratedWith``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the selected methods are decorated with an attribute of type <typeparamref name="TAttribute"/>
that matches the specified <paramref name="isMatchingAttributePredicate"/>.
</summary>
<param name="isMatchingAttributePredicate">
The predicate that the attribute must match.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Types.MethodInfoSelectorAssertions.SubjectMethods">
<summary>
Gets the object which value is being asserted.
</summary>
</member>
<member name="P:FluentAssertions.Types.MethodInfoSelectorAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Types.PropertyInfoAssertions">
<summary>
Contains a number of methods to assert that a <see cref="T:System.Reflection.PropertyInfo"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoAssertions.BeVirtual(System.String,System.Object[])">
<summary>
Asserts that the selected property is virtual.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoAssertions.BeWritable(System.String,System.Object[])">
<summary>
Asserts that the selected property has a setter.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoAssertions.BeDecoratedWith``1(System.String,System.Object[])">
<summary>
Asserts that the selected property is decorated with the specified <typeparamref name="TAttribute"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Types.PropertyInfoAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Types.PropertyInfoSelector">
<summary>
Allows for fluent selection of properties of a type through reflection.
</summary>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelector.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Types.PropertyInfoSelector"/> class.
</summary>
<param name="type">The type from which to select properties.</param>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelector.#ctor(System.Collections.Generic.IEnumerable{System.Type})">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Types.PropertyInfoSelector"/> class.
</summary>
<param name="types">The types from which to select properties.</param>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelector.ThatAreDecoratedWith``1">
<summary>
Only select the properties that are decorated with an attribute of the specified type.
</summary>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelector.OfType``1">
<summary>
Only select the properties that return the specified type
</summary>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelector.ToArray">
<summary>
The resulting <see cref="T:System.Reflection.PropertyInfo"/> objects.
</summary>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelector.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
</returns>
<filterpriority>1</filterpriority>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelector.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="P:FluentAssertions.Types.PropertyInfoSelector.ThatArePublicOrInternal">
<summary>
Only select the properties that have a public or internal getter.
</summary>
</member>
<member name="T:FluentAssertions.Types.PropertyInfoSelectorAssertions">
<summary>
Contains assertions for the <see cref="T:System.Reflection.PropertyInfo"/> objects returned by the parent <see cref="T:FluentAssertions.Types.PropertyInfoSelector"/>.
</summary>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelectorAssertions.#ctor(System.Collections.Generic.IEnumerable{System.Reflection.PropertyInfo})">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Types.PropertyInfoSelectorAssertions"/> class, for a number of <see cref="T:System.Reflection.PropertyInfo"/> objects.
</summary>
<param name="properties">The properties to assert.</param>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelectorAssertions.BeVirtual(System.String,System.Object[])">
<summary>
Asserts that the selected properties are virtual.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelectorAssertions.BeWritable(System.String,System.Object[])">
<summary>
Asserts that the selected properties have a setter.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.PropertyInfoSelectorAssertions.BeDecoratedWith``1(System.String,System.Object[])">
<summary>
Asserts that the selected properties are decorated with the specified <typeparamref name="TAttribute"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Types.PropertyInfoSelectorAssertions.SubjectProperties">
<summary>
Gets the object which value is being asserted.
</summary>
</member>
<member name="P:FluentAssertions.Types.PropertyInfoSelectorAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Types.TypeAssertions">
<summary>
Contains a number of methods to assert that a <see cref="T:System.Type"/> meets certain expectations.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeAssertions.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:System.Object" /> class.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeAssertions.Be``1(System.String,System.Object[])">
<summary>
Asserts that the current type is equal to the specified <typeparamref name="TExpected"/> type.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.TypeAssertions.Be(System.Type,System.String,System.Object[])">
<summary>
Asserts that the current type is equal to the specified <paramref name="expected"/> type.
</summary>
<param name="expected">The expected type</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.TypeAssertions.GetFailureMessageIfTypesAreDifferent(System.Type,System.Type)">
<summary>
Creates an error message in case the specifed <paramref name="actual"/> type differs from the
<paramref name="expected"/> type.
</summary>
<returns>
An empty <see cref="T:System.String"/> if the two specified types are the same, or an error message that describes that
the two specified types are not the same.
</returns>
</member>
<member name="M:FluentAssertions.Types.TypeAssertions.NotBe``1(System.String,System.Object[])">
<summary>
Asserts that the current type is not equal to the specified <typeparamref name="TUnexpected"/> type.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.TypeAssertions.NotBe(System.Type,System.String,System.Object[])">
<summary>
Asserts that the current type is not equal to the specified <paramref name="unexpected"/> type.
</summary>
<param name="unexpected">The unexpected type</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.TypeAssertions.BeDecoratedWith``1(System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Type"/> is decorated with the specified <typeparamref name="TAttribute"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.TypeAssertions.BeDecoratedWith``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Type"/> is decorated with an attribute of type <typeparamref name="TAttribute"/>
that matches the specified <paramref name="isMatchingAttributePredicate"/>.
</summary>
<param name="isMatchingAttributePredicate">
The predicate that the attribute must match.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Types.TypeAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Types.TypeSelector">
<summary>
Allows for fluent filtering a list of types.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeSelector.ToArray">
<summary>
The resulting <see cref="T:System.Type"/> objects.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeSelector.ThatDeriveFrom``1">
<summary>
Determines whether a type is a subclass of another type, but NOT the same type.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeSelector.ThatImplement``1">
<summary>
Determines whether a type implements an interface (but is not the interface itself).
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeSelector.ThatAreDecoratedWith``1">
<summary>
Determines whether a type is decorated with a particular attribute.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeSelector.ThatAreInNamespace(System.String)">
<summary>
Determines whether the namespace of type is exactly <paramref name="namespace"/>.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeSelector.ThatAreUnderNamespace(System.String)">
<summary>
Determines whether the namespace of type is starts with <paramref name="namespace"/>.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeSelector.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
</returns>
<filterpriority>1</filterpriority>
</member>
<member name="M:FluentAssertions.Types.TypeSelector.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
</returns>
<filterpriority>2</filterpriority>
</member>
<member name="T:FluentAssertions.Types.TypeSelectorAssertions">
<summary>
Contains a number of methods to assert that all <see cref="T:System.Type"/>s in a <see cref="T:FluentAssertions.Types.TypeSelector"/>
meet certain expectations.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeSelectorAssertions.#ctor(System.Collections.Generic.IEnumerable{System.Type})">
<summary>
Initializes a new instance of the <see cref="T:System.Object" /> class.
</summary>
</member>
<member name="M:FluentAssertions.Types.TypeSelectorAssertions.BeDecoratedWith``1(System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Type"/> is decorated with the specified <typeparamref name="TAttribute"/>.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Types.TypeSelectorAssertions.BeDecoratedWith``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Type"/> is decorated with an attribute of type <typeparamref name="TAttribute"/>
that matches the specified <paramref name="isMatchingAttributePredicate"/>.
</summary>
<param name="isMatchingAttributePredicate">
The predicate that the attribute must match.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Types.TypeSelectorAssertions.Subject">
<summary>
Gets the object which value is being asserted.
</summary>
</member>
</members>
</doc>
<?xml version="1.0"?>
<doc>
<assembly>
<name>FluentAssertions</name>
</assembly>
<members>
<member name="T:FluentAssertions.EventSourceExtensions">
<summary>
Provides extension methods for monitoring and querying events.
</summary>
</member>
<member name="M:FluentAssertions.EventSourceExtensions.ShouldRaise(System.Object,System.String)">
<summary>
Asserts that an object has raised a particular event at least once.
</summary>
<param name="eventSource">The object exposing the event.</param>
<param name="eventName">The name of the event that should have been raised.</param>
<returns></returns>
<remarks>
You must call <see cref="!:MonitorEvents"/> on the same object prior to this call so that Fluent Assertions can
subscribe for the events of the object.
</remarks>
</member>
<member name="M:FluentAssertions.EventSourceExtensions.ShouldRaise(System.Object,System.String,System.String,System.Object[])">
<summary>
Asserts that an object has raised a particular event at least once.
</summary>
<param name="eventSource">The object exposing the event.</param>
<param name="eventName">
The name of the event that should have been raised.
</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
<remarks>
You must call <see cref="!:MonitorEvents"/> on the same object prior to this call so that Fluent Assertions can
subscribe for the events of the object.
</remarks>
</member>
<member name="M:FluentAssertions.EventSourceExtensions.ShouldNotRaise(System.Object,System.String)">
<summary>
Asserts that an object has not raised a particular event.
</summary>
<param name="eventSource">The object exposing the event.</param>
<param name="eventName">
The name of the event that should not be raised.
</param>
<remarks>
You must call <see cref="!:MonitorEvents"/> on the same object prior to this call so that Fluent Assertions can
subscribe for the events of the object.
</remarks>
</member>
<member name="M:FluentAssertions.EventSourceExtensions.ShouldNotRaise(System.Object,System.String,System.String,System.Object[])">
<summary>
Asserts that an object has not raised a particular event.
</summary>
<param name="eventSource">The object exposing the event.</param>
<param name="eventName">
The name of the event that should not be raised.
</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
<remarks>
You must call <see cref="!:MonitorEvents"/> on the same object prior to this call so that Fluent Assertions can
subscribe for the events of the object.
</remarks>
</member>
<member name="T:FluentAssertions.Execution.ITestFramework">
<summary>
Represents an abstraction of a particular test framework such as MSTest, nUnit, etc.
</summary>
</member>
<member name="M:FluentAssertions.Execution.ITestFramework.Throw(System.String)">
<summary>
Throws a framework-specific exception to indicate a failing unit test.
</summary>
</member>
<member name="P:FluentAssertions.Execution.ITestFramework.IsAvailable">
<summary>
Gets a value indicating whether the corresponding test framework is currently available.
</summary>
</member>
<member name="M:FluentAssertions.Execution.GallioTestFramework.Throw(System.String)">
<summary>
Throws a framework-specific exception to indicate a failing unit test.
</summary>
</member>
<member name="P:FluentAssertions.Execution.GallioTestFramework.IsAvailable">
<summary>
Gets a value indicating whether the corresponding test framework is currently available.
</summary>
</member>
<member name="M:FluentAssertions.ObjectAssertionsExtensions.BeBinarySerializable(FluentAssertions.Primitives.ObjectAssertions,System.String,System.Object[])">
<summary>
Asserts that an object can be serialized and deserialized using the binary serializer and that it stills retains
the values of all properties.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
</param>
</member>
<member name="M:FluentAssertions.ObjectAssertionsExtensions.BeBinarySerializable``1(FluentAssertions.Primitives.ObjectAssertions,System.Func{FluentAssertions.Equivalency.EquivalencyAssertionOptions{``0},FluentAssertions.Equivalency.EquivalencyAssertionOptions{``0}},System.String,System.Object[])">
<summary>
Asserts that an object can be serialized and deserialized using the binary serializer and that it stills retains
the values of all properties.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
</param>
</member>
<member name="M:FluentAssertions.ObjectAssertionsExtensions.BeXmlSerializable(FluentAssertions.Primitives.ObjectAssertions,System.String,System.Object[])">
<summary>
Asserts that an object can be serialized and deserialized using the XML serializer and that it stills retains
the values of all properties.
</summary>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
</param>
</member>
<member name="T:FluentAssertions.AssertionExtensions">
<summary>
Contains extension methods for custom assertions in unit tests.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ShouldThrow``1(System.Action,System.String,System.Object[])">
<summary>
Asserts that the <paramref name="action"/> throws an exception.
</summary>
<param name="action">A reference to the method or property.</param>
<typeparam name="TException">
The type of the exception it should throw.
</typeparam>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
<returns>
Returns an object that allows asserting additional members of the thrown exception.
</returns>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ShouldNotThrow``1(System.Action,System.String,System.Object[])">
<summary>
Asserts that the <paramref name="action"/> does not throw a particular exception.
</summary>
<param name="action">The current method or property.</param>
<typeparam name="TException">
The type of the exception it should not throw. Any other exceptions are ignored and will satisfy the assertion.
</typeparam>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ShouldNotThrow(System.Action,System.String,System.Object[])">
<summary>
Asserts that the <paramref name="action"/> does not throw any exception at all.
</summary>
<param name="action">The current method or property.</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ShouldThrow``1(System.Func{System.Threading.Tasks.Task},System.String,System.Object[])">
<summary>
Asserts that the <paramref name="asyncAction"/> throws an exception.
</summary>
<param name="asyncAction">A reference to the method or property.</param>
<typeparam name="TException">
The type of the exception it should throw.
</typeparam>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
<returns>
Returns an object that allows asserting additional members of the thrown exception.
</returns>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ShouldNotThrow``1(System.Func{System.Threading.Tasks.Task},System.String,System.Object[])">
<summary>
Asserts that the <paramref name="asyncAction"/> does not throw a particular exception.
</summary>
<param name="asyncAction">The current method or property.</param>
<typeparam name="TException">
The type of the exception it should not throw. Any other exceptions are ignored and will satisfy the assertion.
</typeparam>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ShouldNotThrow(System.Func{System.Threading.Tasks.Task},System.String,System.Object[])">
<summary>
Asserts that the <paramref name="asyncAction"/> does not throw any exception at all.
</summary>
<param name="asyncAction">The current method or property.</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Invoking``1(``0,System.Action{``0})">
<summary>
Invokes the specified action on an subject so that you can chain it with any of the ShouldThrow or ShouldNotThrow
overloads.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ExecutionTimeOf``1(``0,System.Linq.Expressions.Expression{System.Action{``0}})">
<summary>
Provides methods for asserting the execution time of a method or property.
</summary>
<param name="subject">The object that exposes the method or property.</param>
<param name="action">A reference to the method or property to measure the execution time of.</param>
<returns>
Returns an object for asserting that the execution time matches certain conditions.
</returns>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ExecutionTime(System.Action)">
<summary>
Provides methods for asserting the execution time of a method or property.
</summary>
<param name="action">A reference to the method or property to measure the execution time of.</param>
<returns>
Returns an object for asserting that the execution time matches certain conditions.
</returns>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Reflection.Assembly)">
<summary>
Returns an <see cref="T:FluentAssertions.Reflection.AssemblyAssertions"/> object that can be used to assert the
current <see cref="T:System.Reflection.Assembly"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Xml.Linq.XDocument)">
<summary>
Returns an <see cref="T:FluentAssertions.Xml.XDocumentAssertions"/> object that can be used to assert the
current <see cref="T:System.Xml.Linq.XElement"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Xml.Linq.XElement)">
<summary>
Returns an <see cref="T:FluentAssertions.Xml.XElementAssertions"/> object that can be used to assert the
current <see cref="T:System.Xml.Linq.XElement"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Xml.Linq.XAttribute)">
<summary>
Returns an <see cref="T:FluentAssertions.Xml.XAttributeAssertions"/> object that can be used to assert the
current <see cref="T:System.Xml.Linq.XAttribute"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Enumerating(System.Func{System.Collections.IEnumerable})">
<summary>
Forces enumerating a collection. Should be used to assert that a method that uses the
<c>yield</c> keyword throws a particular exception.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Enumerating``1(System.Func{System.Collections.Generic.IEnumerable{``0}})">
<summary>
Forces enumerating a collection. Should be used to assert that a method that uses the
<c>yield</c> keyword throws a particular exception.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Object)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.ObjectAssertions"/> object that can be used to assert the
current <see cref="T:System.Object"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Boolean)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.BooleanAssertions"/> object that can be used to assert the
current <see cref="T:System.Boolean"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.Boolean})">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.NullableBooleanAssertions"/> object that can be used to assert the
current nullable <see cref="T:System.Boolean"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Guid)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.GuidAssertions"/> object that can be used to assert the
current <see cref="T:System.Guid"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.Guid})">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.NullableGuidAssertions"/> object that can be used to assert the
current nullable <see cref="T:System.Guid"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Collections.IEnumerable)">
<summary>
Returns an <see cref="T:FluentAssertions.Collections.NonGenericCollectionAssertions"/> object that can be used to assert the
current <see cref="T:System.Collections.IEnumerable"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns an <see cref="T:FluentAssertions.Collections.GenericCollectionAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns an <see cref="T:FluentAssertions.Collections.StringCollectionAssertions"/> object that can be used to assert the
current <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should``2(System.Collections.Generic.IDictionary{``0,``1})">
<summary>
Returns an <see cref="T:FluentAssertions.Collections.GenericDictionaryAssertions`2"/> object that can be used to assert the
current <see cref="T:System.Collections.Generic.IDictionary`2"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.DateTime)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.DateTimeOffsetAssertions"/> object that can be used to assert the
current <see cref="T:System.DateTime"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.DateTimeOffset)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.DateTimeOffsetAssertions"/> object that can be used to assert the
current <see cref="T:System.DateTimeOffset"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.DateTime})">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.NullableDateTimeOffsetAssertions"/> object that can be used to assert the
current nullable <see cref="T:System.DateTime"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.DateTimeOffset})">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.NullableDateTimeOffsetAssertions"/> object that can be used to assert the
current nullable <see cref="T:System.DateTimeOffset"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should``1(System.IComparable{``0})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.ComparableTypeAssertions`1"/> object that can be used to assert the
current <see cref="T:System.IComparable`1"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Int32)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Int32"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.Int32})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Int32"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Decimal)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Decimal"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.Decimal})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Decimal"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Byte)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Byte"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.Byte})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Byte"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Int16)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Int16"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.Int16})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Int16"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Int64)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Int64"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.Int64})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Int64"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Single)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Single"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.Single})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Single"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Double)">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NumericAssertions`1"/> object that can be used to assert the
current <see cref="T:System.Double"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.Double})">
<summary>
Returns an <see cref="T:FluentAssertions.Numeric.NullableNumericAssertions`1"/> object that can be used to assert the
current nullable <see cref="T:System.Double"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.String)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.StringAssertions"/> object that can be used to assert the
current <see cref="T:System.String"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.TimeSpan)">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.SimpleTimeSpanAssertions"/> object that can be used to assert the
current <see cref="T:System.TimeSpan"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Nullable{System.TimeSpan})">
<summary>
Returns an <see cref="T:FluentAssertions.Primitives.NullableSimpleTimeSpanAssertions"/> object that can be used to assert the
current nullable <see cref="T:System.TimeSpan"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Type)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.TypeAssertions"/> object that can be used to assert the
current <see cref="T:System.Type"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(FluentAssertions.Types.TypeSelector)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.TypeAssertions"/> object that can be used to assert the
current <see cref="T:System.Type"/>.
</summary>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Reflection.MethodInfo)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.MethodInfoAssertions"/> object that can be used to assert the current <see cref="T:System.Reflection.MethodInfo"/>.
</summary>
<seealso cref="T:FluentAssertions.Types.TypeAssertions"/>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(FluentAssertions.Types.MethodInfoSelector)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.MethodInfoSelectorAssertions"/> object that can be used to assert the methods returned by the
current <see cref="T:FluentAssertions.Types.MethodInfoSelector"/>.
</summary>
<seealso cref="T:FluentAssertions.Types.TypeAssertions"/>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(System.Reflection.PropertyInfo)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.PropertyInfoAssertions"/> object that can be used to assert the
current <see cref="T:FluentAssertions.Types.PropertyInfoSelector"/>.
</summary>
<seealso cref="T:FluentAssertions.Types.TypeAssertions"/>
</member>
<member name="M:FluentAssertions.AssertionExtensions.Should(FluentAssertions.Types.PropertyInfoSelector)">
<summary>
Returns a <see cref="T:FluentAssertions.Types.PropertyInfoSelectorAssertions"/> object that can be used to assert the properties returned by the
current <see cref="T:FluentAssertions.Types.PropertyInfoSelector"/>.
</summary>
<seealso cref="T:FluentAssertions.Types.TypeAssertions"/>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ShouldBeEquivalentTo``1(``0,System.Object,System.String,System.Object[])">
<summary>
Asserts that an object is equivalent to another object.
</summary>
<remarks>
Objects are equivalent when both object graphs have equally named properties with the same value,
irrespective of the type of those objects. Two properties are also equal if one type can be converted to another and the result is equal.
The type of a collection property is ignored as long as the collection implements <see cref="T:System.Collections.IEnumerable"/> and all
items in the collection are structurally equal.
Notice that actual behavior is determined by the <see cref="F:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Default"/> instance of the
<see cref="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1"/> class.
</remarks>
<param name="because">
An optional formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the
assertion is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
</param>
</member>
<member name="M:FluentAssertions.AssertionExtensions.ShouldBeEquivalentTo``1(``0,System.Object,System.Func{FluentAssertions.Equivalency.EquivalencyAssertionOptions{``0},FluentAssertions.Equivalency.EquivalencyAssertionOptions{``0}},System.String,System.Object[])">
<summary>
Asserts that an object is equivalent to another object.
</summary>
<remarks>
Objects are equivalent when both object graphs have equally named properties with the same value,
irrespective of the type of those objects. Two properties are also equal if one type can be converted to another and the result is equal.
The type of a collection property is ignored as long as the collection implements <see cref="T:System.Collections.IEnumerable"/> and all
items in the collection are structurally equal.
</remarks>
<param name="config">
A reference to the <see cref="F:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1.Default"/> configuration object that can be used
to influence the way the object graphs are compared. You can also provide an alternative instance of the
<see cref="T:FluentAssertions.Equivalency.EquivalencyAssertionOptions`1"/> class.
</param>
<param name="because">
An optional formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the
assertion is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
</param>
</member>
<member name="M:FluentAssertions.AssertionExtensions.MonitorEvents(System.Object)">
<summary>
Starts monitoring an object for its events.
</summary>
<exception cref="T:System.ArgumentNullException">Thrown if eventSource is Null.</exception>
</member>
<member name="M:FluentAssertions.AssertionExtensions.As``1(System.Object)">
<summary>
Safely casts the specified object to the type specified through <typeparamref name="TTo"/>.
</summary>
<remarks>
Has been introduced to allow casting objects without breaking the fluent API.
</remarks>
<typeparam name="TTo"></typeparam>
</member>
<member name="M:FluentAssertions.Equivalency.ShouldAllBeEquivalentToHelper.ForCollectionMemberType``2(FluentAssertions.Equivalency.EquivalencyAssertionOptions{``1},System.Func{FluentAssertions.Equivalency.EquivalencyAssertionOptions{``0},FluentAssertions.Equivalency.EquivalencyAssertionOptions{``0}})">
<summary>
This converts the configuration provided provided by `ShouldAllBeEquivalentTo`
so that it is usable by `ShouldBeEquivalentTo`
</summary>
</member>
<member name="T:FluentAssertions.Events.EventHandlerFactory">
<summary>
Static methods that aid in generic event subscription
</summary>
</member>
<member name="M:FluentAssertions.Events.EventHandlerFactory.GenerateHandler(System.Type,FluentAssertions.Events.IEventRecorder)">
<summary>
Generates an eventhandler for an event of type eventSignature that calls RegisterEvent on recorder
when invoked.
</summary>
</member>
<member name="M:FluentAssertions.Events.EventHandlerFactory.GetDelegateReturnType(System.Type)">
<summary>
Finds the Return Type of a Delegate.
</summary>
</member>
<member name="M:FluentAssertions.Events.EventHandlerFactory.GetDelegateParameterTypes(System.Type)">
<summary>
Returns an Array of Types that make up a delegate's parameter signature.
</summary>
</member>
<member name="M:FluentAssertions.Events.EventHandlerFactory.AppendParameterListThisReference(System.Type[])">
<summary>
Returns an array of types appended with an EventRecorder reference at the beginning.
</summary>
</member>
<member name="M:FluentAssertions.Events.EventHandlerFactory.TypeIsDelegate(System.Type)">
<summary>
Returns T/F Dependent on a Type Being a Delegate.
</summary>
</member>
<member name="M:FluentAssertions.Events.EventHandlerFactory.DelegateInvokeMethod(System.Type)">
<summary>
Returns the MethodInfo for the Delegate's "Invoke" Method.
</summary>
</member>
<member name="T:FluentAssertions.Execution.FallbackTestFramework">
<summary>
Throws a generic exception in case no other test harness is detected.
</summary>
</member>
<member name="M:FluentAssertions.Execution.FallbackTestFramework.Throw(System.String)">
<summary>
Throws a framework-specific exception to indicate a failing unit test.
</summary>
</member>
<member name="P:FluentAssertions.Execution.FallbackTestFramework.IsAvailable">
<summary>
Gets a value indicating whether the corresponding test framework is currently available.
</summary>
</member>
<member name="M:FluentAssertions.Formatting.XAttributeValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.XAttributeValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.XDocumentValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.XElementValueFormatter.CanHandle(System.Object)">
<summary>
Indicates whether the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified <paramref name="value"/>.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<returns>
<c>true</c> if the current <see cref="T:FluentAssertions.Formatting.IValueFormatter"/> can handle the specified value; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:FluentAssertions.Formatting.XElementValueFormatter.ToString(System.Object,System.Boolean,System.Collections.Generic.IList{System.Object},System.Int32)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="value">The value for which to create a <see cref="T:System.String"/>.</param>
<param name="useLineBreaks"> </param>
<param name="processedObjects">
A collection of objects that
</param>
<param name="nestedPropertyLevel">
The level of nesting for the supplied value. This is used for indenting the format string for objects that have
no <see cref="M:System.Object.ToString"/> override.
</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:FluentAssertions.Reflection.AssemblyAssertions.NotReference(System.Reflection.Assembly)">
<summary>
Asserts that an assembly does not reference the specified assembly.
</summary>
<param name="assembly">The assembly which should not be referenced.</param>
</member>
<member name="M:FluentAssertions.Reflection.AssemblyAssertions.NotReference(System.Reflection.Assembly,System.String,System.String[])">
<summary>
Asserts that an assembly does not reference the specified assembly.
</summary>
<param name="assembly">The assembly which should not be referenced.</param>
<param name="bacause">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
</param>
</member>
<member name="M:FluentAssertions.Reflection.AssemblyAssertions.Reference(System.Reflection.Assembly)">
<summary>
Asserts that an assembly references the specified assembly.
</summary>
<param name="assembly">The assembly which should be referenced.</param>
</member>
<member name="M:FluentAssertions.Reflection.AssemblyAssertions.Reference(System.Reflection.Assembly,System.String,System.String[])">
<summary>
Asserts that an assembly references the specified assembly.
</summary>
<param name="assembly">The assembly which should be referenced.</param>
<param name="bacause">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:reason"/>.
</param>
</member>
<member name="T:FluentAssertions.Specialized.ExecutionTimeAssertions">
<summary>
Provides methods for asserting that the execution time of an <see cref="T:System.Action"/> satifies certain conditions.
</summary>
</member>
<member name="M:FluentAssertions.Specialized.ExecutionTimeAssertions.#ctor(System.Action)">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Specialized.ExecutionTimeAssertions"/> class.
</summary>
<param name="action">The action of which the execution time must be asserted.</param>
</member>
<member name="M:FluentAssertions.Specialized.ExecutionTimeAssertions.ShouldNotExceed(System.TimeSpan,System.String,System.Object[])">
<summary>
Asserts that the execution time of the operation does not exceed a specified amount of time.
</summary>
<param name="maxDuration">
The maximum allowed duration.
</param>
<param name="because">
A formatted phrase explaining why the assertion should be satisfied. If the phrase does not
start with the word <i>because</i>, it is prepended to the message.
</param>
<param name="reasonArgs">
Zero or more values to use for filling in any <see cref="M:System.String.Format(System.String,System.Object[])"/> compatible placeholders.
</param>
</member>
<member name="T:FluentAssertions.Specialized.MemberExecutionTimeAssertions`1">
<summary>
Provides methods for asserting that the execution time of an object member satifies certain conditions.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:FluentAssertions.Specialized.MemberExecutionTimeAssertions`1.#ctor(`0,System.Linq.Expressions.Expression{System.Action{`0}})">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Specialized.MemberExecutionTimeAssertions`1"/> class.
</summary>
<param name="subject">The object that exposes the method or property.</param>
<param name="action">A reference to the method or property to measure the execution time of.</param>
</member>
<member name="T:FluentAssertions.Xml.XAttributeAssertions">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Xml.Linq.XAttribute"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Xml.XAttributeAssertions.#ctor(System.Xml.Linq.XAttribute)">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Xml.XAttributeAssertions"/> class.
</summary>
</member>
<member name="M:FluentAssertions.Xml.XAttributeAssertions.Be(System.Xml.Linq.XAttribute)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XAttribute"/> equals the <paramref name="expected"/> attribute.
</summary>
<param name="expected">The expected attribute</param>
</member>
<member name="M:FluentAssertions.Xml.XAttributeAssertions.Be(System.Xml.Linq.XAttribute,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XAttribute"/> equals the <paramref name="expected"/> attribute.
</summary>
<param name="expected">The expected attribute</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XAttributeAssertions.NotBe(System.Xml.Linq.XAttribute)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XAttribute"/> does not equal the <paramref name="unexpected"/> attribute,
using its <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="unexpected">The unexpected attribute</param>
</member>
<member name="M:FluentAssertions.Xml.XAttributeAssertions.NotBe(System.Xml.Linq.XAttribute,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XAttribute"/> does not equal the <paramref name="unexpected"/> attribute,
using its <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="unexpected">The unexpected attribute</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XAttributeAssertions.HaveValue(System.String)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XAttribute"/> has the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
</member>
<member name="M:FluentAssertions.Xml.XAttributeAssertions.HaveValue(System.String,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XAttribute"/> has the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Xml.XAttributeAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Xml.XDocumentAssertions">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Xml.Linq.XDocument"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.#ctor(System.Xml.Linq.XDocument)">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Xml.XDocumentAssertions"/> class.
</summary>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.Be(System.Xml.Linq.XDocument)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> equals the <paramref name="expected"/> document,
using its <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected document</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.Be(System.Xml.Linq.XDocument,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> equals the <paramref name="expected"/> document,
using its <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="expected">The expected document</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.NotBe(System.Xml.Linq.XDocument)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> does not equal the <paramref name="unexpected"/> document,
using its <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="unexpected">The unexpected document</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.NotBe(System.Xml.Linq.XDocument,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> does not equal the <paramref name="unexpected"/> document,
using its <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="unexpected">The unexpected document</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.BeEquivalentTo(System.Xml.Linq.XDocument)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> is equivalent to the <paramref name="expected"/> document,
using its <see cref="!:XNode.DeepEquals()"/> implementation.
</summary>
<param name="expected">The expected document</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.BeEquivalentTo(System.Xml.Linq.XDocument,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> is equivalent to the <paramref name="expected"/> document,
using its <see cref="!:XNode.DeepEquals()"/> implementation.
</summary>
<param name="expected">The expected document</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.NotBeEquivalentTo(System.Xml.Linq.XDocument)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> is not equivalent to the <paramref name="unexpected"/> document,
using its <see cref="!:XNode.DeepEquals()"/> implementation.
</summary>
<param name="unexpected">The unexpected document</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.NotBeEquivalentTo(System.Xml.Linq.XDocument,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> is not equivalent to the <paramref name="unexpected"/> document,
using its <see cref="!:XNode.DeepEquals()"/> implementation.
</summary>
<param name="unexpected">The unexpected document</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.HaveRoot(System.String)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> has a root element with the specified
<paramref name="expected"/> name.
</summary>
<param name="expected">The name of the expected root element of the current document.</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.HaveRoot(System.Xml.Linq.XName)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> has a root element with the specified
<paramref name="expected"/> name.
</summary>
<param name="expected">The name of the expected root element of the current document.</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.HaveRoot(System.String,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> has a root element with the specified
<paramref name="expected"/> name.
</summary>
<param name="expected">The name of the expected root element of the current document.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.HaveRoot(System.Xml.Linq.XName,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XDocument"/> has a root element with the specified
<paramref name="expected"/> name.
</summary>
<param name="expected">The full name <see cref="T:System.Xml.Linq.XName"/> of the expected root element of the current document.</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.HaveElement(System.String)">
<summary>
Asserts that the <see cref="P:System.Xml.Linq.XDocument.Root"/> element of the current <see cref="T:System.Xml.Linq.XDocument"/> has a direct
child element with the specified <paramref name="expected"/> name.
</summary>
<param name="expected">
The name of the expected child element of the current document's Root <see cref="P:System.Xml.Linq.XDocument.Root"/> element.
</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.HaveElement(System.Xml.Linq.XName)">
<summary>
Asserts that the <see cref="P:System.Xml.Linq.XDocument.Root"/> element of the current <see cref="T:System.Xml.Linq.XDocument"/> has a direct
child element with the specified <paramref name="expected"/> name.
</summary>
<param name="expected">
The full name <see cref="T:System.Xml.Linq.XName"/> of the expected child element of the current document's Root <see cref="P:System.Xml.Linq.XDocument.Root"/> element.
</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.HaveElement(System.String,System.String,System.Object[])">
<summary>
Asserts that the <see cref="P:System.Xml.Linq.XDocument.Root"/> element of the current <see cref="T:System.Xml.Linq.XDocument"/> has a direct
child element with the specified <paramref name="expected"/> name.
</summary>
<param name="expected">
The name of the expected child element of the current document's Root <see cref="P:System.Xml.Linq.XDocument.Root"/> element.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XDocumentAssertions.HaveElement(System.Xml.Linq.XName,System.String,System.Object[])">
<summary>
Asserts that the <see cref="P:System.Xml.Linq.XDocument.Root"/> element of the current <see cref="T:System.Xml.Linq.XDocument"/> has a direct
child element with the specified <paramref name="expected"/> name.
</summary>
<param name="expected">
The full name <see cref="T:System.Xml.Linq.XName"/> of the expected child element of the current document's Root <see cref="P:System.Xml.Linq.XDocument.Root"/> element.
</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Xml.XDocumentAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
<member name="T:FluentAssertions.Xml.XElementAssertions">
<summary>
Contains a number of methods to assert that an <see cref="T:System.Xml.Linq.XElement"/> is in the expected state.
</summary>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.#ctor(System.Xml.Linq.XElement)">
<summary>
Initializes a new instance of the <see cref="T:FluentAssertions.Xml.XElementAssertions"/> class.
</summary>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.Be(System.Xml.Linq.XElement)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> equals the <paramref name="expected"/> element.
</summary>
<param name="expected">The expected element</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.Be(System.Xml.Linq.XElement,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> equals the <paramref name="expected"/> element.
</summary>
<param name="expected">The expected element</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.NotBe(System.Xml.Linq.XElement)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> does not equal the <paramref name="unexpected"/> element,
using its <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="unexpected">The unexpected element</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.NotBe(System.Xml.Linq.XElement,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> does not equal the <paramref name="unexpected"/> element,
using its <see cref="M:System.Object.Equals(System.Object)"/> implementation.
</summary>
<param name="unexpected">The unexpected element</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.BeEquivalentTo(System.Xml.Linq.XElement)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> is equivalent to the <paramref name="expected"/> element,
using its <see cref="!:XNode.DeepEquals()"/> implementation.
</summary>
<param name="expected">The expected element</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.BeEquivalentTo(System.Xml.Linq.XElement,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> is equivalent to the <paramref name="expected"/> element,
using its <see cref="!:XNode.DeepEquals()"/> implementation.
</summary>
<param name="expected">The expected element</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.NotBeEquivalentTo(System.Xml.Linq.XElement)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> is not equivalent to the <paramref name="unexpected"/> element,
using its <see cref="!:XNode.DeepEquals()"/> implementation.
</summary>
<param name="unexpected">The unexpected element</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.NotBeEquivalentTo(System.Xml.Linq.XElement,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> is not equivalent to the <paramref name="unexpected"/> element,
using its <see cref="!:XNode.DeepEquals()"/> implementation.
</summary>
<param name="unexpected">The unexpected element</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveValue(System.String)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveValue(System.String,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has the specified <paramref name="expected"/> value.
</summary>
<param name="expected">The expected value</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveAttribute(System.String,System.String)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has an attribute with the specified <paramref name="expectedName"/>
and <paramref name="expectedValue"/>.
</summary>
<param name="expectedName">The name of the expected attribute</param>
<param name="expectedValue">The value of the expected attribute</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveAttribute(System.Xml.Linq.XName,System.String)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has an attribute with the specified <paramref name="expectedName"/>
and <paramref name="expectedValue"/>.
</summary>
<param name="expectedName">The name <see cref="T:System.Xml.Linq.XName"/> of the expected attribute</param>
<param name="expectedValue">The value of the expected attribute</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveAttribute(System.String,System.String,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has an attribute with the specified <paramref name="expectedName"/>
and <paramref name="expectedValue"/>.
</summary>
<param name="expectedName">The name of the expected attribute</param>
<param name="expectedValue">The value of the expected attribute</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveAttribute(System.Xml.Linq.XName,System.String,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has an attribute with the specified <paramref name="expectedName"/>
and <paramref name="expectedValue"/>.
</summary>
<param name="expectedName">The name <see cref="T:System.Xml.Linq.XName"/> of the expected attribute</param>
<param name="expectedValue">The value of the expected attribute</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveElement(System.String)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has a direct child element with the specified
<paramref name="expected"/> name.
</summary>
<param name="expected">The name of the expected child element</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveElement(System.Xml.Linq.XName)">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has a direct child element with the specified
<paramref name="expected"/> name.
</summary>
<param name="expected">The name <see cref="T:System.Xml.Linq.XName"/> of the expected child element</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveElement(System.String,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has a direct child element with the specified
<paramref name="expected"/> name.
</summary>
<param name="expected">The name <see cref="T:System.Xml.Linq.XName"/> of the expected child element</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="M:FluentAssertions.Xml.XElementAssertions.HaveElement(System.Xml.Linq.XName,System.String,System.Object[])">
<summary>
Asserts that the current <see cref="T:System.Xml.Linq.XElement"/> has a direct child element with the specified
<paramref name="expected"/> name.
</summary>
<param name="expected">The name <see cref="T:System.Xml.Linq.XName"/> of the expected child element</param>
<param name="because">
A formatted phrase as is supported by <see cref="M:System.String.Format(System.String,System.Object[])"/> explaining why the assertion
is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
</param>
<param name="reasonArgs">
Zero or more objects to format using the placeholders in <see cref="!:because"/>.
</param>
</member>
<member name="P:FluentAssertions.Xml.XElementAssertions.Context">
<summary>
Returns the type of the subject the assertion applies on.
</summary>
</member>
</members>
</doc>
<?xml version="1.0"?>
<doc>
<assembly>
<name>Ionic.Zip</name>
</assembly>
<members>
<member name="T:Ionic.Zip.ZipEntrySource">
<summary>
An enum that specifies the source of the ZipEntry.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntrySource.None">
<summary>
Default value. Invalid on a bonafide ZipEntry.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntrySource.FileSystem">
<summary>
The entry was instantiated by calling AddFile() or another method that
added an entry from the filesystem.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntrySource.Stream">
<summary>
The entry was instantiated via <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.String)"/> or
<see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.IO.Stream)"/> .
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntrySource.ZipFile">
<summary>
The ZipEntry was instantiated by reading a zipfile.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntrySource.WriteDelegate">
<summary>
The content for the ZipEntry will be or was provided by the WriteDelegate.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntrySource.JitStream">
<summary>
The content for the ZipEntry will be obtained from the stream dispensed by the <c>OpenDelegate</c>.
The entry was instantiated via <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)"/>.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntrySource.ZipOutputStream">
<summary>
The content for the ZipEntry will be or was obtained from a <c>ZipOutputStream</c>.
</summary>
</member>
<member name="T:Ionic.Zip.ZipOutputStream">
<summary>
Provides a stream metaphor for generating zip files.
</summary>
<remarks>
<para>
This class writes zip files, as defined in the <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">specification
for zip files described by PKWare</see>. The compression for this
implementation is provided by a managed-code version of Zlib, included with
DotNetZip in the classes in the Ionic.Zlib namespace.
</para>
<para>
This class provides an alternative programming model to the one enabled by the
<see cref="T:Ionic.Zip.ZipFile"/> class. Use this when creating zip files, as an
alternative to the <see cref="T:Ionic.Zip.ZipFile"/> class, when you would like to use a
<c>Stream</c> type to write the zip file.
</para>
<para>
Both the <c>ZipOutputStream</c> class and the <c>ZipFile</c> class can be used
to create zip files. Both of them support many of the common zip features,
including Unicode, different compression levels, and ZIP64. They provide
very similar performance when creating zip files.
</para>
<para>
The <c>ZipFile</c> class is generally easier to use than
<c>ZipOutputStream</c> and should be considered a higher-level interface. For
example, when creating a zip file via calls to the <c>PutNextEntry()</c> and
<c>Write()</c> methods on the <c>ZipOutputStream</c> class, the caller is
responsible for opening the file, reading the bytes from the file, writing
those bytes into the <c>ZipOutputStream</c>, setting the attributes on the
<c>ZipEntry</c>, and setting the created, last modified, and last accessed
timestamps on the zip entry. All of these things are done automatically by a
call to <see cref="M:Ionic.Zip.ZipFile.AddFile(System.String,System.String)">ZipFile.AddFile()</see>.
For this reason, the <c>ZipOutputStream</c> is generally recommended for use
only when your application emits arbitrary data, not necessarily data from a
filesystem file, directly into a zip file, and does so using a <c>Stream</c>
metaphor.
</para>
<para>
Aside from the differences in programming model, there are other
differences in capability between the two classes.
</para>
<list type="bullet">
<item>
<c>ZipFile</c> can be used to read and extract zip files, in addition to
creating zip files. <c>ZipOutputStream</c> cannot read zip files. If you want
to use a stream to read zip files, check out the <see cref="T:Ionic.Zip.ZipInputStream"/> class.
</item>
<item>
<c>ZipOutputStream</c> does not support the creation of segmented or spanned
zip files.
</item>
<item>
<c>ZipOutputStream</c> cannot produce a self-extracting archive.
</item>
</list>
<para>
Be aware that the <c>ZipOutputStream</c> class implements the <see cref="T:System.IDisposable"/> interface. In order for
<c>ZipOutputStream</c> to produce a valid zip file, you use use it within
a using clause (<c>Using</c> in VB), or call the <c>Dispose()</c> method
explicitly. See the examples for how to employ a using clause.
</para>
<para>
Also, a note regarding compression performance: On the desktop .NET
Framework, DotNetZip can use a multi-threaded compression implementation
that provides significant speed increases on large files, over 300k or so,
at the cost of increased memory use at runtime. (The output of the
compression is almost exactly the same size). But, the multi-threaded
approach incurs a performance hit on smaller files. There's no way for the
ZipOutputStream to know whether parallel compression will be beneficial,
because the ZipOutputStream does not know how much data you will write
through the stream. You may wish to set the <see cref="P:Ionic.Zip.ZipOutputStream.ParallelDeflateThreshold"/> property to zero, if you are compressing
large files through <c>ZipOutputStream</c>. This will cause parallel
compression to be used, always.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.#ctor(System.IO.Stream)">
<summary>
Create a ZipOutputStream, wrapping an existing stream.
</summary>
<remarks>
<para>
The <see cref="T:Ionic.Zip.ZipFile"/> class is generally easier to use when creating
zip files. The ZipOutputStream offers a different metaphor for creating a
zip file, based on the <see cref="T:System.IO.Stream"/> class.
</para>
</remarks>
<param name="stream">
The stream to wrap. It must be writable. This stream will be closed at
the time the ZipOutputStream is closed.
</param>
<example>
This example shows how to create a zip file, using the
ZipOutputStream class.
<code lang="C#">
private void Zipup()
{
if (filesToZip.Count == 0)
{
System.Console.WriteLine("Nothing to do.");
return;
}
using (var raw = File.Open(_outputFileName, FileMode.Create, FileAccess.ReadWrite ))
{
using (var output= new ZipOutputStream(raw))
{
output.Password = "VerySecret!";
output.Encryption = EncryptionAlgorithm.WinZipAes256;
foreach (string inputFileName in filesToZip)
{
System.Console.WriteLine("file: {0}", inputFileName);
output.PutNextEntry(inputFileName);
using (var input = File.Open(inputFileName, FileMode.Open, FileAccess.Read, FileShare.Read | FileShare.Write ))
{
byte[] buffer= new byte[2048];
int n;
while ((n= input.Read(buffer,0,buffer.Length)) > 0)
{
output.Write(buffer,0,n);
}
}
}
}
}
}
</code>
<code lang="VB">
Private Sub Zipup()
Dim outputFileName As String = "XmlData.zip"
Dim filesToZip As String() = Directory.GetFiles(".", "*.xml")
If (filesToZip.Length = 0) Then
Console.WriteLine("Nothing to do.")
Else
Using raw As FileStream = File.Open(outputFileName, FileMode.Create, FileAccess.ReadWrite)
Using output As ZipOutputStream = New ZipOutputStream(raw)
output.Password = "VerySecret!"
output.Encryption = EncryptionAlgorithm.WinZipAes256
Dim inputFileName As String
For Each inputFileName In filesToZip
Console.WriteLine("file: {0}", inputFileName)
output.PutNextEntry(inputFileName)
Using input As FileStream = File.Open(inputFileName, FileMode.Open, FileAccess.Read, FileShare.ReadWrite)
Dim n As Integer
Dim buffer As Byte() = New Byte(2048) {}
Do While (n = input.Read(buffer, 0, buffer.Length) > 0)
output.Write(buffer, 0, n)
Loop
End Using
Next
End Using
End Using
End If
End Sub
</code>
</example>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.#ctor(System.String)">
<summary>
Create a ZipOutputStream that writes to a filesystem file.
</summary>
<remarks>
The <see cref="T:Ionic.Zip.ZipFile"/> class is generally easier to use when creating
zip files. The ZipOutputStream offers a different metaphor for creating a
zip file, based on the <see cref="T:System.IO.Stream"/> class.
</remarks>
<param name="fileName">
The name of the zip file to create.
</param>
<example>
This example shows how to create a zip file, using the
ZipOutputStream class.
<code lang="C#">
private void Zipup()
{
if (filesToZip.Count == 0)
{
System.Console.WriteLine("Nothing to do.");
return;
}
using (var output= new ZipOutputStream(outputFileName))
{
output.Password = "VerySecret!";
output.Encryption = EncryptionAlgorithm.WinZipAes256;
foreach (string inputFileName in filesToZip)
{
System.Console.WriteLine("file: {0}", inputFileName);
output.PutNextEntry(inputFileName);
using (var input = File.Open(inputFileName, FileMode.Open, FileAccess.Read,
FileShare.Read | FileShare.Write ))
{
byte[] buffer= new byte[2048];
int n;
while ((n= input.Read(buffer,0,buffer.Length)) > 0)
{
output.Write(buffer,0,n);
}
}
}
}
}
</code>
<code lang="VB">
Private Sub Zipup()
Dim outputFileName As String = "XmlData.zip"
Dim filesToZip As String() = Directory.GetFiles(".", "*.xml")
If (filesToZip.Length = 0) Then
Console.WriteLine("Nothing to do.")
Else
Using output As ZipOutputStream = New ZipOutputStream(outputFileName)
output.Password = "VerySecret!"
output.Encryption = EncryptionAlgorithm.WinZipAes256
Dim inputFileName As String
For Each inputFileName In filesToZip
Console.WriteLine("file: {0}", inputFileName)
output.PutNextEntry(inputFileName)
Using input As FileStream = File.Open(inputFileName, FileMode.Open, FileAccess.Read, FileShare.ReadWrite)
Dim n As Integer
Dim buffer As Byte() = New Byte(2048) {}
Do While (n = input.Read(buffer, 0, buffer.Length) > 0)
output.Write(buffer, 0, n)
Loop
End Using
Next
End Using
End If
End Sub
</code>
</example>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Create a ZipOutputStream.
</summary>
<remarks>
See the documentation for the <see cref="M:Ionic.Zip.ZipOutputStream.#ctor(System.IO.Stream)">ZipOutputStream(Stream)</see>
constructor for an example.
</remarks>
<param name="stream">
The stream to wrap. It must be writable.
</param>
<param name="leaveOpen">
true if the application would like the stream
to remain open after the <c>ZipOutputStream</c> has been closed.
</param>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.ToString">
<summary>Provides a string representation of the instance.</summary>
<remarks>
<para>
This can be useful for debugging purposes.
</para>
</remarks>
<returns>a string representation of the instance.</returns>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.ContainsEntry(System.String)">
<summary>
Returns true if an entry by the given name has already been written
to the ZipOutputStream.
</summary>
<param name="name">
The name of the entry to scan for.
</param>
<returns>
true if an entry by the given name has already been written.
</returns>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write the data from the buffer to the stream.
</summary>
<remarks>
As the application writes data into this stream, the data may be
compressed and encrypted before being written out to the underlying
stream, depending on the settings of the <see cref="P:Ionic.Zip.ZipOutputStream.CompressionLevel"/>
and the <see cref="P:Ionic.Zip.ZipOutputStream.Encryption"/> properties.
</remarks>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.PutNextEntry(System.String)">
<summary>
Specify the name of the next entry that will be written to the zip file.
</summary>
<remarks>
<para>
Call this method just before calling <see cref="M:Ionic.Zip.ZipOutputStream.Write(System.Byte[],System.Int32,System.Int32)"/>, to
specify the name of the entry that the next set of bytes written to
the <c>ZipOutputStream</c> belongs to. All subsequent calls to <c>Write</c>,
until the next call to <c>PutNextEntry</c>,
will be inserted into the named entry in the zip file.
</para>
<para>
If the <paramref name="entryName"/> used in <c>PutNextEntry()</c> ends in
a slash, then the entry added is marked as a directory. Because directory
entries do not contain data, a call to <c>Write()</c>, before an
intervening additional call to <c>PutNextEntry()</c>, will throw an
exception.
</para>
<para>
If you don't call <c>Write()</c> between two calls to
<c>PutNextEntry()</c>, the first entry is inserted into the zip file as a
file of zero size. This may be what you want.
</para>
<para>
Because <c>PutNextEntry()</c> closes out the prior entry, if any, this
method may throw if there is a problem with the prior entry.
</para>
<para>
This method returns the <c>ZipEntry</c>. You can modify public properties
on the <c>ZipEntry</c>, such as <see cref="P:Ionic.Zip.ZipEntry.Encryption"/>, <see cref="P:Ionic.Zip.ZipEntry.Password"/>, and so on, until the first call to
<c>ZipOutputStream.Write()</c>, or until the next call to
<c>PutNextEntry()</c>. If you modify the <c>ZipEntry</c> <em>after</em>
having called <c>Write()</c>, you may get a runtime exception, or you may
silently get an invalid zip archive.
</para>
</remarks>
<example>
This example shows how to create a zip file, using the
<c>ZipOutputStream</c> class.
<code>
private void Zipup()
{
using (FileStream fs raw = File.Open(_outputFileName, FileMode.Create, FileAccess.ReadWrite ))
{
using (var output= new ZipOutputStream(fs))
{
output.Password = "VerySecret!";
output.Encryption = EncryptionAlgorithm.WinZipAes256;
output.PutNextEntry("entry1.txt");
byte[] buffer= System.Text.Encoding.ASCII.GetBytes("This is the content for entry #1.");
output.Write(buffer,0,buffer.Length);
output.PutNextEntry("entry2.txt"); // this will be zero length
output.PutNextEntry("entry3.txt");
buffer= System.Text.Encoding.ASCII.GetBytes("This is the content for entry #3.");
output.Write(buffer,0,buffer.Length);
}
}
}
</code>
</example>
<param name="entryName">
The name of the entry to be added, including any path to be used
within the zip file.
</param>
<returns>
The ZipEntry created.
</returns>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.Dispose(System.Boolean)">
<summary>
Dispose the stream
</summary>
<remarks>
<para>
This method writes the Zip Central directory, then closes the stream. The
application must call Dispose() (or Close) in order to produce a valid zip file.
</para>
<para>
Typically the application will call <c>Dispose()</c> implicitly, via a <c>using</c>
statement in C#, or a <c>Using</c> statement in VB.
</para>
</remarks>
<param name="disposing">set this to true, always.</param>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.Flush">
<summary>
This is a no-op.
</summary>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
This method always throws a NotSupportedException.
</summary>
<param name="buffer">ignored</param>
<param name="offset">ignored</param>
<param name="count">ignored</param>
<returns>nothing</returns>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
This method always throws a NotSupportedException.
</summary>
<param name="offset">ignored</param>
<param name="origin">ignored</param>
<returns>nothing</returns>
</member>
<member name="M:Ionic.Zip.ZipOutputStream.SetLength(System.Int64)">
<summary>
This method always throws a NotSupportedException.
</summary>
<param name="value">ignored</param>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.Password">
<summary>
Sets the password to be used on the <c>ZipOutputStream</c> instance.
</summary>
<remarks>
<para>
When writing a zip archive, this password is applied to the entries, not
to the zip archive itself. It applies to any <c>ZipEntry</c> subsequently
written to the <c>ZipOutputStream</c>.
</para>
<para>
Using a password does not encrypt or protect the "directory" of the
archive - the list of entries contained in the archive. If you set the
<c>Password</c> property, the password actually applies to individual
entries that are added to the archive, subsequent to the setting of this
property. The list of filenames in the archive that is eventually created
will appear in clear text, but the contents of the individual files are
encrypted. This is how Zip encryption works.
</para>
<para>
If you set this property, and then add a set of entries to the archive via
calls to <c>PutNextEntry</c>, then each entry is encrypted with that
password. You may also want to change the password between adding
different entries. If you set the password, add an entry, then set the
password to <c>null</c> (<c>Nothing</c> in VB), and add another entry, the
first entry is encrypted and the second is not.
</para>
<para>
When setting the <c>Password</c>, you may also want to explicitly set the <see cref="P:Ionic.Zip.ZipOutputStream.Encryption"/> property, to specify how to encrypt the entries added
to the ZipFile. If you set the <c>Password</c> to a non-null value and do not
set <see cref="P:Ionic.Zip.ZipOutputStream.Encryption"/>, then PKZip 2.0 ("Weak") encryption is used.
This encryption is relatively weak but is very interoperable. If
you set the password to a <c>null</c> value (<c>Nothing</c> in VB),
<c>Encryption</c> is reset to None.
</para>
<para>
Special case: if you wrap a ZipOutputStream around a non-seekable stream,
and use encryption, and emit an entry of zero bytes, the <c>Close()</c> or
<c>PutNextEntry()</c> following the entry will throw an exception.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.Encryption">
<summary>
The Encryption to use for entries added to the <c>ZipOutputStream</c>.
</summary>
<remarks>
<para>
The specified Encryption is applied to the entries subsequently
written to the <c>ZipOutputStream</c> instance.
</para>
<para>
If you set this to something other than
EncryptionAlgorithm.None, you will also need to set the
<see cref="P:Ionic.Zip.ZipOutputStream.Password"/> to a non-null, non-empty value in
order to actually get encryption on the entry.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipOutputStream.Password">ZipOutputStream.Password</seealso>
<seealso cref="P:Ionic.Zip.ZipEntry.Encryption">ZipEntry.Encryption</seealso>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.CodecBufferSize">
<summary>
Size of the work buffer to use for the ZLIB codec during compression.
</summary>
<remarks>
Setting this may affect performance. For larger files, setting this to a
larger size may improve performance, but I'm not sure. Sorry, I don't
currently have good recommendations on how to set it. You can test it if
you like.
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.Strategy">
<summary>
The compression strategy to use for all entries.
</summary>
<remarks>
Set the Strategy used by the ZLIB-compatible compressor, when compressing
data for the entries in the zip archive. Different compression strategies
work better on different sorts of data. The strategy parameter can affect
the compression ratio and the speed of compression but not the correctness
of the compresssion. For more information see <see cref="T:Ionic.Zlib.CompressionStrategy"/>.
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.Timestamp">
<summary>
The type of timestamp attached to the ZipEntry.
</summary>
<remarks>
Set this in order to specify the kind of timestamp that should be emitted
into the zip file for each entry.
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.CompressionLevel">
<summary>
Sets the compression level to be used for entries subsequently added to
the zip archive.
</summary>
<remarks>
<para>
Varying the compression level used on entries can affect the
size-vs-speed tradeoff when compression and decompressing data streams
or files.
</para>
<para>
As with some other properties on the <c>ZipOutputStream</c> class, like <see cref="P:Ionic.Zip.ZipOutputStream.Password"/>, and <see cref="P:Ionic.Zip.ZipOutputStream.Encryption"/>,
setting this property on a <c>ZipOutputStream</c>
instance will cause the specified <c>CompressionLevel</c> to be used on all
<see cref="T:Ionic.Zip.ZipEntry"/> items that are subsequently added to the
<c>ZipOutputStream</c> instance.
</para>
<para>
If you do not set this property, the default compression level is used,
which normally gives a good balance of compression efficiency and
compression speed. In some tests, using <c>BestCompression</c> can
double the time it takes to compress, while delivering just a small
increase in compression efficiency. This behavior will vary with the
type of data you compress. If you are in doubt, just leave this setting
alone, and accept the default.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.CompressionMethod">
<summary>
The compression method used on each entry added to the ZipOutputStream.
</summary>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.Comment">
<summary>
A comment attached to the zip archive.
</summary>
<remarks>
<para>
The application sets this property to specify a comment to be embedded
into the generated zip archive.
</para>
<para>
According to <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's
zip specification</see>, the comment is not encrypted, even if there is a
password set on the zip file.
</para>
<para>
The specification does not describe how to indicate the encoding used
on a comment string. Many "compliant" zip tools and libraries use
IBM437 as the code page for comments; DotNetZip, too, follows that
practice. On the other hand, there are situations where you want a
Comment to be encoded with something else, for example using code page
950 "Big-5 Chinese". To fill that need, DotNetZip will encode the
comment following the same procedure it follows for encoding
filenames: (a) if <see cref="P:Ionic.Zip.ZipOutputStream.AlternateEncodingUsage"/> is
<c>Never</c>, it uses the default encoding (IBM437). (b) if <see cref="P:Ionic.Zip.ZipOutputStream.AlternateEncodingUsage"/> is <c>Always</c>, it always uses the
alternate encoding (<see cref="P:Ionic.Zip.ZipOutputStream.AlternateEncoding"/>). (c) if <see cref="P:Ionic.Zip.ZipOutputStream.AlternateEncodingUsage"/> is <c>AsNecessary</c>, it uses the
alternate encoding only if the default encoding is not sufficient for
encoding the comment - in other words if decoding the result does not
produce the original string. This decision is taken at the time of
the call to <c>ZipFile.Save()</c>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.EnableZip64">
<summary>
Specify whether to use ZIP64 extensions when saving a zip archive.
</summary>
<remarks>
<para>
The default value for the property is <see cref="F:Ionic.Zip.Zip64Option.Never"/>. <see cref="F:Ionic.Zip.Zip64Option.AsNecessary"/> is
safest, in the sense that you will not get an Exception if a
pre-ZIP64 limit is exceeded.
</para>
<para>
You must set this property before calling <c>Write()</c>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.OutputUsedZip64">
<summary>
Indicates whether ZIP64 extensions were used when saving the zip archive.
</summary>
<remarks>
The value is defined only after the <c>ZipOutputStream</c> has been closed.
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.IgnoreCase">
<summary>
Whether the ZipOutputStream should use case-insensitive comparisons when
checking for uniqueness of zip entries.
</summary>
<remarks>
<para>
Though the zip specification doesn't prohibit zipfiles with duplicate
entries, Sane zip files have no duplicates, and the DotNetZip library
cannot create zip files with duplicate entries. If an application attempts
to call <see cref="M:Ionic.Zip.ZipOutputStream.PutNextEntry(System.String)"/> with a name that duplicates one
already used within the archive, the library will throw an Exception.
</para>
<para>
This property allows the application to specify whether the
ZipOutputStream instance considers ordinal case when checking for
uniqueness of zip entries.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.UseUnicodeAsNecessary">
<summary>
Indicates whether to encode entry filenames and entry comments using
Unicode (UTF-8).
</summary>
<remarks>
<para>
<see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">The
PKWare zip specification</see> provides for encoding file names and file
comments in either the IBM437 code page, or in UTF-8. This flag selects
the encoding according to that specification. By default, this flag is
false, and filenames and comments are encoded into the zip file in the
IBM437 codepage. Setting this flag to true will specify that filenames
and comments that cannot be encoded with IBM437 will be encoded with
UTF-8.
</para>
<para>
Zip files created with strict adherence to the PKWare specification with
respect to UTF-8 encoding can contain entries with filenames containing
any combination of Unicode characters, including the full range of
characters from Chinese, Latin, Hebrew, Greek, Cyrillic, and many other
alphabets. However, because at this time, the UTF-8 portion of the PKWare
specification is not broadly supported by other zip libraries and
utilities, such zip files may not be readable by your favorite zip tool or
archiver. In other words, interoperability will decrease if you set this
flag to true.
</para>
<para>
In particular, Zip files created with strict adherence to the PKWare
specification with respect to UTF-8 encoding will not work well with
Explorer in Windows XP or Windows Vista, because Windows compressed
folders, as far as I know, do not support UTF-8 in zip files. Vista can
read the zip files, but shows the filenames incorrectly. Unpacking from
Windows Vista Explorer will result in filenames that have rubbish
characters in place of the high-order UTF-8 bytes.
</para>
<para>
Also, zip files that use UTF-8 encoding will not work well with Java
applications that use the java.util.zip classes, as of v5.0 of the Java
runtime. The Java runtime does not correctly implement the PKWare
specification in this regard.
</para>
<para>
As a result, we have the unfortunate situation that "correct" behavior by
the DotNetZip library with regard to Unicode encoding of filenames during
zip creation will result in zip files that are readable by strictly
compliant and current tools (for example the most recent release of the
commercial WinZip tool); but these zip files will not be readable by
various other tools or libraries, including Windows Explorer.
</para>
<para>
The DotNetZip library can read and write zip files with UTF8-encoded
entries, according to the PKware spec. If you use DotNetZip for both
creating and reading the zip file, and you use UTF-8, there will be no
loss of information in the filenames. For example, using a self-extractor
created by this library will allow you to unpack files correctly with no
loss of information in the filenames.
</para>
<para>
If you do not set this flag, it will remain false. If this flag is false,
the <c>ZipOutputStream</c> will encode all filenames and comments using
the IBM437 codepage. This can cause "loss of information" on some
filenames, but the resulting zipfile will be more interoperable with other
utilities. As an example of the loss of information, diacritics can be
lost. The o-tilde character will be down-coded to plain o. The c with a
cedilla (Unicode 0xE7) used in Portugese will be downcoded to a c.
Likewise, the O-stroke character (Unicode 248), used in Danish and
Norwegian, will be down-coded to plain o. Chinese characters cannot be
represented in codepage IBM437; when using the default encoding, Chinese
characters in filenames will be represented as ?. These are all examples
of "information loss".
</para>
<para>
The loss of information associated to the use of the IBM437 encoding is
inconvenient, and can also lead to runtime errors. For example, using
IBM437, any sequence of 4 Chinese characters will be encoded as ????. If
your application creates a <c>ZipOutputStream</c>, does not set the
encoding, then adds two files, each with names of four Chinese characters
each, this will result in a duplicate filename exception. In the case
where you add a single file with a name containing four Chinese
characters, the zipfile will save properly, but extracting that file
later, with any zip tool, will result in an error, because the question
mark is not legal for use within filenames on Windows. These are just a
few examples of the problems associated to loss of information.
</para>
<para>
This flag is independent of the encoding of the content within the entries
in the zip file. Think of the zip file as a container - it supports an
encoding. Within the container are other "containers" - the file entries
themselves. The encoding within those entries is independent of the
encoding of the zip archive container for those entries.
</para>
<para>
Rather than specify the encoding in a binary fashion using this flag, an
application can specify an arbitrary encoding via the <see cref="P:Ionic.Zip.ZipOutputStream.ProvisionalAlternateEncoding"/> property. Setting the encoding
explicitly when creating zip archives will result in non-compliant zip
files that, curiously, are fairly interoperable. The challenge is, the
PKWare specification does not provide for a way to specify that an entry
in a zip archive uses a code page that is neither IBM437 nor UTF-8.
Therefore if you set the encoding explicitly when creating a zip archive,
you must take care upon reading the zip archive to use the same code page.
If you get it wrong, the behavior is undefined and may result in incorrect
filenames, exceptions, stomach upset, hair loss, and acne.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipOutputStream.ProvisionalAlternateEncoding"/>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.ProvisionalAlternateEncoding">
<summary>
The text encoding to use when emitting entries into the zip archive, for
those entries whose filenames or comments cannot be encoded with the
default (IBM437) encoding.
</summary>
<remarks>
<para>
In <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">its
zip specification</see>, PKWare describes two options for encoding
filenames and comments: using IBM437 or UTF-8. But, some archiving tools
or libraries do not follow the specification, and instead encode
characters using the system default code page. For example, WinRAR when
run on a machine in Shanghai may encode filenames with the Big-5 Chinese
(950) code page. This behavior is contrary to the Zip specification, but
it occurs anyway.
</para>
<para>
When using DotNetZip to write zip archives that will be read by one of
these other archivers, set this property to specify the code page to use
when encoding the <see cref="P:Ionic.Zip.ZipEntry.FileName"/> and <see cref="P:Ionic.Zip.ZipEntry.Comment"/> for each <c>ZipEntry</c> in the zip file, for
values that cannot be encoded with the default codepage for zip files,
IBM437. This is why this property is "provisional". In all cases, IBM437
is used where possible, in other words, where no loss of data would
result. It is possible, therefore, to have a given entry with a
<c>Comment</c> encoded in IBM437 and a <c>FileName</c> encoded with the
specified "provisional" codepage.
</para>
<para>
Be aware that a zip file created after you've explicitly set the
<c>ProvisionalAlternateEncoding</c> property to a value other than
IBM437 may not be compliant to the PKWare specification, and may not be
readable by compliant archivers. On the other hand, many (most?)
archivers are non-compliant and can read zip files created in arbitrary
code pages. The trick is to use or specify the proper codepage when
reading the zip.
</para>
<para>
When creating a zip archive using this library, it is possible to change
the value of <c>ProvisionalAlternateEncoding</c> between each entry you
add, and between adding entries and the call to <c>Close()</c>. Don't do
this. It will likely result in a zipfile that is not readable. For best
interoperability, either leave <c>ProvisionalAlternateEncoding</c>
alone, or specify it only once, before adding any entries to the
<c>ZipOutputStream</c> instance. There is one exception to this
recommendation, described later.
</para>
<para>
When using an arbitrary, non-UTF8 code page for encoding, there is no
standard way for the creator application - whether DotNetZip, WinZip,
WinRar, or something else - to formally specify in the zip file which
codepage has been used for the entries. As a result, readers of zip files
are not able to inspect the zip file and determine the codepage that was
used for the entries contained within it. It is left to the application
or user to determine the necessary codepage when reading zip files encoded
this way. If you use an incorrect codepage when reading a zipfile, you
will get entries with filenames that are incorrect, and the incorrect
filenames may even contain characters that are not legal for use within
filenames in Windows. Extracting entries with illegal characters in the
filenames will lead to exceptions. It's too bad, but this is just the way
things are with code pages in zip files. Caveat Emptor.
</para>
<para>
One possible approach for specifying the code page for a given zip file is
to describe the code page in a human-readable form in the Zip comment. For
example, the comment may read "Entries in this archive are encoded in the
Big5 code page". For maximum interoperability, the zip comment in this
case should be encoded in the default, IBM437 code page. In this case,
the zip comment is encoded using a different page than the filenames. To
do this, Specify <c>ProvisionalAlternateEncoding</c> to your desired
region-specific code page, once before adding any entries, and then set
the <see cref="P:Ionic.Zip.ZipOutputStream.Comment"/> property and reset
<c>ProvisionalAlternateEncoding</c> to IBM437 before calling <c>Close()</c>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.AlternateEncoding">
<summary>
A Text Encoding to use when encoding the filenames and comments for
all the ZipEntry items, during a ZipFile.Save() operation.
</summary>
<remarks>
<para>
Whether the encoding specified here is used during the save depends
on <see cref="P:Ionic.Zip.ZipOutputStream.AlternateEncodingUsage"/>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.AlternateEncodingUsage">
<summary>
A flag that tells if and when this instance should apply
AlternateEncoding to encode the filenames and comments associated to
of ZipEntry objects contained within this instance.
</summary>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.DefaultEncoding">
<summary>
The default text encoding used in zip archives. It is numeric 437, also
known as IBM437.
</summary>
<seealso cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.ParallelDeflateThreshold">
<summary>
The size threshold for an entry, above which a parallel deflate is used.
</summary>
<remarks>
<para>
DotNetZip will use multiple threads to compress any ZipEntry, when
the <c>CompressionMethod</c> is Deflate, and if the entry is
larger than the given size. Zero means "always use parallel
deflate", while -1 means "never use parallel deflate".
</para>
<para>
If the entry size cannot be known before compression, as with any entry
added via a ZipOutputStream, then Parallel deflate will never be
performed, unless the value of this property is zero.
</para>
<para>
A parallel deflate operations will speed up the compression of
large files, on computers with multiple CPUs or multiple CPU
cores. For files above 1mb, on a dual core or dual-cpu (2p)
machine, the time required to compress the file can be 70% of the
single-threaded deflate. For very large files on 4p machines the
compression can be done in 30% of the normal time. The downside
is that parallel deflate consumes extra memory during the deflate,
and the deflation is slightly less effective.
</para>
<para>
Parallel deflate tends to not be as effective as single-threaded deflate
because the original data stream is split into multiple independent
buffers, each of which is compressed in parallel. But because they are
treated independently, there is no opportunity to share compression
dictionaries, and additional framing bytes must be added to the output
stream. For that reason, a deflated stream may be slightly larger when
compressed using parallel deflate, as compared to a traditional
single-threaded deflate. For files of about 512k, the increase over the
normal deflate is as much as 5% of the total compressed size. For larger
files, the difference can be as small as 0.1%.
</para>
<para>
Multi-threaded compression does not give as much an advantage when using
Encryption. This is primarily because encryption tends to slow down
the entire pipeline. Also, multi-threaded compression gives less of an
advantage when using lower compression levels, for example <see cref="F:Ionic.Zlib.CompressionLevel.BestSpeed"/>. You may have to perform
some tests to determine the best approach for your situation.
</para>
<para>
The default value for this property is -1, which means parallel
compression will not be performed unless you set it to zero.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.ParallelDeflateMaxBufferPairs">
<summary>
The maximum number of buffer pairs to use when performing
parallel compression.
</summary>
<remarks>
<para>
This property sets an upper limit on the number of memory
buffer pairs to create when performing parallel
compression. The implementation of the parallel
compression stream allocates multiple buffers to
facilitate parallel compression. As each buffer fills up,
the stream uses <see cref="M:System.Threading.ThreadPool.QueueUserWorkItem(System.Threading.WaitCallback)">
ThreadPool.QueueUserWorkItem()</see> to compress those
buffers in a background threadpool thread. After a buffer
is compressed, it is re-ordered and written to the output
stream.
</para>
<para>
A higher number of buffer pairs enables a higher degree of
parallelism, which tends to increase the speed of compression on
multi-cpu computers. On the other hand, a higher number of buffer
pairs also implies a larger memory consumption, more active worker
threads, and a higher cpu utilization for any compression. This
property enables the application to limit its memory consumption and
CPU utilization behavior depending on requirements.
</para>
<para>
For each compression "task" that occurs in parallel, there are 2
buffers allocated: one for input and one for output. This property
sets a limit for the number of pairs. The total amount of storage
space allocated for buffering will then be (N*S*2), where N is the
number of buffer pairs, S is the size of each buffer (<see cref="P:Ionic.Zip.ZipOutputStream.CodecBufferSize"/>). By default, DotNetZip allocates 4 buffer
pairs per CPU core, so if your machine has 4 cores, and you retain
the default buffer size of 128k, then the
ParallelDeflateOutputStream will use 4 * 4 * 2 * 128kb of buffer
memory in total, or 4mb, in blocks of 128kb. If you then set this
property to 8, then the number will be 8 * 2 * 128kb of buffer
memory, or 2mb.
</para>
<para>
CPU utilization will also go up with additional buffers, because a
larger number of buffer pairs allows a larger number of background
threads to compress in parallel. If you find that parallel
compression is consuming too much memory or CPU, you can adjust this
value downward.
</para>
<para>
The default value is 16. Different values may deliver better or
worse results, depending on your priorities and the dynamic
performance characteristics of your storage and compute resources.
</para>
<para>
This property is not the number of buffer pairs to use; it is an
upper limit. An illustration: Suppose you have an application that
uses the default value of this property (which is 16), and it runs
on a machine with 2 CPU cores. In that case, DotNetZip will allocate
4 buffer pairs per CPU core, for a total of 8 pairs. The upper
limit specified by this property has no effect.
</para>
<para>
The application can set this value at any time, but it is
effective only if set before calling
<c>ZipOutputStream.Write()</c> for the first time.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipOutputStream.ParallelDeflateThreshold"/>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.CanRead">
<summary>
Always returns false.
</summary>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.CanSeek">
<summary>
Always returns false.
</summary>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.CanWrite">
<summary>
Always returns true.
</summary>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.Length">
<summary>
Always returns a NotSupportedException.
</summary>
</member>
<member name="P:Ionic.Zip.ZipOutputStream.Position">
<summary>
Setting this property always returns a NotSupportedException. Getting it
returns the value of the Position on the underlying stream.
</summary>
</member>
<member name="T:Ionic.Zip.ZipInputStream">
<summary>
Provides a stream metaphor for reading zip files.
</summary>
<remarks>
<para>
This class provides an alternative programming model for reading zip files to
the one enabled by the <see cref="T:Ionic.Zip.ZipFile"/> class. Use this when reading zip
files, as an alternative to the <see cref="T:Ionic.Zip.ZipFile"/> class, when you would
like to use a Stream class to read the file.
</para>
<para>
Some application designs require a readable stream for input. This stream can
be used to read a zip file, and extract entries.
</para>
<para>
Both the <c>ZipInputStream</c> class and the <c>ZipFile</c> class can be used
to read and extract zip files. Both of them support many of the common zip
features, including Unicode, different compression levels, and ZIP64. The
programming models differ. For example, when extracting entries via calls to
the <c>GetNextEntry()</c> and <c>Read()</c> methods on the
<c>ZipInputStream</c> class, the caller is responsible for creating the file,
writing the bytes into the file, setting the attributes on the file, and
setting the created, last modified, and last accessed timestamps on the
file. All of these things are done automatically by a call to <see cref="M:Ionic.Zip.ZipEntry.Extract">ZipEntry.Extract()</see>. For this reason, the
<c>ZipInputStream</c> is generally recommended for when your application wants
to extract the data, without storing that data into a file.
</para>
<para>
Aside from the obvious differences in programming model, there are some
differences in capability between the <c>ZipFile</c> class and the
<c>ZipInputStream</c> class.
</para>
<list type="bullet">
<item>
<c>ZipFile</c> can be used to create or update zip files, or read and
extract zip files. <c>ZipInputStream</c> can be used only to read and
extract zip files. If you want to use a stream to create zip files, check
out the <see cref="T:Ionic.Zip.ZipOutputStream"/>.
</item>
<item>
<c>ZipInputStream</c> cannot read segmented or spanned
zip files.
</item>
<item>
<c>ZipInputStream</c> will not read Zip file comments.
</item>
<item>
When reading larger files, <c>ZipInputStream</c> will always underperform
<c>ZipFile</c>. This is because the <c>ZipInputStream</c> does a full scan on the
zip file, while the <c>ZipFile</c> class reads the central directory of the
zip file.
</item>
</list>
</remarks>
</member>
<member name="M:Ionic.Zip.ZipInputStream.#ctor(System.IO.Stream)">
<summary>
Create a <c>ZipInputStream</c>, wrapping it around an existing stream.
</summary>
<remarks>
<para>
While the <see cref="T:Ionic.Zip.ZipFile"/> class is generally easier
to use, this class provides an alternative to those
applications that want to read from a zipfile directly,
using a <see cref="T:System.IO.Stream"/>.
</para>
<para>
Both the <c>ZipInputStream</c> class and the <c>ZipFile</c> class can be used
to read and extract zip files. Both of them support many of the common zip
features, including Unicode, different compression levels, and ZIP64. The
programming models differ. For example, when extracting entries via calls to
the <c>GetNextEntry()</c> and <c>Read()</c> methods on the
<c>ZipInputStream</c> class, the caller is responsible for creating the file,
writing the bytes into the file, setting the attributes on the file, and
setting the created, last modified, and last accessed timestamps on the
file. All of these things are done automatically by a call to <see cref="M:Ionic.Zip.ZipEntry.Extract">ZipEntry.Extract()</see>. For this reason, the
<c>ZipInputStream</c> is generally recommended for when your application wants
to extract the data, without storing that data into a file.
</para>
<para>
Aside from the obvious differences in programming model, there are some
differences in capability between the <c>ZipFile</c> class and the
<c>ZipInputStream</c> class.
</para>
<list type="bullet">
<item>
<c>ZipFile</c> can be used to create or update zip files, or read and extract
zip files. <c>ZipInputStream</c> can be used only to read and extract zip
files. If you want to use a stream to create zip files, check out the <see cref="T:Ionic.Zip.ZipOutputStream"/>.
</item>
<item>
<c>ZipInputStream</c> cannot read segmented or spanned
zip files.
</item>
<item>
<c>ZipInputStream</c> will not read Zip file comments.
</item>
<item>
When reading larger files, <c>ZipInputStream</c> will always underperform
<c>ZipFile</c>. This is because the <c>ZipInputStream</c> does a full scan on the
zip file, while the <c>ZipFile</c> class reads the central directory of the
zip file.
</item>
</list>
</remarks>
<param name="stream">
The stream to read. It must be readable. This stream will be closed at
the time the <c>ZipInputStream</c> is closed.
</param>
<example>
This example shows how to read a zip file, and extract entries, using the
<c>ZipInputStream</c> class.
<code lang="C#">
private void Unzip()
{
byte[] buffer= new byte[2048];
int n;
using (var raw = File.Open(inputFileName, FileMode.Open, FileAccess.Read))
{
using (var input= new ZipInputStream(raw))
{
ZipEntry e;
while (( e = input.GetNextEntry()) != null)
{
if (e.IsDirectory) continue;
string outputPath = Path.Combine(extractDir, e.FileName);
using (var output = File.Open(outputPath, FileMode.Create, FileAccess.ReadWrite))
{
while ((n= input.Read(buffer, 0, buffer.Length)) > 0)
{
output.Write(buffer,0,n);
}
}
}
}
}
}
</code>
<code lang="VB">
Private Sub UnZip()
Dim inputFileName As String = "MyArchive.zip"
Dim extractDir As String = "extract"
Dim buffer As Byte() = New Byte(2048) {}
Using raw As FileStream = File.Open(inputFileName, FileMode.Open, FileAccess.Read)
Using input As ZipInputStream = New ZipInputStream(raw)
Dim e As ZipEntry
Do While (Not e = input.GetNextEntry Is Nothing)
If Not e.IsDirectory Then
Using output As FileStream = File.Open(Path.Combine(extractDir, e.FileName), _
FileMode.Create, FileAccess.ReadWrite)
Dim n As Integer
Do While (n = input.Read(buffer, 0, buffer.Length) > 0)
output.Write(buffer, 0, n)
Loop
End Using
End If
Loop
End Using
End Using
End Sub
</code>
</example>
</member>
<member name="M:Ionic.Zip.ZipInputStream.#ctor(System.String)">
<summary>
Create a <c>ZipInputStream</c>, given the name of an existing zip file.
</summary>
<remarks>
<para>
This constructor opens a <c>FileStream</c> for the given zipfile, and
wraps a <c>ZipInputStream</c> around that. See the documentation for the
<see cref="M:Ionic.Zip.ZipInputStream.#ctor(System.IO.Stream)"/> constructor for full details.
</para>
<para>
While the <see cref="T:Ionic.Zip.ZipFile"/> class is generally easier
to use, this class provides an alternative to those
applications that want to read from a zipfile directly,
using a <see cref="T:System.IO.Stream"/>.
</para>
</remarks>
<param name="fileName">
The name of the filesystem file to read.
</param>
<example>
This example shows how to read a zip file, and extract entries, using the
<c>ZipInputStream</c> class.
<code lang="C#">
private void Unzip()
{
byte[] buffer= new byte[2048];
int n;
using (var input= new ZipInputStream(inputFileName))
{
ZipEntry e;
while (( e = input.GetNextEntry()) != null)
{
if (e.IsDirectory) continue;
string outputPath = Path.Combine(extractDir, e.FileName);
using (var output = File.Open(outputPath, FileMode.Create, FileAccess.ReadWrite))
{
while ((n= input.Read(buffer, 0, buffer.Length)) > 0)
{
output.Write(buffer,0,n);
}
}
}
}
}
</code>
<code lang="VB">
Private Sub UnZip()
Dim inputFileName As String = "MyArchive.zip"
Dim extractDir As String = "extract"
Dim buffer As Byte() = New Byte(2048) {}
Using input As ZipInputStream = New ZipInputStream(inputFileName)
Dim e As ZipEntry
Do While (Not e = input.GetNextEntry Is Nothing)
If Not e.IsDirectory Then
Using output As FileStream = File.Open(Path.Combine(extractDir, e.FileName), _
FileMode.Create, FileAccess.ReadWrite)
Dim n As Integer
Do While (n = input.Read(buffer, 0, buffer.Length) > 0)
output.Write(buffer, 0, n)
Loop
End Using
End If
Loop
End Using
End Sub
</code>
</example>
</member>
<member name="M:Ionic.Zip.ZipInputStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Create a <c>ZipInputStream</c>, explicitly specifying whether to
keep the underlying stream open.
</summary>
<remarks>
See the documentation for the <see cref="M:Ionic.Zip.ZipInputStream.#ctor(System.IO.Stream)">ZipInputStream(Stream)</see>
constructor for a discussion of the class, and an example of how to use the class.
</remarks>
<param name="stream">
The stream to read from. It must be readable.
</param>
<param name="leaveOpen">
true if the application would like the stream
to remain open after the <c>ZipInputStream</c> has been closed.
</param>
</member>
<member name="M:Ionic.Zip.ZipInputStream.ToString">
<summary>Provides a string representation of the instance.</summary>
<remarks>
<para>
This can be useful for debugging purposes.
</para>
</remarks>
<returns>a string representation of the instance.</returns>
</member>
<member name="M:Ionic.Zip.ZipInputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read the data from the stream into the buffer.
</summary>
<remarks>
<para>
The data for the zipentry will be decrypted and uncompressed, as
necessary, before being copied into the buffer.
</para>
<para>
You must set the <see cref="P:Ionic.Zip.ZipInputStream.Password"/> property before calling
<c>Read()</c> the first time for an encrypted entry. To determine if an
entry is encrypted and requires a password, check the <see cref="P:Ionic.Zip.ZipEntry.Encryption">ZipEntry.Encryption</see> property.
</para>
</remarks>
<param name="buffer">The buffer to hold the data read from the stream.</param>
<param name="offset">the offset within the buffer to copy the first byte read.</param>
<param name="count">the number of bytes to read.</param>
<returns>the number of bytes read, after decryption and decompression.</returns>
</member>
<member name="M:Ionic.Zip.ZipInputStream.GetNextEntry">
<summary>
Read the next entry from the zip file.
</summary>
<remarks>
<para>
Call this method just before calling <see cref="M:Ionic.Zip.ZipInputStream.Read(System.Byte[],System.Int32,System.Int32)"/>,
to position the pointer in the zip file to the next entry that can be
read. Subsequent calls to <c>Read()</c>, will decrypt and decompress the
data in the zip file, until <c>Read()</c> returns 0.
</para>
<para>
Each time you call <c>GetNextEntry()</c>, the pointer in the wrapped
stream is moved to the next entry in the zip file. If you call <see cref="M:Ionic.Zip.ZipInputStream.Seek(System.Int64,System.IO.SeekOrigin)"/>, and thus re-position the pointer within
the file, you will need to call <c>GetNextEntry()</c> again, to insure
that the file pointer is positioned at the beginning of a zip entry.
</para>
<para>
This method returns the <c>ZipEntry</c>. Using a stream approach, you will
read the raw bytes for an entry in a zip file via calls to <c>Read()</c>.
Alternatively, you can extract an entry into a file, or a stream, by
calling <see cref="M:Ionic.Zip.ZipEntry.Extract"/>, or one of its siblings.
</para>
</remarks>
<returns>
The <c>ZipEntry</c> read. Returns null (or Nothing in VB) if there are no more
entries in the zip file.
</returns>
</member>
<member name="M:Ionic.Zip.ZipInputStream.Dispose(System.Boolean)">
<summary>
Dispose the stream.
</summary>
<remarks>
<para>
This method disposes the ZipInputStream. It may also close the
underlying stream, depending on which constructor was used.
</para>
<para>
Typically the application will call <c>Dispose()</c> implicitly, via
a <c>using</c> statement in C#, or a <c>Using</c> statement in VB.
</para>
<para>
Application code won't call this code directly. This method may
be invoked in two distinct scenarios. If disposing == true, the
method has been called directly or indirectly by a user's code,
for example via the public Dispose() method. In this case, both
managed and unmanaged resources can be referenced and disposed.
If disposing == false, the method has been called by the runtime
from inside the object finalizer and this method should not
reference other objects; in that case only unmanaged resources
must be referenced or disposed.
</para>
</remarks>
<param name="disposing">
true if the Dispose method was invoked by user code.
</param>
</member>
<member name="M:Ionic.Zip.ZipInputStream.Flush">
<summary>
This is a no-op.
</summary>
</member>
<member name="M:Ionic.Zip.ZipInputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
This method always throws a NotSupportedException.
</summary>
<param name="buffer">ignored</param>
<param name="offset">ignored</param>
<param name="count">ignored</param>
</member>
<member name="M:Ionic.Zip.ZipInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
This method seeks in the underlying stream.
</summary>
<remarks>
<para>
Call this method if you want to seek around within the zip file for random access.
</para>
<para>
Applications can intermix calls to <c>Seek()</c> with calls to <see cref="M:Ionic.Zip.ZipInputStream.GetNextEntry"/>. After a call to <c>Seek()</c>,
<c>GetNextEntry()</c> will get the next <c>ZipEntry</c> that falls after
the current position in the input stream. You're on your own for finding
out just where to seek in the stream, to get to the various entries.
</para>
</remarks>
<param name="offset">the offset point to seek to</param>
<param name="origin">the reference point from which to seek</param>
<returns>The new position</returns>
</member>
<member name="M:Ionic.Zip.ZipInputStream.SetLength(System.Int64)">
<summary>
This method always throws a NotSupportedException.
</summary>
<param name="value">ignored</param>
</member>
<member name="P:Ionic.Zip.ZipInputStream.ProvisionalAlternateEncoding">
<summary>
The text encoding to use when reading entries into the zip archive, for
those entries whose filenames or comments cannot be encoded with the
default (IBM437) encoding.
</summary>
<remarks>
<para>
In <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">its
zip specification</see>, PKWare describes two options for encoding
filenames and comments: using IBM437 or UTF-8. But, some archiving tools
or libraries do not follow the specification, and instead encode
characters using the system default code page. For example, WinRAR when
run on a machine in Shanghai may encode filenames with the Big-5 Chinese
(950) code page. This behavior is contrary to the Zip specification, but
it occurs anyway.
</para>
<para>
When using DotNetZip to read zip archives that use something other than
UTF-8 or IBM437, set this property to specify the code page to use when
reading encoded filenames and comments for each <c>ZipEntry</c> in the zip
file.
</para>
<para>
This property is "provisional". When the entry in the zip archive is not
explicitly marked as using UTF-8, then IBM437 is used to decode filenames
and comments. If a loss of data would result from using IBM436 -
specifically when encoding and decoding is not reflexive - the codepage
specified here is used. It is possible, therefore, to have a given entry
with a <c>Comment</c> encoded in IBM437 and a <c>FileName</c> encoded with
the specified "provisional" codepage.
</para>
<para>
When a zip file uses an arbitrary, non-UTF8 code page for encoding, there
is no standard way for the reader application - whether DotNetZip, WinZip,
WinRar, or something else - to know which codepage has been used for the
entries. Readers of zip files are not able to inspect the zip file and
determine the codepage that was used for the entries contained within it.
It is left to the application or user to determine the necessary codepage
when reading zip files encoded this way. If you use an incorrect codepage
when reading a zipfile, you will get entries with filenames that are
incorrect, and the incorrect filenames may even contain characters that
are not legal for use within filenames in Windows. Extracting entries with
illegal characters in the filenames will lead to exceptions. It's too bad,
but this is just the way things are with code pages in zip files. Caveat
Emptor.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipInputStream.CodecBufferSize">
<summary>
Size of the work buffer to use for the ZLIB codec during decompression.
</summary>
<remarks>
Setting this affects the performance and memory efficiency of compression
and decompression. For larger files, setting this to a larger size may
improve performance, but the exact numbers vary depending on available
memory, and a bunch of other variables. I don't have good firm
recommendations on how to set it. You'll have to test it yourself. Or
just leave it alone and accept the default.
</remarks>
</member>
<member name="P:Ionic.Zip.ZipInputStream.Password">
<summary>
Sets the password to be used on the <c>ZipInputStream</c> instance.
</summary>
<remarks>
<para>
When reading a zip archive, this password is used to read and decrypt the
entries that are encrypted within the zip file. When entries within a zip
file use different passwords, set the appropriate password for the entry
before the first call to <c>Read()</c> for each entry.
</para>
<para>
When reading an entry that is not encrypted, the value of this property is
ignored.
</para>
</remarks>
<example>
This example uses the ZipInputStream to read and extract entries from a
zip file, using a potentially different password for each entry.
<code lang="C#">
byte[] buffer= new byte[2048];
int n;
using (var raw = File.Open(_inputFileName, FileMode.Open, FileAccess.Read ))
{
using (var input= new ZipInputStream(raw))
{
ZipEntry e;
while (( e = input.GetNextEntry()) != null)
{
input.Password = PasswordForEntry(e.FileName);
if (e.IsDirectory) continue;
string outputPath = Path.Combine(_extractDir, e.FileName);
using (var output = File.Open(outputPath, FileMode.Create, FileAccess.ReadWrite))
{
while ((n= input.Read(buffer,0,buffer.Length)) > 0)
{
output.Write(buffer,0,n);
}
}
}
}
}
</code>
</example>
</member>
<member name="P:Ionic.Zip.ZipInputStream.CanRead">
<summary>
Always returns true.
</summary>
</member>
<member name="P:Ionic.Zip.ZipInputStream.CanSeek">
<summary>
Returns the value of <c>CanSeek</c> for the underlying (wrapped) stream.
</summary>
</member>
<member name="P:Ionic.Zip.ZipInputStream.CanWrite">
<summary>
Always returns false.
</summary>
</member>
<member name="P:Ionic.Zip.ZipInputStream.Length">
<summary>
Returns the length of the underlying stream.
</summary>
</member>
<member name="P:Ionic.Zip.ZipInputStream.Position">
<summary>
Gets or sets the position of the underlying stream.
</summary>
<remarks>
Setting the position is equivalent to calling <c>Seek(value, SeekOrigin.Begin)</c>.
</remarks>
</member>
<member name="M:Ionic.Zip.ZipSegmentedStream.ForUpdate(System.String,System.UInt32)">
<summary>
Sort-of like a factory method, ForUpdate is used only when
the application needs to update the zip entry metadata for
a segmented zip file, when the starting segment is earlier
than the ending segment, for a particular entry.
</summary>
<remarks>
<para>
The update is always contiguous, never rolls over. As a
result, this method doesn't need to return a ZSS; it can
simply return a FileStream. That's why it's "sort of"
like a Factory method.
</para>
<para>
Caller must Close/Dispose the stream object returned by
this method.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.ZipSegmentedStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read from the stream
</summary>
<param name="buffer">the buffer to read</param>
<param name="offset">the offset at which to start</param>
<param name="count">the number of bytes to read</param>
<returns>the number of bytes actually read</returns>
</member>
<member name="M:Ionic.Zip.ZipSegmentedStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write to the stream.
</summary>
<param name="buffer">the buffer from which to write</param>
<param name="offset">the offset at which to start writing</param>
<param name="count">the number of bytes to write</param>
</member>
<member name="P:Ionic.Zip.ZipSegmentedStream.CurrentName">
<summary>
Name of the filesystem file corresponding to the current segment.
</summary>
<remarks>
<para>
The name is not always the name currently being used in the
filesystem. When rwMode is RwMode.Write, the filesystem file has a
temporary name until the stream is closed or until the next segment is
started.
</para>
</remarks>
</member>
<member name="T:Ionic.Zip.ComHelper">
<summary>
This class exposes a set of COM-accessible wrappers for static
methods available on the ZipFile class. You don't need this
class unless you are using DotNetZip from a COM environment.
</summary>
</member>
<member name="M:Ionic.Zip.ComHelper.IsZipFile(System.String)">
<summary>
A wrapper for <see cref="M:Ionic.Zip.ZipFile.IsZipFile(System.String)">ZipFile.IsZipFile(string)</see>
</summary>
<param name="filename">The filename to of the zip file to check.</param>
<returns>true if the file contains a valid zip file.</returns>
</member>
<member name="M:Ionic.Zip.ComHelper.IsZipFileWithExtract(System.String)">
<summary>
A wrapper for <see cref="M:Ionic.Zip.ZipFile.IsZipFile(System.String,System.Boolean)">ZipFile.IsZipFile(string, bool)</see>
</summary>
<remarks>
We cannot use "overloaded" Method names in COM interop.
So, here, we use a unique name.
</remarks>
<param name="filename">The filename to of the zip file to check.</param>
<returns>true if the file contains a valid zip file.</returns>
</member>
<member name="M:Ionic.Zip.ComHelper.CheckZip(System.String)">
<summary>
A wrapper for <see cref="M:Ionic.Zip.ZipFile.CheckZip(System.String)">ZipFile.CheckZip(string)</see>
</summary>
<param name="filename">The filename to of the zip file to check.</param>
<returns>true if the named zip file checks OK. Otherwise, false. </returns>
</member>
<member name="M:Ionic.Zip.ComHelper.CheckZipPassword(System.String,System.String)">
<summary>
A COM-friendly wrapper for the static method <see cref="M:Ionic.Zip.ZipFile.CheckZipPassword(System.String,System.String)"/>.
</summary>
<param name="filename">The filename to of the zip file to check.</param>
<param name="password">The password to check.</param>
<returns>true if the named zip file checks OK. Otherwise, false. </returns>
</member>
<member name="M:Ionic.Zip.ComHelper.FixZipDirectory(System.String)">
<summary>
A wrapper for <see cref="M:Ionic.Zip.ZipFile.FixZipDirectory(System.String)">ZipFile.FixZipDirectory(string)</see>
</summary>
<param name="filename">The filename to of the zip file to fix.</param>
</member>
<member name="M:Ionic.Zip.ComHelper.GetZipLibraryVersion">
<summary>
A wrapper for <see cref="P:Ionic.Zip.ZipFile.LibraryVersion">ZipFile.LibraryVersion</see>
</summary>
<returns>
the version number on the DotNetZip assembly, formatted as a string.
</returns>
</member>
<member name="T:Ionic.Zip.ZipErrorAction">
<summary>
An enum providing the options when an error occurs during opening or reading
of a file or directory that is being saved to a zip file.
</summary>
<remarks>
<para>
This enum describes the actions that the library can take when an error occurs
opening or reading a file, as it is being saved into a Zip archive.
</para>
<para>
In some cases an error will occur when DotNetZip tries to open a file to be
added to the zip archive. In other cases, an error might occur after the
file has been successfully opened, while DotNetZip is reading the file.
</para>
<para>
The first problem might occur when calling AddDirectory() on a directory
that contains a Clipper .dbf file; the file is locked by Clipper and
cannot be opened by another process. An example of the second problem is
the ERROR_LOCK_VIOLATION that results when a file is opened by another
process, but not locked, and a range lock has been taken on the file.
Microsoft Outlook takes range locks on .PST files.
</para>
</remarks>
</member>
<member name="F:Ionic.Zip.ZipErrorAction.Throw">
<summary>
Throw an exception when an error occurs while zipping. This is the default
behavior. (For COM clients, this is a 0 (zero).)
</summary>
</member>
<member name="F:Ionic.Zip.ZipErrorAction.Skip">
<summary>
When an error occurs during zipping, for example a file cannot be opened,
skip the file causing the error, and continue zipping. (For COM clients,
this is a 1.)
</summary>
</member>
<member name="F:Ionic.Zip.ZipErrorAction.Retry">
<summary>
When an error occurs during zipping, for example a file cannot be opened,
retry the operation that caused the error. Be careful with this option. If
the error is not temporary, the library will retry forever. (For COM
clients, this is a 2.)
</summary>
</member>
<member name="F:Ionic.Zip.ZipErrorAction.InvokeErrorEvent">
<summary>
When an error occurs, invoke the zipError event. The event type used is
<see cref="F:Ionic.Zip.ZipProgressEventType.Error_Saving"/>. A typical use of this option:
a GUI application may wish to pop up a dialog to allow the user to view the
error that occurred, and choose an appropriate action. After your
processing in the error event, if you want to skip the file, set <see cref="P:Ionic.Zip.ZipEntry.ZipErrorAction"/> on the
<c>ZipProgressEventArgs.CurrentEntry</c> to <c>Skip</c>. If you want the
exception to be thrown, set <c>ZipErrorAction</c> on the <c>CurrentEntry</c>
to <c>Throw</c>. If you want to cancel the zip, set
<c>ZipProgressEventArgs.Cancel</c> to true. Cancelling differs from using
Skip in that a cancel will not save any further entries, if there are any.
(For COM clients, the value of this enum is a 3.)
</summary>
</member>
<member name="T:Ionic.Zip.EncryptionAlgorithm">
<summary>
An enum that provides the various encryption algorithms supported by this
library.
</summary>
<remarks>
<para>
<c>PkzipWeak</c> implies the use of Zip 2.0 encryption, which is known to be
weak and subvertible.
</para>
<para>
A note on interoperability: Values of <c>PkzipWeak</c> and <c>None</c> are
specified in <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's zip
specification</see>, and are considered to be "standard". Zip archives
produced using these options will be interoperable with many other zip tools
and libraries, including Windows Explorer.
</para>
<para>
Values of <c>WinZipAes128</c> and <c>WinZipAes256</c> are not part of the Zip
specification, but rather imply the use of a vendor-specific extension from
WinZip. If you want to produce interoperable Zip archives, do not use these
values. For example, if you produce a zip archive using WinZipAes256, you
will be able to open it in Windows Explorer on Windows XP and Vista, but you
will not be able to extract entries; trying this will lead to an "unspecified
error". For this reason, some people have said that a zip archive that uses
WinZip's AES encryption is not actually a zip archive at all. A zip archive
produced this way will be readable with the WinZip tool (Version 11 and
beyond).
</para>
<para>
There are other third-party tools and libraries, both commercial and
otherwise, that support WinZip's AES encryption. These will be able to read
AES-encrypted zip archives produced by DotNetZip, and conversely applications
that use DotNetZip to read zip archives will be able to read AES-encrypted
archives produced by those tools or libraries. Consult the documentation for
those other tools and libraries to find out if WinZip's AES encryption is
supported.
</para>
<para>
In case you care: According to <see href="http://www.winzip.com/aes_info.htm">the WinZip specification</see>, the
actual AES key used is derived from the <see cref="P:Ionic.Zip.ZipEntry.Password"/> via an
algorithm that complies with <see href="http://www.ietf.org/rfc/rfc2898.txt">RFC 2898</see>, using an iteration
count of 1000. The algorithm is sometimes referred to as PBKDF2, which stands
for "Password Based Key Derivation Function #2".
</para>
<para>
A word about password strength and length: The AES encryption technology is
very good, but any system is only as secure as the weakest link. If you want
to secure your data, be sure to use a password that is hard to guess. To make
it harder to guess (increase its "entropy"), you should make it longer. If
you use normal characters from an ASCII keyboard, a password of length 20 will
be strong enough that it will be impossible to guess. For more information on
that, I'd encourage you to read <see href="http://www.redkestrel.co.uk/Articles/RandomPasswordStrength.html">this
article.</see>
</para>
<para>
The WinZip AES algorithms are not supported with the version of DotNetZip that
runs on the .NET Compact Framework. This is because .NET CF lacks the
HMACSHA1 class that is required for producing the archive.
</para>
</remarks>
</member>
<member name="F:Ionic.Zip.EncryptionAlgorithm.None">
<summary>
No encryption at all.
</summary>
</member>
<member name="F:Ionic.Zip.EncryptionAlgorithm.PkzipWeak">
<summary>
Traditional or Classic pkzip encryption.
</summary>
</member>
<member name="F:Ionic.Zip.EncryptionAlgorithm.WinZipAes128">
<summary>
WinZip AES encryption (128 key bits).
</summary>
</member>
<member name="F:Ionic.Zip.EncryptionAlgorithm.WinZipAes256">
<summary>
WinZip AES encryption (256 key bits).
</summary>
</member>
<member name="F:Ionic.Zip.EncryptionAlgorithm.Unsupported">
<summary>
An encryption algorithm that is not supported by DotNetZip.
</summary>
</member>
<member name="T:Ionic.Zip.ExtractExistingFileAction">
<summary>
An enum for the options when extracting an entry would overwrite an existing file.
</summary>
<remarks>
<para>
This enum describes the actions that the library can take when an
<c>Extract()</c> or <c>ExtractWithPassword()</c> method is called to extract an
entry to a filesystem, and the extraction would overwrite an existing filesystem
file.
</para>
</remarks>
</member>
<member name="F:Ionic.Zip.ExtractExistingFileAction.Throw">
<summary>
Throw an exception when extraction would overwrite an existing file. (For
COM clients, this is a 0 (zero).)
</summary>
</member>
<member name="F:Ionic.Zip.ExtractExistingFileAction.OverwriteSilently">
<summary>
When extraction would overwrite an existing file, overwrite the file silently.
The overwrite will happen even if the target file is marked as read-only.
(For COM clients, this is a 1.)
</summary>
</member>
<member name="F:Ionic.Zip.ExtractExistingFileAction.DoNotOverwrite">
<summary>
When extraction would overwrite an existing file, don't overwrite the file, silently.
(For COM clients, this is a 2.)
</summary>
</member>
<member name="F:Ionic.Zip.ExtractExistingFileAction.InvokeExtractProgressEvent">
<summary>
When extraction would overwrite an existing file, invoke the ExtractProgress
event, using an event type of <see cref="F:Ionic.Zip.ZipProgressEventType.Extracting_ExtractEntryWouldOverwrite"/>. In
this way, the application can decide, just-in-time, whether to overwrite the
file. For example, a GUI application may wish to pop up a dialog to allow
the user to choose. You may want to examine the <see cref="P:Ionic.Zip.ExtractProgressEventArgs.ExtractLocation"/> property before making
the decision. If, after your processing in the Extract progress event, you
want to NOT extract the file, set <see cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/>
on the <c>ZipProgressEventArgs.CurrentEntry</c> to <c>DoNotOverwrite</c>.
If you do want to extract the file, set <c>ZipEntry.ExtractExistingFile</c>
to <c>OverwriteSilently</c>. If you want to cancel the Extraction, set
<c>ZipProgressEventArgs.Cancel</c> to true. Cancelling differs from using
DoNotOverwrite in that a cancel will not extract any further entries, if
there are any. (For COM clients, the value of this enum is a 3.)
</summary>
</member>
<member name="T:Ionic.LogicalConjunction">
<summary>
Enumerates the options for a logical conjunction. This enum is intended for use
internally by the FileSelector class.
</summary>
</member>
<member name="T:Ionic.FileSelector">
<summary>
FileSelector encapsulates logic that selects files from a source - a zip file
or the filesystem - based on a set of criteria. This class is used internally
by the DotNetZip library, in particular for the AddSelectedFiles() methods.
This class can also be used independently of the zip capability in DotNetZip.
</summary>
<remarks>
<para>
The FileSelector class is used internally by the ZipFile class for selecting
files for inclusion into the ZipFile, when the <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String)"/> method, or one of
its overloads, is called. It's also used for the <see cref="M:Ionic.Zip.ZipFile.ExtractSelectedEntries(System.String)"/> methods. Typically, an
application that creates or manipulates Zip archives will not directly
interact with the FileSelector class.
</para>
<para>
Some applications may wish to use the FileSelector class directly, to
select files from disk volumes based on a set of criteria, without creating or
querying Zip archives. The file selection criteria include: a pattern to
match the filename; the last modified, created, or last accessed time of the
file; the size of the file; and the attributes of the file.
</para>
<para>
Consult the documentation for <see cref="P:Ionic.FileSelector.SelectionCriteria"/>
for more information on specifying the selection criteria.
</para>
</remarks>
</member>
<member name="M:Ionic.FileSelector.#ctor(System.String)">
<summary>
Constructor that allows the caller to specify file selection criteria.
</summary>
<remarks>
<para>
This constructor allows the caller to specify a set of criteria for
selection of files.
</para>
<para>
See <see cref="P:Ionic.FileSelector.SelectionCriteria"/> for a description of
the syntax of the selectionCriteria string.
</para>
<para>
By default the FileSelector will traverse NTFS Reparse Points. To
change this, use <see cref="M:Ionic.FileSelector.#ctor(System.String,System.Boolean)">FileSelector(String, bool)</see>.
</para>
</remarks>
<param name="selectionCriteria">The criteria for file selection.</param>
</member>
<member name="M:Ionic.FileSelector.#ctor(System.String,System.Boolean)">
<summary>
Constructor that allows the caller to specify file selection criteria.
</summary>
<remarks>
<para>
This constructor allows the caller to specify a set of criteria for
selection of files.
</para>
<para>
See <see cref="P:Ionic.FileSelector.SelectionCriteria"/> for a description of
the syntax of the selectionCriteria string.
</para>
</remarks>
<param name="selectionCriteria">The criteria for file selection.</param>
<param name="traverseDirectoryReparsePoints">
whether to traverse NTFS reparse points (junctions).
</param>
</member>
<member name="M:Ionic.FileSelector.ToString">
<summary>
Returns a string representation of the FileSelector object.
</summary>
<returns>The string representation of the boolean logic statement of the file
selection criteria for this instance. </returns>
</member>
<member name="M:Ionic.FileSelector.SelectFiles(System.String)">
<summary>
Returns the names of the files in the specified directory
that fit the selection criteria specified in the FileSelector.
</summary>
<remarks>
This is equivalent to calling <see cref="M:Ionic.FileSelector.SelectFiles(System.String,System.Boolean)"/>
with recurseDirectories = false.
</remarks>
<param name="directory">
The name of the directory over which to apply the FileSelector
criteria.
</param>
<returns>
A collection of strings containing fully-qualified pathnames of files
that match the criteria specified in the FileSelector instance.
</returns>
</member>
<member name="M:Ionic.FileSelector.SelectFiles(System.String,System.Boolean)">
<summary>
Returns the names of the files in the specified directory that fit the
selection criteria specified in the FileSelector, optionally recursing
through subdirectories.
</summary>
<remarks>
This method applies the file selection criteria contained in the
FileSelector to the files contained in the given directory, and
returns the names of files that conform to the criteria.
</remarks>
<param name="directory">
The name of the directory over which to apply the FileSelector
criteria.
</param>
<param name="recurseDirectories">
Whether to recurse through subdirectories when applying the file
selection criteria.
</param>
<returns>
A collection of strings containing fully-qualified pathnames of files
that match the criteria specified in the FileSelector instance.
</returns>
</member>
<member name="M:Ionic.FileSelector.SelectEntries(Ionic.Zip.ZipFile)">
<summary>
Retrieve the ZipEntry items in the ZipFile that conform to the specified criteria.
</summary>
<remarks>
<para>
This method applies the criteria set in the FileSelector instance (as described in
the <see cref="P:Ionic.FileSelector.SelectionCriteria"/>) to the specified ZipFile. Using this
method, for example, you can retrieve all entries from the given ZipFile that
have filenames ending in .txt.
</para>
<para>
Normally, applications would not call this method directly. This method is used
by the ZipFile class.
</para>
<para>
Using the appropriate SelectionCriteria, you can retrieve entries based on size,
time, and attributes. See <see cref="P:Ionic.FileSelector.SelectionCriteria"/> for a
description of the syntax of the SelectionCriteria string.
</para>
</remarks>
<param name="zip">The ZipFile from which to retrieve entries.</param>
<returns>a collection of ZipEntry objects that conform to the criteria.</returns>
</member>
<member name="M:Ionic.FileSelector.SelectEntries(Ionic.Zip.ZipFile,System.String)">
<summary>
Retrieve the ZipEntry items in the ZipFile that conform to the specified criteria.
</summary>
<remarks>
<para>
This method applies the criteria set in the FileSelector instance (as described in
the <see cref="P:Ionic.FileSelector.SelectionCriteria"/>) to the specified ZipFile. Using this
method, for example, you can retrieve all entries from the given ZipFile that
have filenames ending in .txt.
</para>
<para>
Normally, applications would not call this method directly. This method is used
by the ZipFile class.
</para>
<para>
This overload allows the selection of ZipEntry instances from the ZipFile to be restricted
to entries contained within a particular directory in the ZipFile.
</para>
<para>
Using the appropriate SelectionCriteria, you can retrieve entries based on size,
time, and attributes. See <see cref="P:Ionic.FileSelector.SelectionCriteria"/> for a
description of the syntax of the SelectionCriteria string.
</para>
</remarks>
<param name="zip">The ZipFile from which to retrieve entries.</param>
<param name="directoryPathInArchive">
the directory in the archive from which to select entries. If null, then
all directories in the archive are used.
</param>
<returns>a collection of ZipEntry objects that conform to the criteria.</returns>
</member>
<member name="P:Ionic.FileSelector.SelectionCriteria">
<summary>
The string specifying which files to include when retrieving.
</summary>
<remarks>
<para>
Specify the criteria in statements of 3 elements: a noun, an operator,
and a value. Consider the string "name != *.doc" . The noun is
"name". The operator is "!=", implying "Not Equal". The value is
"*.doc". That criterion, in English, says "all files with a name that
does not end in the .doc extension."
</para>
<para>
Supported nouns include "name" (or "filename") for the filename;
"atime", "mtime", and "ctime" for last access time, last modfied time,
and created time of the file, respectively; "attributes" (or "attrs")
for the file attributes; "size" (or "length") for the file length
(uncompressed); and "type" for the type of object, either a file or a
directory. The "attributes", "type", and "name" nouns all support =
and != as operators. The "size", "atime", "mtime", and "ctime" nouns
support = and !=, and >, >=, <, <= as well. The times are
taken to be expressed in local time.
</para>
<para>
Specify values for the file attributes as a string with one or more of
the characters H,R,S,A,I,L in any order, implying file attributes of
Hidden, ReadOnly, System, Archive, NotContextIndexed, and ReparsePoint
(symbolic link) respectively.
</para>
<para>
To specify a time, use YYYY-MM-DD-HH:mm:ss or YYYY/MM/DD-HH:mm:ss as
the format. If you omit the HH:mm:ss portion, it is assumed to be
00:00:00 (midnight).
</para>
<para>
The value for a size criterion is expressed in integer quantities of
bytes, kilobytes (use k or kb after the number), megabytes (m or mb),
or gigabytes (g or gb).
</para>
<para>
The value for a name is a pattern to match against the filename,
potentially including wildcards. The pattern follows CMD.exe glob
rules: * implies one or more of any character, while ? implies one
character. If the name pattern contains any slashes, it is matched to
the entire filename, including the path; otherwise, it is matched
against only the filename without the path. This means a pattern of
"*\*.*" matches all files one directory level deep, while a pattern of
"*.*" matches all files in all directories.
</para>
<para>
To specify a name pattern that includes spaces, use single quotes
around the pattern. A pattern of "'* *.*'" will match all files that
have spaces in the filename. The full criteria string for that would
be "name = '* *.*'" .
</para>
<para>
The value for a type criterion is either F (implying a file) or D
(implying a directory).
</para>
<para>
Some examples:
</para>
<list type="table">
<listheader>
<term>criteria</term>
<description>Files retrieved</description>
</listheader>
<item>
<term>name != *.xls </term>
<description>any file with an extension that is not .xls
</description>
</item>
<item>
<term>name = *.mp3 </term>
<description>any file with a .mp3 extension.
</description>
</item>
<item>
<term>*.mp3</term>
<description>(same as above) any file with a .mp3 extension.
</description>
</item>
<item>
<term>attributes = A </term>
<description>all files whose attributes include the Archive bit.
</description>
</item>
<item>
<term>attributes != H </term>
<description>all files whose attributes do not include the Hidden bit.
</description>
</item>
<item>
<term>mtime > 2009-01-01</term>
<description>all files with a last modified time after January 1st, 2009.
</description>
</item>
<item>
<term>ctime > 2009/01/01-03:00:00</term>
<description>all files with a created time after 3am (local time),
on January 1st, 2009.
</description>
</item>
<item>
<term>size > 2gb</term>
<description>all files whose uncompressed size is greater than 2gb.
</description>
</item>
<item>
<term>type = D</term>
<description>all directories in the filesystem. </description>
</item>
</list>
<para>
You can combine criteria with the conjunctions AND, OR, and XOR. Using
a string like "name = *.txt AND size >= 100k" for the
selectionCriteria retrieves entries whose names end in .txt, and whose
uncompressed size is greater than or equal to 100 kilobytes.
</para>
<para>
For more complex combinations of criteria, you can use parenthesis to
group clauses in the boolean logic. Absent parenthesis, the
precedence of the criterion atoms is determined by order of
appearance. Unlike the C# language, the AND conjunction does not take
precendence over the logical OR. This is important only in strings
that contain 3 or more criterion atoms. In other words, "name = *.txt
and size > 1000 or attributes = H" implies "((name = *.txt AND size
> 1000) OR attributes = H)" while "attributes = H OR name = *.txt
and size > 1000" evaluates to "((attributes = H OR name = *.txt)
AND size > 1000)". When in doubt, use parenthesis.
</para>
<para>
Using time properties requires some extra care. If you want to
retrieve all entries that were last updated on 2009 February 14,
specify "mtime >= 2009-02-14 AND mtime < 2009-02-15". Read this
to say: all files updated after 12:00am on February 14th, until
12:00am on February 15th. You can use the same bracketing approach to
specify any time period - a year, a month, a week, and so on.
</para>
<para>
The syntax allows one special case: if you provide a string with no
spaces, it is treated as a pattern to match for the filename.
Therefore a string like "*.xls" will be equivalent to specifying "name
= *.xls". This "shorthand" notation does not work with compound
criteria.
</para>
<para>
There is no logic in this class that insures that the inclusion
criteria are internally consistent. For example, it's possible to
specify criteria that says the file must have a size of less than 100
bytes, as well as a size that is greater than 1000 bytes. Obviously
no file will ever satisfy such criteria, but this class does not check
for or detect such inconsistencies.
</para>
</remarks>
<exception cref="T:System.Exception">
Thrown in the setter if the value has an invalid syntax.
</exception>
</member>
<member name="P:Ionic.FileSelector.TraverseReparsePoints">
<summary>
Indicates whether searches will traverse NTFS reparse points, like Junctions.
</summary>
</member>
<member name="T:Ionic.EnumUtil">
<summary>
Summary description for EnumUtil.
</summary>
</member>
<member name="M:Ionic.EnumUtil.GetDescription(System.Enum)">
<summary>
Returns the value of the DescriptionAttribute if the specified Enum
value has one. If not, returns the ToString() representation of the
Enum value.
</summary>
<param name="value">The Enum to get the description for</param>
<returns></returns>
</member>
<member name="M:Ionic.EnumUtil.Parse(System.Type,System.String)">
<summary>
Converts the string representation of the name or numeric value of one
or more enumerated constants to an equivalent enumerated object.
Note: use the DescriptionAttribute on enum values to enable this.
</summary>
<param name="enumType">The System.Type of the enumeration.</param>
<param name="stringRepresentation">
A string containing the name or value to convert.
</param>
<returns></returns>
</member>
<member name="M:Ionic.EnumUtil.Parse(System.Type,System.String,System.Boolean)">
<summary>
Converts the string representation of the name or numeric value of one
or more enumerated constants to an equivalent enumerated object. A
parameter specified whether the operation is case-sensitive. Note:
use the DescriptionAttribute on enum values to enable this.
</summary>
<param name="enumType">The System.Type of the enumeration.</param>
<param name="stringRepresentation">
A string containing the name or value to convert.
</param>
<param name="ignoreCase">
Whether the operation is case-sensitive or not.</param>
<returns></returns>
</member>
<member name="T:Ionic.Zip.WinZipAesCrypto">
<summary>
This is a helper class supporting WinZip AES encryption.
This class is intended for use only by the DotNetZip library.
</summary>
<remarks>
Most uses of the DotNetZip library will not involve direct calls into
the WinZipAesCrypto class. Instead, the WinZipAesCrypto class is
instantiated and used by the ZipEntry() class when WinZip AES
encryption or decryption on an entry is employed.
</remarks>
</member>
<member name="T:Ionic.Zip.WinZipAesCipherStream">
<summary>
A stream that encrypts as it writes, or decrypts as it reads. The
Crypto is AES in CTR (counter) mode, which is compatible with the AES
encryption employed by WinZip 12.0.
</summary>
<remarks>
<para>
The AES/CTR encryption protocol used by WinZip works like this:
- start with a counter, initialized to zero.
- to encrypt, take the data by 16-byte blocks. For each block:
- apply the transform to the counter
- increement the counter
- XOR the result of the transform with the plaintext to
get the ciphertext.
- compute the mac on the encrypted bytes
- when finished with all blocks, store the computed MAC.
- to decrypt, take the data by 16-byte blocks. For each block:
- compute the mac on the encrypted bytes,
- apply the transform to the counter
- increement the counter
- XOR the result of the transform with the ciphertext to
get the plaintext.
- when finished with all blocks, compare the computed MAC against
the stored MAC
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.WinZipAesCipherStream.#ctor(System.IO.Stream,Ionic.Zip.WinZipAesCrypto,System.Int64,Ionic.Zip.CryptoMode)">
<summary>
The constructor.
</summary>
<param name="s">The underlying stream</param>
<param name="mode">To either encrypt or decrypt.</param>
<param name="cryptoParams">The pre-initialized WinZipAesCrypto object.</param>
<param name="length">The maximum number of bytes to read from the stream.</param>
</member>
<member name="M:Ionic.Zip.WinZipAesCipherStream.Close">
<summary>
Close the stream.
</summary>
</member>
<member name="M:Ionic.Zip.WinZipAesCipherStream.Flush">
<summary>
Flush the content in the stream.
</summary>
</member>
<member name="M:Ionic.Zip.WinZipAesCipherStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
This method throws a NotImplementedException.
</summary>
</member>
<member name="M:Ionic.Zip.WinZipAesCipherStream.SetLength(System.Int64)">
<summary>
This method throws a NotImplementedException.
</summary>
</member>
<member name="P:Ionic.Zip.WinZipAesCipherStream.FinalAuthentication">
<summary>
Returns the final HMAC-SHA1-80 for the data that was encrypted.
</summary>
</member>
<member name="P:Ionic.Zip.WinZipAesCipherStream.CanRead">
<summary>
Returns true if the stream can be read.
</summary>
</member>
<member name="P:Ionic.Zip.WinZipAesCipherStream.CanSeek">
<summary>
Always returns false.
</summary>
</member>
<member name="P:Ionic.Zip.WinZipAesCipherStream.CanWrite">
<summary>
Returns true if the CryptoMode is Encrypt.
</summary>
</member>
<member name="P:Ionic.Zip.WinZipAesCipherStream.Length">
<summary>
Getting this property throws a NotImplementedException.
</summary>
</member>
<member name="P:Ionic.Zip.WinZipAesCipherStream.Position">
<summary>
Getting or Setting this property throws a NotImplementedException.
</summary>
</member>
<member name="T:Ionic.Zip.BadPasswordException">
<summary>
Issued when an <c>ZipEntry.ExtractWithPassword()</c> method is invoked
with an incorrect password.
</summary>
</member>
<member name="T:Ionic.Zip.ZipException">
<summary>
Base class for all exceptions defined by and throw by the Zip library.
</summary>
</member>
<member name="M:Ionic.Zip.ZipException.#ctor">
<summary>
Default ctor.
</summary>
</member>
<member name="M:Ionic.Zip.ZipException.#ctor(System.String)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
</member>
<member name="M:Ionic.Zip.ZipException.#ctor(System.String,System.Exception)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
<param name="innerException">The innerException for this exception.</param>
</member>
<member name="M:Ionic.Zip.ZipException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="info">The serialization info for the exception.</param>
<param name="context">The streaming context from which to deserialize.</param>
</member>
<member name="M:Ionic.Zip.BadPasswordException.#ctor">
<summary>
Default ctor.
</summary>
</member>
<member name="M:Ionic.Zip.BadPasswordException.#ctor(System.String)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
</member>
<member name="M:Ionic.Zip.BadPasswordException.#ctor(System.String,System.Exception)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
<param name="innerException">The innerException for this exception.</param>
</member>
<member name="M:Ionic.Zip.BadPasswordException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="info">The serialization info for the exception.</param>
<param name="context">The streaming context from which to deserialize.</param>
</member>
<member name="T:Ionic.Zip.BadReadException">
<summary>
Indicates that a read was attempted on a stream, and bad or incomplete data was
received.
</summary>
</member>
<member name="M:Ionic.Zip.BadReadException.#ctor">
<summary>
Default ctor.
</summary>
</member>
<member name="M:Ionic.Zip.BadReadException.#ctor(System.String)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
</member>
<member name="M:Ionic.Zip.BadReadException.#ctor(System.String,System.Exception)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
<param name="innerException">The innerException for this exception.</param>
</member>
<member name="M:Ionic.Zip.BadReadException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="info">The serialization info for the exception.</param>
<param name="context">The streaming context from which to deserialize.</param>
</member>
<member name="T:Ionic.Zip.BadCrcException">
<summary>
Issued when an CRC check fails upon extracting an entry from a zip archive.
</summary>
</member>
<member name="M:Ionic.Zip.BadCrcException.#ctor">
<summary>
Default ctor.
</summary>
</member>
<member name="M:Ionic.Zip.BadCrcException.#ctor(System.String)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
</member>
<member name="M:Ionic.Zip.BadCrcException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="info">The serialization info for the exception.</param>
<param name="context">The streaming context from which to deserialize.</param>
</member>
<member name="T:Ionic.Zip.SfxGenerationException">
<summary>
Issued when errors occur saving a self-extracting archive.
</summary>
</member>
<member name="M:Ionic.Zip.SfxGenerationException.#ctor">
<summary>
Default ctor.
</summary>
</member>
<member name="M:Ionic.Zip.SfxGenerationException.#ctor(System.String)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
</member>
<member name="M:Ionic.Zip.SfxGenerationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="info">The serialization info for the exception.</param>
<param name="context">The streaming context from which to deserialize.</param>
</member>
<member name="T:Ionic.Zip.BadStateException">
<summary>
Indicates that an operation was attempted on a ZipFile which was not possible
given the state of the instance. For example, if you call <c>Save()</c> on a ZipFile
which has no filename set, you can get this exception.
</summary>
</member>
<member name="M:Ionic.Zip.BadStateException.#ctor">
<summary>
Default ctor.
</summary>
</member>
<member name="M:Ionic.Zip.BadStateException.#ctor(System.String)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
</member>
<member name="M:Ionic.Zip.BadStateException.#ctor(System.String,System.Exception)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="message">The message in the exception.</param>
<param name="innerException">The innerException for this exception.</param>
</member>
<member name="M:Ionic.Zip.BadStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Come on, you know how exceptions work. Why are you looking at this documentation?
</summary>
<param name="info">The serialization info for the exception.</param>
<param name="context">The streaming context from which to deserialize.</param>
</member>
<member name="T:Ionic.Zip.SharedUtilities">
<summary>
Collects general purpose utility methods.
</summary>
</member>
<member name="M:Ionic.Zip.SharedUtilities.GetFileLength(System.String)">
private null constructor
</member>
<member name="M:Ionic.Zip.SharedUtilities.NormalizePathForUseInZipFile(System.String)">
<summary>
Utility routine for transforming path names from filesystem format (on Windows that means backslashes) to
a format suitable for use within zipfiles. This means trimming the volume letter and colon (if any) And
swapping backslashes for forward slashes.
</summary>
<param name="pathName">source path.</param>
<returns>transformed path</returns>
</member>
<member name="M:Ionic.Zip.SharedUtilities.FindSignature(System.IO.Stream,System.Int32)">
<summary>
Finds a signature in the zip stream. This is useful for finding
the end of a zip entry, for example, or the beginning of the next ZipEntry.
</summary>
<remarks>
<para>
Scans through 64k at a time.
</para>
<para>
If the method fails to find the requested signature, the stream Position
after completion of this method is unchanged. If the method succeeds in
finding the requested signature, the stream position after completion is
direct AFTER the signature found in the stream.
</para>
</remarks>
<param name="stream">The stream to search</param>
<param name="SignatureToFind">The 4-byte signature to find</param>
<returns>The number of bytes read</returns>
</member>
<member name="M:Ionic.Zip.SharedUtilities.CreateAndOpenUniqueTempFile(System.String,System.IO.Stream@,System.String@)">
<summary>
Create a pseudo-random filename, suitable for use as a temporary
file, and open it.
</summary>
<remarks>
<para>
The System.IO.Path.GetRandomFileName() method is not available on
the Compact Framework, so this library provides its own substitute
on NETCF.
</para>
<para>
This method produces a filename of the form
DotNetZip-xxxxxxxx.tmp, where xxxxxxxx is replaced by randomly
chosen characters, and creates that file.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.SharedUtilities.ReadWithRetry(System.IO.Stream,System.Byte[],System.Int32,System.Int32,System.String)">
<summary>
Workitem 7889: handle ERROR_LOCK_VIOLATION during read
</summary>
<remarks>
This could be gracefully handled with an extension attribute, but
This assembly is built for .NET 2.0, so I cannot use them.
</remarks>
</member>
<member name="T:Ionic.Zip.CountingStream">
<summary>
A decorator stream. It wraps another stream, and performs bookkeeping
to keep track of the stream Position.
</summary>
<remarks>
<para>
In some cases, it is not possible to get the Position of a stream, let's
say, on a write-only output stream like ASP.NET's
<c>Response.OutputStream</c>, or on a different write-only stream
provided as the destination for the zip by the application. In this
case, programmers can use this counting stream to count the bytes read
or written.
</para>
<para>
Consider the scenario of an application that saves a self-extracting
archive (SFX), that uses a custom SFX stub.
</para>
<para>
Saving to a filesystem file, the application would open the
filesystem file (getting a <c>FileStream</c>), save the custom sfx stub
into it, and then call <c>ZipFile.Save()</c>, specifying the same
FileStream. <c>ZipFile.Save()</c> does the right thing for the zipentry
offsets, by inquiring the Position of the <c>FileStream</c> before writing
any data, and then adding that initial offset into any ZipEntry
offsets in the zip directory. Everything works fine.
</para>
<para>
Now suppose the application is an ASPNET application and it saves
directly to <c>Response.OutputStream</c>. It's not possible for DotNetZip to
inquire the <c>Position</c>, so the offsets for the SFX will be wrong.
</para>
<para>
The workaround is for the application to use this class to wrap
<c>HttpResponse.OutputStream</c>, then write the SFX stub and the ZipFile
into that wrapper stream. Because <c>ZipFile.Save()</c> can inquire the
<c>Position</c>, it will then do the right thing with the offsets.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.CountingStream.#ctor(System.IO.Stream)">
<summary>
The constructor.
</summary>
<param name="stream">The underlying stream</param>
</member>
<member name="M:Ionic.Zip.CountingStream.Adjust(System.Int64)">
<summary>
Adjust the byte count on the stream.
</summary>
<param name='delta'>
the number of bytes to subtract from the count.
</param>
<remarks>
<para>
Subtract delta from the count of bytes written to the stream.
This is necessary when seeking back, and writing additional data,
as happens in some cases when saving Zip files.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.CountingStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
The read method.
</summary>
<param name="buffer">The buffer to hold the data read from the stream.</param>
<param name="offset">the offset within the buffer to copy the first byte read.</param>
<param name="count">the number of bytes to read.</param>
<returns>the number of bytes read, after decryption and decompression.</returns>
</member>
<member name="M:Ionic.Zip.CountingStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write data into the stream.
</summary>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="M:Ionic.Zip.CountingStream.Flush">
<summary>
Flushes the underlying stream.
</summary>
</member>
<member name="M:Ionic.Zip.CountingStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Seek in the stream.
</summary>
<param name="offset">the offset point to seek to</param>
<param name="origin">the reference point from which to seek</param>
<returns>The new position</returns>
</member>
<member name="M:Ionic.Zip.CountingStream.SetLength(System.Int64)">
<summary>
Set the length of the underlying stream. Be careful with this!
</summary>
<param name='value'>the length to set on the underlying stream.</param>
</member>
<member name="P:Ionic.Zip.CountingStream.WrappedStream">
<summary>
Gets the wrapped stream.
</summary>
</member>
<member name="P:Ionic.Zip.CountingStream.BytesWritten">
<summary>
The count of bytes written out to the stream.
</summary>
</member>
<member name="P:Ionic.Zip.CountingStream.BytesRead">
<summary>
the count of bytes that have been read from the stream.
</summary>
</member>
<member name="P:Ionic.Zip.CountingStream.CanRead">
<summary>
Whether the stream can be read.
</summary>
</member>
<member name="P:Ionic.Zip.CountingStream.CanSeek">
<summary>
Whether it is possible to call Seek() on the stream.
</summary>
</member>
<member name="P:Ionic.Zip.CountingStream.CanWrite">
<summary>
Whether it is possible to call Write() on the stream.
</summary>
</member>
<member name="P:Ionic.Zip.CountingStream.Length">
<summary>
The length of the underlying stream.
</summary>
</member>
<member name="P:Ionic.Zip.CountingStream.ComputedPosition">
<summary>
Returns the sum of number of bytes written, plus the initial
offset before writing.
</summary>
</member>
<member name="P:Ionic.Zip.CountingStream.Position">
<summary>
The Position of the stream.
</summary>
</member>
<member name="T:Ionic.Zip.ZipCrypto">
<summary>
This class implements the "traditional" or "classic" PKZip encryption,
which today is considered to be weak. On the other hand it is
ubiquitous. This class is intended for use only by the DotNetZip
library.
</summary>
<remarks>
Most uses of the DotNetZip library will not involve direct calls into
the ZipCrypto class. Instead, the ZipCrypto class is instantiated and
used by the ZipEntry() class when encryption or decryption on an entry
is employed. If for some reason you really wanted to use a weak
encryption algorithm in some other application, you might use this
library. But you would be much better off using one of the built-in
strong encryption libraries in the .NET Framework, like the AES
algorithm or SHA.
</remarks>
</member>
<member name="M:Ionic.Zip.ZipCrypto.#ctor">
<summary>
The default constructor for ZipCrypto.
</summary>
<remarks>
This class is intended for internal use by the library only. It's
probably not useful to you. Seriously. Stop reading this
documentation. It's a waste of your time. Go do something else.
Check the football scores. Go get an ice cream with a friend.
Seriously.
</remarks>
</member>
<member name="M:Ionic.Zip.ZipCrypto.DecryptMessage(System.Byte[],System.Int32)">
<summary>
Call this method on a cipher text to render the plaintext. You must
first initialize the cipher with a call to InitCipher.
</summary>
<example>
<code>
var cipher = new ZipCrypto();
cipher.InitCipher(Password);
// Decrypt the header. This has a side effect of "further initializing the
// encryption keys" in the traditional zip encryption.
byte[] DecryptedMessage = cipher.DecryptMessage(EncryptedMessage);
</code>
</example>
<param name="cipherText">The encrypted buffer.</param>
<param name="length">
The number of bytes to encrypt.
Should be less than or equal to CipherText.Length.
</param>
<returns>The plaintext.</returns>
</member>
<member name="M:Ionic.Zip.ZipCrypto.EncryptMessage(System.Byte[],System.Int32)">
<summary>
This is the converse of DecryptMessage. It encrypts the plaintext
and produces a ciphertext.
</summary>
<param name="plainText">The plain text buffer.</param>
<param name="length">
The number of bytes to encrypt.
Should be less than or equal to plainText.Length.
</param>
<returns>The ciphertext.</returns>
</member>
<member name="M:Ionic.Zip.ZipCrypto.InitCipher(System.String)">
<summary>
This initializes the cipher with the given password.
See AppNote.txt for details.
</summary>
<param name="passphrase">
The passphrase for encrypting or decrypting with this cipher.
</param>
<remarks>
<code>
Step 1 - Initializing the encryption keys
-----------------------------------------
Start with these keys:
Key(0) := 305419896 (0x12345678)
Key(1) := 591751049 (0x23456789)
Key(2) := 878082192 (0x34567890)
Then, initialize the keys with a password:
loop for i from 0 to length(password)-1
update_keys(password(i))
end loop
Where update_keys() is defined as:
update_keys(char):
Key(0) := crc32(key(0),char)
Key(1) := Key(1) + (Key(0) bitwiseAND 000000ffH)
Key(1) := Key(1) * 134775813 + 1
Key(2) := crc32(key(2),key(1) rightshift 24)
end update_keys
Where crc32(old_crc,char) is a routine that given a CRC value and a
character, returns an updated CRC value after applying the CRC-32
algorithm described elsewhere in this document.
</code>
<para>
After the keys are initialized, then you can use the cipher to
encrypt the plaintext.
</para>
<para>
Essentially we encrypt the password with the keys, then discard the
ciphertext for the password. This initializes the keys for later use.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipCrypto.MagicByte">
<summary>
From AppNote.txt:
unsigned char decrypt_byte()
local unsigned short temp
temp :=- Key(2) | 2
decrypt_byte := (temp * (temp ^ 1)) bitshift-right 8
end decrypt_byte
</summary>
</member>
<member name="T:Ionic.Zip.ZipCipherStream">
<summary>
A Stream for reading and concurrently decrypting data from a zip file,
or for writing and concurrently encrypting data to a zip file.
</summary>
</member>
<member name="M:Ionic.Zip.ZipCipherStream.#ctor(System.IO.Stream,Ionic.Zip.ZipCrypto,Ionic.Zip.CryptoMode)">
<summary> The constructor. </summary>
<param name="s">The underlying stream</param>
<param name="mode">To either encrypt or decrypt.</param>
<param name="cipher">The pre-initialized ZipCrypto object.</param>
</member>
<member name="T:Ionic.Zip.WriteDelegate">
<summary>
Delegate in which the application writes the <c>ZipEntry</c> content for the named entry.
</summary>
<param name="entryName">The name of the entry that must be written.</param>
<param name="stream">The stream to which the entry data should be written.</param>
<remarks>
When you add an entry and specify a <c>WriteDelegate</c>, via <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.WriteDelegate)"/>, the application
code provides the logic that writes the entry data directly into the zip file.
</remarks>
<example>
This example shows how to define a WriteDelegate that obtains a DataSet, and then
writes the XML for the DataSet into the zip archive. There's no need to
save the XML to a disk file first.
<code lang="C#">
private void WriteEntry (String filename, Stream output)
{
DataSet ds1 = ObtainDataSet();
ds1.WriteXml(output);
}
private void Run()
{
using (var zip = new ZipFile())
{
zip.AddEntry(zipEntryName, WriteEntry);
zip.Save(zipFileName);
}
}
</code>
<code lang="vb">
Private Sub WriteEntry (ByVal filename As String, ByVal output As Stream)
DataSet ds1 = ObtainDataSet()
ds1.WriteXml(stream)
End Sub
Public Sub Run()
Using zip = New ZipFile
zip.AddEntry(zipEntryName, New WriteDelegate(AddressOf WriteEntry))
zip.Save(zipFileName)
End Using
End Sub
</code>
</example>
<seealso cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.WriteDelegate)"/>
</member>
<member name="T:Ionic.Zip.OpenDelegate">
<summary>
Delegate in which the application opens the stream, just-in-time, for the named entry.
</summary>
<param name="entryName">
The name of the ZipEntry that the application should open the stream for.
</param>
<remarks>
When you add an entry via <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)"/>, the application code provides the logic that
opens and closes the stream for the given ZipEntry.
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)"/>
</member>
<member name="T:Ionic.Zip.CloseDelegate">
<summary>
Delegate in which the application closes the stream, just-in-time, for the named entry.
</summary>
<param name="entryName">
The name of the ZipEntry that the application should close the stream for.
</param>
<param name="stream">The stream to be closed.</param>
<remarks>
When you add an entry via <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)"/>, the application code provides the logic that
opens and closes the stream for the given ZipEntry.
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)"/>
</member>
<member name="T:Ionic.Zip.SetCompressionCallback">
<summary>
Delegate for the callback by which the application tells the
library the CompressionLevel to use for a file.
</summary>
<remarks>
<para>
Using this callback, the application can, for example, specify that
previously-compressed files (.mp3, .png, .docx, etc) should use a
<c>CompressionLevel</c> of <c>None</c>, or can set the compression level based
on any other factor.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.SetCompression"/>
</member>
<member name="T:Ionic.Zip.ZipProgressEventType">
<summary>
In an EventArgs type, indicates which sort of progress event is being
reported.
</summary>
<remarks>
There are events for reading, events for saving, and events for
extracting. This enumeration allows a single EventArgs type to be sued to
describe one of multiple subevents. For example, a SaveProgress event is
invoked before, after, and during the saving of a single entry. The value
of an enum with this type, specifies which event is being triggered. The
same applies to Extraction, Reading and Adding events.
</remarks>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Adding_Started">
<summary>
Indicates that a Add() operation has started.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Adding_AfterAddEntry">
<summary>
Indicates that an individual entry in the archive has been added.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Adding_Completed">
<summary>
Indicates that a Add() operation has completed.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Reading_Started">
<summary>
Indicates that a Read() operation has started.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Reading_BeforeReadEntry">
<summary>
Indicates that an individual entry in the archive is about to be read.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Reading_AfterReadEntry">
<summary>
Indicates that an individual entry in the archive has just been read.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Reading_Completed">
<summary>
Indicates that a Read() operation has completed.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Reading_ArchiveBytesRead">
<summary>
The given event reports the number of bytes read so far
during a Read() operation.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Saving_Started">
<summary>
Indicates that a Save() operation has started.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Saving_BeforeWriteEntry">
<summary>
Indicates that an individual entry in the archive is about to be written.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Saving_AfterWriteEntry">
<summary>
Indicates that an individual entry in the archive has just been saved.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Saving_Completed">
<summary>
Indicates that a Save() operation has completed.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Saving_AfterSaveTempArchive">
<summary>
Indicates that the zip archive has been created in a
temporary location during a Save() operation.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Saving_BeforeRenameTempArchive">
<summary>
Indicates that the temporary file is about to be renamed to the final archive
name during a Save() operation.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Saving_AfterRenameTempArchive">
<summary>
Indicates that the temporary file is has just been renamed to the final archive
name during a Save() operation.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Saving_AfterCompileSelfExtractor">
<summary>
Indicates that the self-extracting archive has been compiled
during a Save() operation.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Saving_EntryBytesRead">
<summary>
The given event is reporting the number of source bytes that have run through the compressor so far
during a Save() operation.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Extracting_BeforeExtractEntry">
<summary>
Indicates that an entry is about to be extracted.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Extracting_AfterExtractEntry">
<summary>
Indicates that an entry has just been extracted.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Extracting_ExtractEntryWouldOverwrite">
<summary>
Indicates that extraction of an entry would overwrite an existing
filesystem file. You must use
<see cref="F:Ionic.Zip.ExtractExistingFileAction.InvokeExtractProgressEvent">
ExtractExistingFileAction.InvokeExtractProgressEvent</see> in the call
to <c>ZipEntry.Extract()</c> in order to receive this event.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Extracting_EntryBytesWritten">
<summary>
The given event is reporting the number of bytes written so far for
the current entry during an Extract() operation.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Extracting_BeforeExtractAll">
<summary>
Indicates that an ExtractAll operation is about to begin.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Extracting_AfterExtractAll">
<summary>
Indicates that an ExtractAll operation has completed.
</summary>
</member>
<member name="F:Ionic.Zip.ZipProgressEventType.Error_Saving">
<summary>
Indicates that an error has occurred while saving a zip file.
This generally means the file cannot be opened, because it has been
removed, or because it is locked by another process. It can also
mean that the file cannot be Read, because of a range lock conflict.
</summary>
</member>
<member name="T:Ionic.Zip.ZipProgressEventArgs">
<summary>
Provides information about the progress of a save, read, or extract operation.
This is a base class; you will probably use one of the classes derived from this one.
</summary>
</member>
<member name="P:Ionic.Zip.ZipProgressEventArgs.EntriesTotal">
<summary>
The total number of entries to be saved or extracted.
</summary>
</member>
<member name="P:Ionic.Zip.ZipProgressEventArgs.CurrentEntry">
<summary>
The name of the last entry saved or extracted.
</summary>
</member>
<member name="P:Ionic.Zip.ZipProgressEventArgs.Cancel">
<summary>
In an event handler, set this to cancel the save or extract
operation that is in progress.
</summary>
</member>
<member name="P:Ionic.Zip.ZipProgressEventArgs.EventType">
<summary>
The type of event being reported.
</summary>
</member>
<member name="P:Ionic.Zip.ZipProgressEventArgs.ArchiveName">
<summary>
Returns the archive name associated to this event.
</summary>
</member>
<member name="P:Ionic.Zip.ZipProgressEventArgs.BytesTransferred">
<summary>
The number of bytes read or written so far for this entry.
</summary>
</member>
<member name="P:Ionic.Zip.ZipProgressEventArgs.TotalBytesToTransfer">
<summary>
Total number of bytes that will be read or written for this entry.
This number will be -1 if the value cannot be determined.
</summary>
</member>
<member name="T:Ionic.Zip.ReadProgressEventArgs">
<summary>
Provides information about the progress of a Read operation.
</summary>
</member>
<member name="T:Ionic.Zip.AddProgressEventArgs">
<summary>
Provides information about the progress of a Add operation.
</summary>
</member>
<member name="T:Ionic.Zip.SaveProgressEventArgs">
<summary>
Provides information about the progress of a save operation.
</summary>
</member>
<member name="M:Ionic.Zip.SaveProgressEventArgs.#ctor(System.String,System.Boolean,System.Int32,System.Int32,Ionic.Zip.ZipEntry)">
<summary>
Constructor for the SaveProgressEventArgs.
</summary>
<param name="archiveName">the name of the zip archive.</param>
<param name="before">whether this is before saving the entry, or after</param>
<param name="entriesTotal">The total number of entries in the zip archive.</param>
<param name="entriesSaved">Number of entries that have been saved.</param>
<param name="entry">The entry involved in the event.</param>
</member>
<member name="P:Ionic.Zip.SaveProgressEventArgs.EntriesSaved">
<summary>
Number of entries saved so far.
</summary>
</member>
<member name="T:Ionic.Zip.ExtractProgressEventArgs">
<summary>
Provides information about the progress of the extract operation.
</summary>
</member>
<member name="M:Ionic.Zip.ExtractProgressEventArgs.#ctor(System.String,System.Boolean,System.Int32,System.Int32,Ionic.Zip.ZipEntry,System.String)">
<summary>
Constructor for the ExtractProgressEventArgs.
</summary>
<param name="archiveName">the name of the zip archive.</param>
<param name="before">whether this is before saving the entry, or after</param>
<param name="entriesTotal">The total number of entries in the zip archive.</param>
<param name="entriesExtracted">Number of entries that have been extracted.</param>
<param name="entry">The entry involved in the event.</param>
<param name="extractLocation">The location to which entries are extracted.</param>
</member>
<member name="P:Ionic.Zip.ExtractProgressEventArgs.EntriesExtracted">
<summary>
Number of entries extracted so far. This is set only if the
EventType is Extracting_BeforeExtractEntry or Extracting_AfterExtractEntry, and
the Extract() is occurring witin the scope of a call to ExtractAll().
</summary>
</member>
<member name="P:Ionic.Zip.ExtractProgressEventArgs.ExtractLocation">
<summary>
Returns the extraction target location, a filesystem path.
</summary>
</member>
<member name="T:Ionic.Zip.ZipErrorEventArgs">
<summary>
Provides information about the an error that occurred while zipping.
</summary>
</member>
<member name="P:Ionic.Zip.ZipErrorEventArgs.Exception">
<summary>
Returns the exception that occurred, if any.
</summary>
</member>
<member name="P:Ionic.Zip.ZipErrorEventArgs.FileName">
<summary>
Returns the name of the file that caused the exception, if any.
</summary>
</member>
<member name="T:Ionic.Zip.ZipEntry">
<summary>
Represents a single entry in a ZipFile. Typically, applications get a ZipEntry
by enumerating the entries within a ZipFile, or by adding an entry to a ZipFile.
</summary>
</member>
<member name="M:Ionic.Zip.ZipEntry.ReadDirEntry(Ionic.Zip.ZipFile,System.Collections.Generic.Dictionary{System.String,System.Object})">
<summary>
Reads one entry from the zip directory structure in the zip file.
</summary>
<param name="zf">
The zipfile for which a directory entry will be read. From this param, the
method gets the ReadStream and the expected text encoding
(ProvisionalAlternateEncoding) which is used if the entry is not marked
UTF-8.
</param>
<param name="previouslySeen">
a list of previously seen entry names; used to prevent duplicates.
</param>
<returns>the entry read from the archive.</returns>
</member>
<member name="M:Ionic.Zip.ZipEntry.IsNotValidZipDirEntrySig(System.Int32)">
<summary>
Returns true if the passed-in value is a valid signature for a ZipDirEntry.
</summary>
<param name="signature">the candidate 4-byte signature value.</param>
<returns>true, if the signature is valid according to the PKWare spec.</returns>
</member>
<member name="M:Ionic.Zip.ZipEntry.#ctor">
<summary>
Default constructor.
</summary>
<remarks>
Applications should never need to call this directly. It is exposed to
support COM Automation environments.
</remarks>
</member>
<member name="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)">
<summary>
Sets the NTFS Creation, Access, and Modified times for the given entry.
</summary>
<remarks>
<para>
When adding an entry from a file or directory, the Creation, Access, and
Modified times for the given entry are automatically set from the
filesystem values. When adding an entry from a stream or string, the
values are implicitly set to DateTime.Now. The application may wish to
set these values to some arbitrary value, before saving the archive, and
can do so using the various setters. If you want to set all of the times,
this method is more efficient.
</para>
<para>
The values you set here will be retrievable with the <see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>, <see cref="P:Ionic.Zip.ZipEntry.CreationTime"/> and <see cref="P:Ionic.Zip.ZipEntry.AccessedTime"/> properties.
</para>
<para>
When this method is called, if both <see cref="P:Ionic.Zip.ZipEntry.EmitTimesInWindowsFormatWhenSaving"/> and <see cref="P:Ionic.Zip.ZipEntry.EmitTimesInUnixFormatWhenSaving"/> are false, then the
<c>EmitTimesInWindowsFormatWhenSaving</c> flag is automatically set.
</para>
<para>
DateTime values provided here without a DateTimeKind are assumed to be Local Time.
</para>
</remarks>
<param name="created">the creation time of the entry.</param>
<param name="accessed">the last access time of the entry.</param>
<param name="modified">the last modified time of the entry.</param>
<seealso cref="P:Ionic.Zip.ZipEntry.EmitTimesInWindowsFormatWhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipEntry.EmitTimesInUnixFormatWhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.CreationTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>
</member>
<member name="M:Ionic.Zip.ZipEntry.ToString">
<summary>Provides a string representation of the instance.</summary>
<returns>a string representation of the instance.</returns>
</member>
<member name="M:Ionic.Zip.ZipEntry.Extract">
<summary>
Extract the entry to the filesystem, starting at the current
working directory.
</summary>
<overloads>
This method has a bunch of overloads! One of them is sure to
be the right one for you... If you don't like these, check
out the <c>ExtractWithPassword()</c> methods.
</overloads>
<seealso cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/>
<seealso cref="M:Ionic.Zip.ZipEntry.Extract(Ionic.Zip.ExtractExistingFileAction)"/>
<remarks>
<para>
This method extracts an entry from a zip file into the current
working directory. The path of the entry as extracted is the full
path as specified in the zip archive, relative to the current
working directory. After the file is extracted successfully, the
file attributes and timestamps are set.
</para>
<para>
The action taken when extraction an entry would overwrite an
existing file is determined by the <see cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/> property.
</para>
<para>
Within the call to <c>Extract()</c>, the content for the entry is
written into a filesystem file, and then the last modified time of the
file is set according to the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property on
the entry. See the remarks the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property for
some details about the last modified time.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.ZipEntry.Extract(Ionic.Zip.ExtractExistingFileAction)">
<summary>
Extract the entry to a file in the filesystem, using the specified
behavior when extraction would overwrite an existing file.
</summary>
<remarks>
<para>
See the remarks on the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property, for some
details about how the last modified time of the file is set after
extraction.
</para>
</remarks>
<param name="extractExistingFile">
The action to take if extraction would overwrite an existing file.
</param>
</member>
<member name="M:Ionic.Zip.ZipEntry.Extract(System.IO.Stream)">
<summary>
Extracts the entry to the specified stream.
</summary>
<remarks>
<para>
The caller can specify any write-able stream, for example a <see cref="T:System.IO.FileStream"/>, a <see cref="T:System.IO.MemoryStream"/>, or ASP.NET's
<c>Response.OutputStream</c>. The content will be decrypted and
decompressed as necessary. If the entry is encrypted and no password
is provided, this method will throw.
</para>
<para>
The position on the stream is not reset by this method before it extracts.
You may want to call stream.Seek() before calling ZipEntry.Extract().
</para>
</remarks>
<param name="stream">
the stream to which the entry should be extracted.
</param>
</member>
<member name="M:Ionic.Zip.ZipEntry.Extract(System.String)">
<summary>
Extract the entry to the filesystem, starting at the specified base
directory.
</summary>
<param name="baseDirectory">the pathname of the base directory</param>
<seealso cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/>
<seealso cref="M:Ionic.Zip.ZipEntry.Extract(System.String,Ionic.Zip.ExtractExistingFileAction)"/>
<example>
This example extracts only the entries in a zip file that are .txt files,
into a directory called "textfiles".
<code lang="C#">
using (ZipFile zip = ZipFile.Read("PackedDocuments.zip"))
{
foreach (string s1 in zip.EntryFilenames)
{
if (s1.EndsWith(".txt"))
{
zip[s1].Extract("textfiles");
}
}
}
</code>
<code lang="VB">
Using zip As ZipFile = ZipFile.Read("PackedDocuments.zip")
Dim s1 As String
For Each s1 In zip.EntryFilenames
If s1.EndsWith(".txt") Then
zip(s1).Extract("textfiles")
End If
Next
End Using
</code>
</example>
<remarks>
<para>
Using this method, existing entries in the filesystem will not be
overwritten. If you would like to force the overwrite of existing
files, see the <see cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/> property, or call
<see cref="M:Ionic.Zip.ZipEntry.Extract(System.String,Ionic.Zip.ExtractExistingFileAction)"/>.
</para>
<para>
See the remarks on the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property, for some
details about how the last modified time of the created file is set.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.ZipEntry.Extract(System.String,Ionic.Zip.ExtractExistingFileAction)">
<summary>
Extract the entry to the filesystem, starting at the specified base
directory, and using the specified behavior when extraction would
overwrite an existing file.
</summary>
<remarks>
<para>
See the remarks on the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property, for some
details about how the last modified time of the created file is set.
</para>
</remarks>
<example>
<code lang="C#">
String sZipPath = "Airborne.zip";
String sFilePath = "Readme.txt";
String sRootFolder = "Digado";
using (ZipFile zip = ZipFile.Read(sZipPath))
{
if (zip.EntryFileNames.Contains(sFilePath))
{
// use the string indexer on the zip file
zip[sFileName].Extract(sRootFolder,
ExtractExistingFileAction.OverwriteSilently);
}
}
</code>
<code lang="VB">
Dim sZipPath as String = "Airborne.zip"
Dim sFilePath As String = "Readme.txt"
Dim sRootFolder As String = "Digado"
Using zip As ZipFile = ZipFile.Read(sZipPath)
If zip.EntryFileNames.Contains(sFilePath)
' use the string indexer on the zip file
zip(sFilePath).Extract(sRootFolder, _
ExtractExistingFileAction.OverwriteSilently)
End If
End Using
</code>
</example>
<param name="baseDirectory">the pathname of the base directory</param>
<param name="extractExistingFile">
The action to take if extraction would overwrite an existing file.
</param>
</member>
<member name="M:Ionic.Zip.ZipEntry.ExtractWithPassword(System.String)">
<summary>
Extract the entry to the filesystem, using the current working directory
and the specified password.
</summary>
<overloads>
This method has a bunch of overloads! One of them is sure to be
the right one for you...
</overloads>
<seealso cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/>
<seealso cref="M:Ionic.Zip.ZipEntry.ExtractWithPassword(Ionic.Zip.ExtractExistingFileAction,System.String)"/>
<remarks>
<para>
Existing entries in the filesystem will not be overwritten. If you
would like to force the overwrite of existing files, see the <see cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/>property, or call
<see cref="M:Ionic.Zip.ZipEntry.ExtractWithPassword(Ionic.Zip.ExtractExistingFileAction,System.String)"/>.
</para>
<para>
See the remarks on the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property for some
details about how the "last modified" time of the created file is
set.
</para>
</remarks>
<example>
In this example, entries that use encryption are extracted using a
particular password.
<code>
using (var zip = ZipFile.Read(FilePath))
{
foreach (ZipEntry e in zip)
{
if (e.UsesEncryption)
e.ExtractWithPassword("Secret!");
else
e.Extract();
}
}
</code>
<code lang="VB">
Using zip As ZipFile = ZipFile.Read(FilePath)
Dim e As ZipEntry
For Each e In zip
If (e.UsesEncryption)
e.ExtractWithPassword("Secret!")
Else
e.Extract
End If
Next
End Using
</code>
</example>
<param name="password">The Password to use for decrypting the entry.</param>
</member>
<member name="M:Ionic.Zip.ZipEntry.ExtractWithPassword(System.String,System.String)">
<summary>
Extract the entry to the filesystem, starting at the specified base
directory, and using the specified password.
</summary>
<seealso cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/>
<seealso cref="M:Ionic.Zip.ZipEntry.ExtractWithPassword(System.String,Ionic.Zip.ExtractExistingFileAction,System.String)"/>
<remarks>
<para>
Existing entries in the filesystem will not be overwritten. If you
would like to force the overwrite of existing files, see the <see cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/>property, or call
<see cref="M:Ionic.Zip.ZipEntry.ExtractWithPassword(Ionic.Zip.ExtractExistingFileAction,System.String)"/>.
</para>
<para>
See the remarks on the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property, for some
details about how the last modified time of the created file is set.
</para>
</remarks>
<param name="baseDirectory">The pathname of the base directory.</param>
<param name="password">The Password to use for decrypting the entry.</param>
</member>
<member name="M:Ionic.Zip.ZipEntry.ExtractWithPassword(Ionic.Zip.ExtractExistingFileAction,System.String)">
<summary>
Extract the entry to a file in the filesystem, relative to the
current directory, using the specified behavior when extraction
would overwrite an existing file.
</summary>
<remarks>
<para>
See the remarks on the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property, for some
details about how the last modified time of the created file is set.
</para>
</remarks>
<param name="password">The Password to use for decrypting the entry.</param>
<param name="extractExistingFile">
The action to take if extraction would overwrite an existing file.
</param>
</member>
<member name="M:Ionic.Zip.ZipEntry.ExtractWithPassword(System.String,Ionic.Zip.ExtractExistingFileAction,System.String)">
<summary>
Extract the entry to the filesystem, starting at the specified base
directory, and using the specified behavior when extraction would
overwrite an existing file.
</summary>
<remarks>
See the remarks on the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property, for some
details about how the last modified time of the created file is set.
</remarks>
<param name="baseDirectory">the pathname of the base directory</param>
<param name="extractExistingFile">The action to take if extraction would
overwrite an existing file.</param>
<param name="password">The Password to use for decrypting the entry.</param>
</member>
<member name="M:Ionic.Zip.ZipEntry.ExtractWithPassword(System.IO.Stream,System.String)">
<summary>
Extracts the entry to the specified stream, using the specified
Password. For example, the caller could extract to Console.Out, or
to a MemoryStream.
</summary>
<remarks>
<para>
The caller can specify any write-able stream, for example a <see cref="T:System.IO.FileStream"/>, a <see cref="T:System.IO.MemoryStream"/>, or ASP.NET's
<c>Response.OutputStream</c>. The content will be decrypted and
decompressed as necessary. If the entry is encrypted and no password
is provided, this method will throw.
</para>
<para>
The position on the stream is not reset by this method before it extracts.
You may want to call stream.Seek() before calling ZipEntry.Extract().
</para>
</remarks>
<param name="stream">
the stream to which the entry should be extracted.
</param>
<param name="password">
The password to use for decrypting the entry.
</param>
</member>
<member name="M:Ionic.Zip.ZipEntry.OpenReader">
<summary>
Opens a readable stream corresponding to the zip entry in the
archive. The stream decompresses and decrypts as necessary, as it
is read.
</summary>
<remarks>
<para>
DotNetZip offers a variety of ways to extract entries from a zip
file. This method allows an application to extract an entry by
reading a <see cref="T:System.IO.Stream"/>.
</para>
<para>
The return value is of type <see cref="T:Ionic.Crc.CrcCalculatorStream"/>. Use it as you would any
stream for reading. When an application calls <see cref="M:System.IO.Stream.Read(System.Byte[],System.Int32,System.Int32)"/> on that stream, it will
receive data from the zip entry that is decrypted and decompressed
as necessary.
</para>
<para>
<c>CrcCalculatorStream</c> adds one additional feature: it keeps a
CRC32 checksum on the bytes of the stream as it is read. The CRC
value is available in the <see cref="P:Ionic.Crc.CrcCalculatorStream.Crc"/> property on the
<c>CrcCalculatorStream</c>. When the read is complete, your
application
<em>should</em> check this CRC against the <see cref="P:Ionic.Zip.ZipEntry.Crc"/>
property on the <c>ZipEntry</c> to validate the content of the
ZipEntry. You don't have to validate the entry using the CRC, but
you should, to verify integrity. Check the example for how to do
this.
</para>
<para>
If the entry is protected with a password, then you need to provide
a password prior to calling <see cref="M:Ionic.Zip.ZipEntry.OpenReader"/>, either by
setting the <see cref="P:Ionic.Zip.ZipEntry.Password"/> property on the entry, or the
<see cref="P:Ionic.Zip.ZipFile.Password"/> property on the <c>ZipFile</c>
itself. Or, you can use <see cref="M:Ionic.Zip.ZipEntry.OpenReader(System.String)"/>, the
overload of OpenReader that accepts a password parameter.
</para>
<para>
If you want to extract entry data into a write-able stream that is
already opened, like a <see cref="T:System.IO.FileStream"/>, do not
use this method. Instead, use <see cref="M:Ionic.Zip.ZipEntry.Extract(System.IO.Stream)"/>.
</para>
<para>
Your application may use only one stream created by OpenReader() at
a time, and you should not call other Extract methods before
completing your reads on a stream obtained from OpenReader(). This
is because there is really only one source stream for the compressed
content. A call to OpenReader() seeks in the source stream, to the
beginning of the compressed content. A subsequent call to
OpenReader() on a different entry will seek to a different position
in the source stream, as will a call to Extract() or one of its
overloads. This will corrupt the state for the decompressing stream
from the original call to OpenReader().
</para>
<para>
The <c>OpenReader()</c> method works only when the ZipEntry is
obtained from an instance of <c>ZipFile</c>. This method will throw
an exception if the ZipEntry is obtained from a <see cref="T:Ionic.Zip.ZipInputStream"/>.
</para>
</remarks>
<example>
This example shows how to open a zip archive, then read in a named
entry via a stream. After the read loop is complete, the code
compares the calculated during the read loop with the expected CRC
on the <c>ZipEntry</c>, to verify the extraction.
<code>
using (ZipFile zip = new ZipFile(ZipFileToRead))
{
ZipEntry e1= zip["Elevation.mp3"];
using (Ionic.Zlib.CrcCalculatorStream s = e1.OpenReader())
{
byte[] buffer = new byte[4096];
int n, totalBytesRead= 0;
do {
n = s.Read(buffer,0, buffer.Length);
totalBytesRead+=n;
} while (n>0);
if (s.Crc32 != e1.Crc32)
throw new Exception(string.Format("The Zip Entry failed the CRC Check. (0x{0:X8}!=0x{1:X8})", s.Crc32, e1.Crc32));
if (totalBytesRead != e1.UncompressedSize)
throw new Exception(string.Format("We read an unexpected number of bytes. ({0}!={1})", totalBytesRead, e1.UncompressedSize));
}
}
</code>
<code lang="VB">
Using zip As New ZipFile(ZipFileToRead)
Dim e1 As ZipEntry = zip.Item("Elevation.mp3")
Using s As Ionic.Zlib.CrcCalculatorStream = e1.OpenReader
Dim n As Integer
Dim buffer As Byte() = New Byte(4096) {}
Dim totalBytesRead As Integer = 0
Do
n = s.Read(buffer, 0, buffer.Length)
totalBytesRead = (totalBytesRead + n)
Loop While (n > 0)
If (s.Crc32 <> e1.Crc32) Then
Throw New Exception(String.Format("The Zip Entry failed the CRC Check. (0x{0:X8}!=0x{1:X8})", s.Crc32, e1.Crc32))
End If
If (totalBytesRead <> e1.UncompressedSize) Then
Throw New Exception(String.Format("We read an unexpected number of bytes. ({0}!={1})", totalBytesRead, e1.UncompressedSize))
End If
End Using
End Using
</code>
</example>
<seealso cref="M:Ionic.Zip.ZipEntry.Extract(System.IO.Stream)"/>
<returns>The Stream for reading.</returns>
</member>
<member name="M:Ionic.Zip.ZipEntry.OpenReader(System.String)">
<summary>
Opens a readable stream for an encrypted zip entry in the archive.
The stream decompresses and decrypts as necessary, as it is read.
</summary>
<remarks>
<para>
See the documentation on the <see cref="M:Ionic.Zip.ZipEntry.OpenReader"/> method for
full details. This overload allows the application to specify a
password for the <c>ZipEntry</c> to be read.
</para>
</remarks>
<param name="password">The password to use for decrypting the entry.</param>
<returns>The Stream for reading.</returns>
</member>
<member name="M:Ionic.Zip.ZipEntry.InternalExtractToBaseDir(System.String,System.String,Ionic.Zip.ZipContainer,Ionic.Zip.ZipEntrySource,System.String)">
<summary>
Pass in either basedir or s, but not both.
In other words, you can extract to a stream or to a directory (filesystem), but not both!
The Password param is required for encrypted entries.
</summary>
</member>
<member name="M:Ionic.Zip.ZipEntry.InternalExtractToStream(System.IO.Stream,System.String,Ionic.Zip.ZipContainer,Ionic.Zip.ZipEntrySource,System.String)">
<summary>
Extract to a stream
In other words, you can extract to a stream or to a directory (filesystem), but not both!
The Password param is required for encrypted entries.
</summary>
</member>
<member name="M:Ionic.Zip.ZipEntry.IsDoneWithOutputToBaseDir(System.String,System.String@)">
<summary>
Validates that the args are consistent; returning whether the caller can return
because it's done, or not (caller should continue)
</summary>
</member>
<member name="M:Ionic.Zip.ZipEntry.IsDoneWithOutputToStream">
<summary>
Validates that the args are consistent; returning whether the caller can return
because it's done, or not (caller should continue)
</summary>
</member>
<member name="M:Ionic.Zip.ZipEntry.ReadEntry(Ionic.Zip.ZipContainer,System.Boolean)">
<summary>
Reads one <c>ZipEntry</c> from the given stream. The content for
the entry does not get decompressed or decrypted. This method
basically reads metadata, and seeks.
</summary>
<param name="zc">the ZipContainer this entry belongs to.</param>
<param name="first">
true of this is the first entry being read from the stream.
</param>
<returns>the <c>ZipEntry</c> read from the stream.</returns>
</member>
<member name="M:Ionic.Zip.ZipEntry.FindExtraFieldSegment(System.Byte[],System.Int32,System.UInt16)">
<summary>
Finds a particular segment in the given extra field.
This is used when modifying a previously-generated
extra field, in particular when removing the AES crypto
segment in the extra field.
</summary>
</member>
<member name="M:Ionic.Zip.ZipEntry.ProcessExtraField(System.IO.Stream,System.Int16)">
<summary>
At current cursor position in the stream, read the extra
field, and set the properties on the ZipEntry instance
appropriately. This can be called when processing the
Extra field in the Central Directory, or in the local
header.
</summary>
</member>
<member name="M:Ionic.Zip.ZipEntry.GetEncodedFileNameBytes">
<summary>
generate and return a byte array that encodes the filename
for the entry.
</summary>
<remarks>
<para>
side effects: generate and store into _CommentBytes the
byte array for any comment attached to the entry. Also
sets _actualEncoding to indicate the actual encoding
used. The same encoding is used for both filename and
comment.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.ZipEntry.PrepSourceStream">
<summary>
Stores the position of the entry source stream, or, if the position is
already stored, seeks to that position.
</summary>
<remarks>
<para>
This method is called in prep for reading the source stream. If PKZIP
encryption is used, then we need to calc the CRC32 before doing the
encryption, because the CRC is used in the 12th byte of the PKZIP
encryption header. So, we need to be able to seek backward in the source
when saving the ZipEntry. This method is called from the place that
calculates the CRC, and also from the method that does the encryption of
the file data.
</para>
<para>
The first time through, this method sets the _sourceStreamOriginalPosition
field. Subsequent calls to this method seek to that position.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.ZipEntry.CopyMetaData(Ionic.Zip.ZipEntry)">
<summary>
Copy metadata that may have been changed by the app. We do this when
resetting the zipFile instance. If the app calls Save() on a ZipFile, then
tries to party on that file some more, we may need to Reset() it , which
means re-reading the entries and then copying the metadata. I think.
</summary>
</member>
<member name="M:Ionic.Zip.ZipEntry.SetInputAndFigureFileLength(System.IO.Stream@)">
<summary>
Set the input stream and get its length, if possible. The length is
used for progress updates, AND, to allow an optimization in case of
a stream/file of zero length. In that case we skip the Encrypt and
compression Stream. (like DeflateStream or BZip2OutputStream)
</summary>
</member>
<member name="M:Ionic.Zip.ZipEntry.PrepOutputStream(System.IO.Stream,System.Int64,Ionic.Zip.CountingStream@,System.IO.Stream@,System.IO.Stream@,Ionic.Crc.CrcCalculatorStream@)">
<summary>
Prepare the given stream for output - wrap it in a CountingStream, and
then in a CRC stream, and an encryptor and deflator as appropriate.
</summary>
<remarks>
<para>
Previously this was used in ZipEntry.Write(), but in an effort to
introduce some efficiencies in that method I've refactored to put the
code inline. This method still gets called by ZipOutputStream.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.AttributesIndicateDirectory">
<summary>
True if the referenced entry is a directory.
</summary>
</member>
<member name="P:Ionic.Zip.ZipEntry.Info">
<summary>
Provides a human-readable string with information about the ZipEntry.
</summary>
</member>
<member name="P:Ionic.Zip.ZipEntry.LastModified">
<summary>
The time and date at which the file indicated by the <c>ZipEntry</c> was
last modified.
</summary>
<remarks>
<para>
The DotNetZip library sets the LastModified value for an entry, equal to
the Last Modified time of the file in the filesystem. If an entry is
added from a stream, the library uses <c>System.DateTime.Now</c> for this
value, for the given entry.
</para>
<para>
This property allows the application to retrieve and possibly set the
LastModified value on an entry, to an arbitrary value. <see cref="T:System.DateTime"/> values with a <see cref="T:System.DateTimeKind"/>
setting of <c>DateTimeKind.Unspecified</c> are taken to be expressed as
<c>DateTimeKind.Local</c>.
</para>
<para>
Be aware that because of the way <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWare's
Zip specification</see> describes how times are stored in the zip file,
the full precision of the <c>System.DateTime</c> datatype is not stored
for the last modified time when saving zip files. For more information on
how times are formatted, see the PKZip specification.
</para>
<para>
The actual last modified time of a file can be stored in multiple ways in
the zip file, and they are not mutually exclusive:
</para>
<list type="bullet">
<item>
In the so-called "DOS" format, which has a 2-second precision. Values
are rounded to the nearest even second. For example, if the time on the
file is 12:34:43, then it will be stored as 12:34:44. This first value
is accessible via the <c>LastModified</c> property. This value is always
present in the metadata for each zip entry. In some cases the value is
invalid, or zero.
</item>
<item>
In the so-called "Windows" or "NTFS" format, as an 8-byte integer
quantity expressed as the number of 1/10 milliseconds (in other words
the number of 100 nanosecond units) since January 1, 1601 (UTC). This
format is how Windows represents file times. This time is accessible
via the <c>ModifiedTime</c> property.
</item>
<item>
In the "Unix" format, a 4-byte quantity specifying the number of seconds since
January 1, 1970 UTC.
</item>
<item>
In an older format, now deprecated but still used by some current
tools. This format is also a 4-byte quantity specifying the number of
seconds since January 1, 1970 UTC.
</item>
</list>
<para>
Zip tools and libraries will always at least handle (read or write) the
DOS time, and may also handle the other time formats. Keep in mind that
while the names refer to particular operating systems, there is nothing in
the time formats themselves that prevents their use on other operating
systems.
</para>
<para>
When reading ZIP files, the DotNetZip library reads the Windows-formatted
time, if it is stored in the entry, and sets both <c>LastModified</c> and
<c>ModifiedTime</c> to that value. When writing ZIP files, the DotNetZip
library by default will write both time quantities. It can also emit the
Unix-formatted time if desired (See <see cref="P:Ionic.Zip.ZipEntry.EmitTimesInUnixFormatWhenSaving"/>.)
</para>
<para>
The last modified time of the file created upon a call to
<c>ZipEntry.Extract()</c> may be adjusted during extraction to compensate
for differences in how the .NET Base Class Library deals with daylight
saving time (DST) versus how the Windows filesystem deals with daylight
saving time. Raymond Chen <see href="http://blogs.msdn.com/oldnewthing/archive/2003/10/24/55413.aspx">provides
some good context</see>.
</para>
<para>
In a nutshell: Daylight savings time rules change regularly. In 2007, for
example, the inception week of DST changed. In 1977, DST was in place all
year round. In 1945, likewise. And so on. Win32 does not attempt to
guess which time zone rules were in effect at the time in question. It
will render a time as "standard time" and allow the app to change to DST
as necessary. .NET makes a different choice.
</para>
<para>
Compare the output of FileInfo.LastWriteTime.ToString("f") with what you
see in the Windows Explorer property sheet for a file that was last
written to on the other side of the DST transition. For example, suppose
the file was last modified on October 17, 2003, during DST but DST is not
currently in effect. Explorer's file properties reports Thursday, October
17, 2003, 8:45:38 AM, but .NETs FileInfo reports Thursday, October 17,
2003, 9:45 AM.
</para>
<para>
Win32 says, "Thursday, October 17, 2002 8:45:38 AM PST". Note: Pacific
STANDARD Time. Even though October 17 of that year occurred during Pacific
Daylight Time, Win32 displays the time as standard time because that's
what time it is NOW.
</para>
<para>
.NET BCL assumes that the current DST rules were in place at the time in
question. So, .NET says, "Well, if the rules in effect now were also in
effect on October 17, 2003, then that would be daylight time" so it
displays "Thursday, October 17, 2003, 9:45 AM PDT" - daylight time.
</para>
<para>
So .NET gives a value which is more intuitively correct, but is also
potentially incorrect, and which is not invertible. Win32 gives a value
which is intuitively incorrect, but is strictly correct.
</para>
<para>
Because of this funkiness, this library adds one hour to the LastModified
time on the extracted file, if necessary. That is to say, if the time in
question had occurred in what the .NET Base Class Library assumed to be
DST. This assumption may be wrong given the constantly changing DST rules,
but it is the best we can do.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.ModifiedTime">
<summary>
Last Modified time for the file represented by the entry.
</summary>
<remarks>
<para>
This value corresponds to the "last modified" time in the NTFS file times
as described in <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">the Zip
specification</see>. When getting this property, the value may be
different from <see cref="P:Ionic.Zip.ZipEntry.LastModified"/>. When setting the property,
the <see cref="P:Ionic.Zip.ZipEntry.LastModified"/> property also gets set, but with a lower
precision.
</para>
<para>
Let me explain. It's going to take a while, so get
comfortable. Originally, waaaaay back in 1989 when the ZIP specification
was originally described by the esteemed Mr. Phil Katz, the dominant
operating system of the time was MS-DOS. MSDOS stored file times with a
2-second precision, because, c'mon, <em>who is ever going to need better
resolution than THAT?</em> And so ZIP files, regardless of the platform on
which the zip file was created, store file times in exactly <see href="http://www.vsft.com/hal/dostime.htm">the same format that DOS used
in 1989</see>.
</para>
<para>
Since then, the ZIP spec has evolved, but the internal format for file
timestamps remains the same. Despite the fact that the way times are
stored in a zip file is rooted in DOS heritage, any program on any
operating system can format a time in this way, and most zip tools and
libraries DO - they round file times to the nearest even second and store
it just like DOS did 25+ years ago.
</para>
<para>
PKWare extended the ZIP specification to allow a zip file to store what
are called "NTFS Times" and "Unix(tm) times" for a file. These are the
<em>last write</em>, <em>last access</em>, and <em>file creation</em>
times of a particular file. These metadata are not actually specific
to NTFS or Unix. They are tracked for each file by NTFS and by various
Unix filesystems, but they are also tracked by other filesystems, too.
The key point is that the times are <em>formatted in the zip file</em>
in the same way that NTFS formats the time (ticks since win32 epoch),
or in the same way that Unix formats the time (seconds since Unix
epoch). As with the DOS time, any tool or library running on any
operating system is capable of formatting a time in one of these ways
and embedding it into the zip file.
</para>
<para>
These extended times are higher precision quantities than the DOS time.
As described above, the (DOS) LastModified has a precision of 2 seconds.
The Unix time is stored with a precision of 1 second. The NTFS time is
stored with a precision of 0.0000001 seconds. The quantities are easily
convertible, except for the loss of precision you may incur.
</para>
<para>
A zip archive can store the {C,A,M} times in NTFS format, in Unix format,
or not at all. Often a tool running on Unix or Mac will embed the times
in Unix format (1 second precision), while WinZip running on Windows might
embed the times in NTFS format (precision of of 0.0000001 seconds). When
reading a zip file with these "extended" times, in either format,
DotNetZip represents the values with the
<c>ModifiedTime</c>, <c>AccessedTime</c> and <c>CreationTime</c>
properties on the <c>ZipEntry</c>.
</para>
<para>
While any zip application or library, regardless of the platform it
runs on, could use any of the time formats allowed by the ZIP
specification, not all zip tools or libraries do support all these
formats. Storing the higher-precision times for each entry is
optional for zip files, and many tools and libraries don't use the
higher precision quantities at all. The old DOS time, represented by
<see cref="P:Ionic.Zip.ZipEntry.LastModified"/>, is guaranteed to be present, though it
sometimes unset.
</para>
<para>
Ok, getting back to the question about how the <c>LastModified</c>
property relates to this <c>ModifiedTime</c>
property... <c>LastModified</c> is always set, while
<c>ModifiedTime</c> is not. (The other times stored in the <em>NTFS
times extension</em>, <c>CreationTime</c> and <c>AccessedTime</c> also
may not be set on an entry that is read from an existing zip file.)
When reading a zip file, then <c>LastModified</c> takes the DOS time
that is stored with the file. If the DOS time has been stored as zero
in the zipfile, then this library will use <c>DateTime.Now</c> for the
<c>LastModified</c> value. If the ZIP file was created by an evolved
tool, then there will also be higher precision NTFS or Unix times in
the zip file. In that case, this library will read those times, and
set <c>LastModified</c> and <c>ModifiedTime</c> to the same value, the
one corresponding to the last write time of the file. If there are no
higher precision times stored for the entry, then <c>ModifiedTime</c>
remains unset (likewise <c>AccessedTime</c> and <c>CreationTime</c>),
and <c>LastModified</c> keeps its DOS time.
</para>
<para>
When creating zip files with this library, by default the extended time
properties (<c>ModifiedTime</c>, <c>AccessedTime</c>, and
<c>CreationTime</c>) are set on the ZipEntry instance, and these data are
stored in the zip archive for each entry, in NTFS format. If you add an
entry from an actual filesystem file, then the entry gets the actual file
times for that file, to NTFS-level precision. If you add an entry from a
stream, or a string, then the times get the value <c>DateTime.Now</c>. In
this case <c>LastModified</c> and <c>ModifiedTime</c> will be identical,
to 2 seconds of precision. You can explicitly set the
<c>CreationTime</c>, <c>AccessedTime</c>, and <c>ModifiedTime</c> of an
entry using the property setters. If you want to set all of those
quantities, it's more efficient to use the <see cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/> method. Those
changes are not made permanent in the zip file until you call <see cref="M:Ionic.Zip.ZipFile.Save"/> or one of its cousins.
</para>
<para>
When creating a zip file, you can override the default behavior of
this library for formatting times in the zip file, disabling the
embedding of file times in NTFS format or enabling the storage of file
times in Unix format, or both. You may want to do this, for example,
when creating a zip file on Windows, that will be consumed on a Mac,
by an application that is not hip to the "NTFS times" format. To do
this, use the <see cref="P:Ionic.Zip.ZipEntry.EmitTimesInWindowsFormatWhenSaving"/> and
<see cref="P:Ionic.Zip.ZipEntry.EmitTimesInUnixFormatWhenSaving"/> properties. A valid zip
file may store the file times in both formats. But, there are no
guarantees that a program running on Mac or Linux will gracefully
handle the NTFS-formatted times when Unix times are present, or that a
non-DotNetZip-powered application running on Windows will be able to
handle file times in Unix format. DotNetZip will always do something
reasonable; other libraries or tools may not. When in doubt, test.
</para>
<para>
I'll bet you didn't think one person could type so much about time, eh?
And reading it was so enjoyable, too! Well, in appreciation, <see href="http://cheeso.members.winisp.net/DotNetZipDonate.aspx">maybe you
should donate</see>?
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.CreationTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.LastModified"/>
<seealso cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.AccessedTime">
<summary>
Last Access time for the file represented by the entry.
</summary>
<remarks>
This value may or may not be meaningful. If the <c>ZipEntry</c> was read from an existing
Zip archive, this information may not be available. For an explanation of why, see
<see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>.
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.CreationTime"/>
<seealso cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.CreationTime">
<summary>
The file creation time for the file represented by the entry.
</summary>
<remarks>
This value may or may not be meaningful. If the <c>ZipEntry</c> was read
from an existing zip archive, and the creation time was not set on the entry
when the zip file was created, then this property may be meaningless. For an
explanation of why, see <see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>.
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>
<seealso cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.EmitTimesInWindowsFormatWhenSaving">
<summary>
Specifies whether the Creation, Access, and Modified times for the given
entry will be emitted in "Windows format" when the zip archive is saved.
</summary>
<remarks>
<para>
An application creating a zip archive can use this flag to explicitly
specify that the file times for the entry should or should not be stored
in the zip archive in the format used by Windows. The default value of
this property is <c>true</c>.
</para>
<para>
When adding an entry from a file or directory, the Creation (<see cref="P:Ionic.Zip.ZipEntry.CreationTime"/>), Access (<see cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>), and Modified
(<see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>) times for the given entry are automatically
set from the filesystem values. When adding an entry from a stream or
string, all three values are implicitly set to DateTime.Now. Applications
can also explicitly set those times by calling <see cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/>.
</para>
<para>
<see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's
zip specification</see> describes multiple ways to format these times in a
zip file. One is the format Windows applications normally use: 100ns ticks
since Jan 1, 1601 UTC. The other is a format Unix applications typically
use: seconds since January 1, 1970 UTC. Each format can be stored in an
"extra field" in the zip entry when saving the zip archive. The former
uses an extra field with a Header Id of 0x000A, while the latter uses a
header ID of 0x5455.
</para>
<para>
Not all zip tools and libraries can interpret these fields. Windows
compressed folders is one that can read the Windows Format timestamps,
while I believe the <see href="http://www.info-zip.org/">Infozip</see>
tools can read the Unix format timestamps. Although the time values are
easily convertible, subject to a loss of precision, some tools and
libraries may be able to read only one or the other. DotNetZip can read or
write times in either or both formats.
</para>
<para>
The times stored are taken from <see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>, <see cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>, and <see cref="P:Ionic.Zip.ZipEntry.CreationTime"/>.
</para>
<para>
This property is not mutually exclusive from the <see cref="P:Ionic.Zip.ZipEntry.EmitTimesInUnixFormatWhenSaving"/> property. It is
possible that a zip entry can embed the timestamps in both forms, one
form, or neither. But, there are no guarantees that a program running on
Mac or Linux will gracefully handle NTFS Formatted times, or that a
non-DotNetZip-powered application running on Windows will be able to
handle file times in Unix format. When in doubt, test.
</para>
<para>
Normally you will use the <see cref="P:Ionic.Zip.ZipFile.EmitTimesInWindowsFormatWhenSaving">ZipFile.EmitTimesInWindowsFormatWhenSaving</see>
property, to specify the behavior for all entries in a zip, rather than
the property on each individual entry.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/>
<seealso cref="P:Ionic.Zip.ZipEntry.EmitTimesInUnixFormatWhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipEntry.CreationTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.EmitTimesInUnixFormatWhenSaving">
<summary>
Specifies whether the Creation, Access, and Modified times for the given
entry will be emitted in "Unix(tm) format" when the zip archive is saved.
</summary>
<remarks>
<para>
An application creating a zip archive can use this flag to explicitly
specify that the file times for the entry should or should not be stored
in the zip archive in the format used by Unix. By default this flag is
<c>false</c>, meaning the Unix-format times are not stored in the zip
archive.
</para>
<para>
When adding an entry from a file or directory, the Creation (<see cref="P:Ionic.Zip.ZipEntry.CreationTime"/>), Access (<see cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>), and Modified
(<see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>) times for the given entry are automatically
set from the filesystem values. When adding an entry from a stream or
string, all three values are implicitly set to DateTime.Now. Applications
can also explicitly set those times by calling <see cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/>.
</para>
<para>
<see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's
zip specification</see> describes multiple ways to format these times in a
zip file. One is the format Windows applications normally use: 100ns ticks
since Jan 1, 1601 UTC. The other is a format Unix applications typically
use: seconds since Jan 1, 1970 UTC. Each format can be stored in an
"extra field" in the zip entry when saving the zip archive. The former
uses an extra field with a Header Id of 0x000A, while the latter uses a
header ID of 0x5455.
</para>
<para>
Not all tools and libraries can interpret these fields. Windows
compressed folders is one that can read the Windows Format timestamps,
while I believe the <see href="http://www.info-zip.org/">Infozip</see>
tools can read the Unix format timestamps. Although the time values are
easily convertible, subject to a loss of precision, some tools and
libraries may be able to read only one or the other. DotNetZip can read or
write times in either or both formats.
</para>
<para>
The times stored are taken from <see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>, <see cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>, and <see cref="P:Ionic.Zip.ZipEntry.CreationTime"/>.
</para>
<para>
This property is not mutually exclusive from the <see cref="P:Ionic.Zip.ZipEntry.EmitTimesInWindowsFormatWhenSaving"/> property. It is
possible that a zip entry can embed the timestamps in both forms, one
form, or neither. But, there are no guarantees that a program running on
Mac or Linux will gracefully handle NTFS Formatted times, or that a
non-DotNetZip-powered application running on Windows will be able to
handle file times in Unix format. When in doubt, test.
</para>
<para>
Normally you will use the <see cref="P:Ionic.Zip.ZipFile.EmitTimesInUnixFormatWhenSaving">ZipFile.EmitTimesInUnixFormatWhenSaving</see>
property, to specify the behavior for all entries, rather than the
property on each individual entry.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/>
<seealso cref="P:Ionic.Zip.ZipEntry.EmitTimesInWindowsFormatWhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipFile.EmitTimesInUnixFormatWhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipEntry.CreationTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>
<seealso cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.Timestamp">
<summary>
The type of timestamp attached to the ZipEntry.
</summary>
<remarks>
This property is valid only for a ZipEntry that was read from a zip archive.
It indicates the type of timestamp attached to the entry.
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.EmitTimesInWindowsFormatWhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipEntry.EmitTimesInUnixFormatWhenSaving"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.Attributes">
<summary>
The file attributes for the entry.
</summary>
<remarks>
<para>
The <see cref="T:System.IO.FileAttributes">attributes</see> in NTFS include
ReadOnly, Archive, Hidden, System, and Indexed. When adding a
<c>ZipEntry</c> to a ZipFile, these attributes are set implicitly when
adding an entry from the filesystem. When adding an entry from a stream
or string, the Attributes are not set implicitly. Regardless of the way
an entry was added to a <c>ZipFile</c>, you can set the attributes
explicitly if you like.
</para>
<para>
When reading a <c>ZipEntry</c> from a <c>ZipFile</c>, the attributes are
set according to the data stored in the <c>ZipFile</c>. If you extract the
entry from the archive to a filesystem file, DotNetZip will set the
attributes on the resulting file accordingly.
</para>
<para>
The attributes can be set explicitly by the application. For example the
application may wish to set the <c>FileAttributes.ReadOnly</c> bit for all
entries added to an archive, so that on unpack, this attribute will be set
on the extracted file. Any changes you make to this property are made
permanent only when you call a <c>Save()</c> method on the <c>ZipFile</c>
instance that contains the ZipEntry.
</para>
<para>
For example, an application may wish to zip up a directory and set the
ReadOnly bit on every file in the archive, so that upon later extraction,
the resulting files will be marked as ReadOnly. Not every extraction tool
respects these attributes, but if you unpack with DotNetZip, as for
example in a self-extracting archive, then the attributes will be set as
they are stored in the <c>ZipFile</c>.
</para>
<para>
These attributes may not be interesting or useful if the resulting archive
is extracted on a non-Windows platform. How these attributes get used
upon extraction depends on the platform and tool used.
</para>
<para>
This property is only partially supported in the Silverlight version
of the library: applications can read attributes on entries within
ZipFiles. But extracting entries within Silverlight will not set the
attributes on the extracted files.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.LocalFileName">
<summary>
The name of the filesystem file, referred to by the ZipEntry.
</summary>
<remarks>
<para>
This property specifies the thing-to-be-zipped on disk, and is set only
when the <c>ZipEntry</c> is being created from a filesystem file. If the
<c>ZipFile</c> is instantiated by reading an existing .zip archive, then
the LocalFileName will be <c>null</c> (<c>Nothing</c> in VB).
</para>
<para>
When it is set, the value of this property may be different than <see cref="P:Ionic.Zip.ZipEntry.FileName"/>, which is the path used in the archive itself. If you
call <c>Zip.AddFile("foop.txt", AlternativeDirectory)</c>, then the path
used for the <c>ZipEntry</c> within the zip archive will be different
than this path.
</para>
<para>
If the entry is being added from a stream, then this is null (Nothing in VB).
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.FileName"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.FileName">
<summary>
The name of the file contained in the ZipEntry.
</summary>
<remarks>
<para>
This is the name of the entry in the <c>ZipFile</c> itself. When creating
a zip archive, if the <c>ZipEntry</c> has been created from a filesystem
file, via a call to <see cref="M:Ionic.Zip.ZipFile.AddFile(System.String,System.String)"/> or <see cref="M:Ionic.Zip.ZipFile.AddItem(System.String,System.String)"/>, or a related overload, the value
of this property is derived from the name of that file. The
<c>FileName</c> property does not include drive letters, and may include a
different directory path, depending on the value of the
<c>directoryPathInArchive</c> parameter used when adding the entry into
the <c>ZipFile</c>.
</para>
<para>
In some cases there is no related filesystem file - for example when a
<c>ZipEntry</c> is created using <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.String)"/> or one of the similar overloads. In this case, the value of
this property is derived from the fileName and the directory path passed
to that method.
</para>
<para>
When reading a zip file, this property takes the value of the entry name
as stored in the zip file. If you extract such an entry, the extracted
file will take the name given by this property.
</para>
<para>
Applications can set this property when creating new zip archives or when
reading existing archives. When setting this property, the actual value
that is set will replace backslashes with forward slashes, in accordance
with <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">the Zip
specification</see>, for compatibility with Unix(tm) and ... get
this.... Amiga!
</para>
<para>
If an application reads a <c>ZipFile</c> via <see cref="M:Ionic.Zip.ZipFile.Read(System.String)"/> or a related overload, and then explicitly
sets the FileName on an entry contained within the <c>ZipFile</c>, and
then calls <see cref="M:Ionic.Zip.ZipFile.Save"/>, the application will effectively
rename the entry within the zip archive.
</para>
<para>
If an application sets the value of <c>FileName</c>, then calls
<c>Extract()</c> on the entry, the entry is extracted to a file using the
newly set value as the filename. The <c>FileName</c> value is made
permanent in the zip archive only <em>after</em> a call to one of the
<c>ZipFile.Save()</c> methods on the <c>ZipFile</c> that contains the
ZipEntry.
</para>
<para>
If an application attempts to set the <c>FileName</c> to a value that
would result in a duplicate entry in the <c>ZipFile</c>, an exception is
thrown.
</para>
<para>
When a <c>ZipEntry</c> is contained within a <c>ZipFile</c>, applications
cannot rename the entry within the context of a <c>foreach</c> (<c>For
Each</c> in VB) loop, because of the way the <c>ZipFile</c> stores
entries. If you need to enumerate through all the entries and rename one
or more of them, use <see cref="P:Ionic.Zip.ZipFile.EntriesSorted">ZipFile.EntriesSorted</see> as the
collection. See also, <see cref="M:Ionic.Zip.ZipFile.GetEnumerator">ZipFile.GetEnumerator()</see>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.InputStream">
<summary>
The stream that provides content for the ZipEntry.
</summary>
<remarks>
<para>
The application can use this property to set the input stream for an
entry on a just-in-time basis. Imagine a scenario where the application
creates a <c>ZipFile</c> comprised of content obtained from hundreds of
files, via calls to <c>AddFile()</c>. The DotNetZip library opens streams
on these files on a just-in-time basis, only when writing the entry out to
an external store within the scope of a <c>ZipFile.Save()</c> call. Only
one input stream is opened at a time, as each entry is being written out.
</para>
<para>
Now imagine a different application that creates a <c>ZipFile</c>
with content obtained from hundreds of streams, added through <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.IO.Stream)"/>. Normally the
application would supply an open stream to that call. But when large
numbers of streams are being added, this can mean many open streams at one
time, unnecessarily.
</para>
<para>
To avoid this, call <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)"/> and specify delegates that open and close the stream at
the time of Save.
</para>
<para>
Setting the value of this property when the entry was not added from a
stream (for example, when the <c>ZipEntry</c> was added with <see cref="M:Ionic.Zip.ZipFile.AddFile(System.String)"/> or <see cref="M:Ionic.Zip.ZipFile.AddDirectory(System.String)"/>, or when the entry was added by
reading an existing zip archive) will throw an exception.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.InputStreamWasJitProvided">
<summary>
A flag indicating whether the InputStream was provided Just-in-time.
</summary>
<remarks>
<para>
When creating a zip archive, an application can obtain content for one or
more of the <c>ZipEntry</c> instances from streams, using the <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.IO.Stream)"/> method. At the time
of calling that method, the application can supply null as the value of
the stream parameter. By doing so, the application indicates to the
library that it will provide a stream for the entry on a just-in-time
basis, at the time one of the <c>ZipFile.Save()</c> methods is called and
the data for the various entries are being compressed and written out.
</para>
<para>
In this case, the application can set the <see cref="P:Ionic.Zip.ZipEntry.InputStream"/>
property, typically within the SaveProgress event (event type: <see cref="F:Ionic.Zip.ZipProgressEventType.Saving_BeforeWriteEntry"/>) for that entry.
</para>
<para>
The application will later want to call Close() and Dispose() on that
stream. In the SaveProgress event, when the event type is <see cref="F:Ionic.Zip.ZipProgressEventType.Saving_AfterWriteEntry"/>, the application can
do so. This flag indicates that the stream has been provided by the
application on a just-in-time basis and that it is the application's
responsibility to call Close/Dispose on that stream.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.InputStream"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.Source">
<summary>
An enum indicating the source of the ZipEntry.
</summary>
</member>
<member name="P:Ionic.Zip.ZipEntry.VersionNeeded">
<summary>
The version of the zip engine needed to read the ZipEntry.
</summary>
<remarks>
<para>
This is a readonly property, indicating the version of <a
href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">the Zip
specification</a> that the extracting tool or library must support to
extract the given entry. Generally higher versions indicate newer
features. Older zip engines obviously won't know about new features, and
won't be able to extract entries that depend on those newer features.
</para>
<list type="table">
<listheader>
<term>value</term>
<description>Features</description>
</listheader>
<item>
<term>20</term>
<description>a basic Zip Entry, potentially using PKZIP encryption.
</description>
</item>
<item>
<term>45</term>
<description>The ZIP64 extension is used on the entry.
</description>
</item>
<item>
<term>46</term>
<description> File is compressed using BZIP2 compression*</description>
</item>
<item>
<term>50</term>
<description> File is encrypted using PkWare's DES, 3DES, (broken) RC2 or RC4</description>
</item>
<item>
<term>51</term>
<description> File is encrypted using PKWare's AES encryption or corrected RC2 encryption.</description>
</item>
<item>
<term>52</term>
<description> File is encrypted using corrected RC2-64 encryption**</description>
</item>
<item>
<term>61</term>
<description> File is encrypted using non-OAEP key wrapping***</description>
</item>
<item>
<term>63</term>
<description> File is compressed using LZMA, PPMd+, Blowfish, or Twofish</description>
</item>
</list>
<para>
There are other values possible, not listed here. DotNetZip supports
regular PKZip encryption, and ZIP64 extensions. DotNetZip cannot extract
entries that require a zip engine higher than 45.
</para>
<para>
This value is set upon reading an existing zip file, or after saving a zip
archive.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.Comment">
<summary>
The comment attached to the ZipEntry.
</summary>
<remarks>
<para>
Each entry in a zip file can optionally have a comment associated to
it. The comment might be displayed by a zip tool during extraction, for
example.
</para>
<para>
By default, the <c>Comment</c> is encoded in IBM437 code page. You can
specify an alternative with <see cref="P:Ionic.Zip.ZipEntry.AlternateEncoding"/> and
<see cref="P:Ionic.Zip.ZipEntry.AlternateEncodingUsage"/>.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.AlternateEncoding"/>
<seealso cref="P:Ionic.Zip.ZipEntry.AlternateEncodingUsage"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.RequiresZip64">
<summary>
Indicates whether the entry requires ZIP64 extensions.
</summary>
<remarks>
<para>
This property is null (Nothing in VB) until a <c>Save()</c> method on the
containing <see cref="T:Ionic.Zip.ZipFile"/> instance has been called. The property is
non-null (<c>HasValue</c> is true) only after a <c>Save()</c> method has
been called.
</para>
<para>
After the containing <c>ZipFile</c> has been saved, the Value of this
property is true if any of the following three conditions holds: the
uncompressed size of the entry is larger than 0xFFFFFFFF; the compressed
size of the entry is larger than 0xFFFFFFFF; the relative offset of the
entry within the zip archive is larger than 0xFFFFFFFF. These quantities
are not known until a <c>Save()</c> is attempted on the zip archive and
the compression is applied.
</para>
<para>
If none of the three conditions holds, then the <c>Value</c> is false.
</para>
<para>
A <c>Value</c> of false does not indicate that the entry, as saved in the
zip archive, does not use ZIP64. It merely indicates that ZIP64 is
<em>not required</em>. An entry may use ZIP64 even when not required if
the <see cref="P:Ionic.Zip.ZipFile.UseZip64WhenSaving"/> property on the containing
<c>ZipFile</c> instance is set to <see cref="F:Ionic.Zip.Zip64Option.Always"/>, or if
the <see cref="P:Ionic.Zip.ZipFile.UseZip64WhenSaving"/> property on the containing
<c>ZipFile</c> instance is set to <see cref="F:Ionic.Zip.Zip64Option.AsNecessary"/>
and the output stream was not seekable.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.OutputUsedZip64"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.OutputUsedZip64">
<summary>
Indicates whether the entry actually used ZIP64 extensions, as it was most
recently written to the output file or stream.
</summary>
<remarks>
<para>
This Nullable property is null (Nothing in VB) until a <c>Save()</c>
method on the containing <see cref="T:Ionic.Zip.ZipFile"/> instance has been
called. <c>HasValue</c> is true only after a <c>Save()</c> method has been
called.
</para>
<para>
The value of this property for a particular <c>ZipEntry</c> may change
over successive calls to <c>Save()</c> methods on the containing ZipFile,
even if the file that corresponds to the <c>ZipEntry</c> does not. This
may happen if other entries contained in the <c>ZipFile</c> expand,
causing the offset for this particular entry to exceed 0xFFFFFFFF.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.RequiresZip64"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.BitField">
<summary>
The bitfield for the entry as defined in the zip spec. You probably
never need to look at this.
</summary>
<remarks>
<para>
You probably do not need to concern yourself with the contents of this
property, but in case you do:
</para>
<list type="table">
<listheader>
<term>bit</term>
<description>meaning</description>
</listheader>
<item>
<term>0</term>
<description>set if encryption is used.</description>
</item>
<item>
<term>1-2</term>
<description>
set to determine whether normal, max, fast deflation. DotNetZip library
always leaves these bits unset when writing (indicating "normal"
deflation"), but can read an entry with any value here.
</description>
</item>
<item>
<term>3</term>
<description>
Indicates that the Crc32, Compressed and Uncompressed sizes are zero in the
local header. This bit gets set on an entry during writing a zip file, when
it is saved to a non-seekable output stream.
</description>
</item>
<item>
<term>4</term>
<description>reserved for "enhanced deflating". This library doesn't do enhanced deflating.</description>
</item>
<item>
<term>5</term>
<description>set to indicate the zip is compressed patched data. This library doesn't do that.</description>
</item>
<item>
<term>6</term>
<description>
set if PKWare's strong encryption is used (must also set bit 1 if bit 6 is
set). This bit is not set if WinZip's AES encryption is set.</description>
</item>
<item>
<term>7</term>
<description>not used</description>
</item>
<item>
<term>8</term>
<description>not used</description>
</item>
<item>
<term>9</term>
<description>not used</description>
</item>
<item>
<term>10</term>
<description>not used</description>
</item>
<item>
<term>11</term>
<description>
Language encoding flag (EFS). If this bit is set, the filename and comment
fields for this file must be encoded using UTF-8. This library currently
does not support UTF-8.
</description>
</item>
<item>
<term>12</term>
<description>Reserved by PKWARE for enhanced compression.</description>
</item>
<item>
<term>13</term>
<description>
Used when encrypting the Central Directory to indicate selected data
values in the Local Header are masked to hide their actual values. See
the section in <a
href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">the Zip
specification</a> describing the Strong Encryption Specification for
details.
</description>
</item>
<item>
<term>14</term>
<description>Reserved by PKWARE.</description>
</item>
<item>
<term>15</term>
<description>Reserved by PKWARE.</description>
</item>
</list>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.CompressionMethod">
<summary>
The compression method employed for this ZipEntry.
</summary>
<remarks>
<para>
<see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">The
Zip specification</see> allows a variety of compression methods. This
library supports just two: 0x08 = Deflate. 0x00 = Store (no compression),
for reading or writing.
</para>
<para>
When reading an entry from an existing zipfile, the value you retrieve
here indicates the compression method used on the entry by the original
creator of the zip. When writing a zipfile, you can specify either 0x08
(Deflate) or 0x00 (None). If you try setting something else, you will get
an exception.
</para>
<para>
You may wish to set <c>CompressionMethod</c> to <c>CompressionMethod.None</c> (0)
when zipping already-compressed data like a jpg, png, or mp3 file.
This can save time and cpu cycles.
</para>
<para>
When setting this property on a <c>ZipEntry</c> that is read from an
existing zip file, calling <c>ZipFile.Save()</c> will cause the new
CompressionMethod to be used on the entry in the newly saved zip file.
</para>
<para>
Setting this property may have the side effect of modifying the
<c>CompressionLevel</c> property. If you set the <c>CompressionMethod</c> to a
value other than <c>None</c>, and <c>CompressionLevel</c> is previously
set to <c>None</c>, then <c>CompressionLevel</c> will be set to
<c>Default</c>.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.CompressionMethod"/>
<example>
In this example, the first entry added to the zip archive uses the default
behavior - compression is used where it makes sense. The second entry,
the MP3 file, is added to the archive without being compressed.
<code>
using (ZipFile zip = new ZipFile(ZipFileToCreate))
{
ZipEntry e1= zip.AddFile(@"notes\Readme.txt");
ZipEntry e2= zip.AddFile(@"music\StopThisTrain.mp3");
e2.CompressionMethod = CompressionMethod.None;
zip.Save();
}
</code>
<code lang="VB">
Using zip As New ZipFile(ZipFileToCreate)
zip.AddFile("notes\Readme.txt")
Dim e2 as ZipEntry = zip.AddFile("music\StopThisTrain.mp3")
e2.CompressionMethod = CompressionMethod.None
zip.Save
End Using
</code>
</example>
</member>
<member name="P:Ionic.Zip.ZipEntry.CompressionLevel">
<summary>
Sets the compression level to be used for the entry when saving the zip
archive. This applies only for CompressionMethod = DEFLATE.
</summary>
<remarks>
<para>
When using the DEFLATE compression method, Varying the compression
level used on entries can affect the size-vs-speed tradeoff when
compression and decompressing data streams or files.
</para>
<para>
If you do not set this property, the default compression level is used,
which normally gives a good balance of compression efficiency and
compression speed. In some tests, using <c>BestCompression</c> can
double the time it takes to compress, while delivering just a small
increase in compression efficiency. This behavior will vary with the
type of data you compress. If you are in doubt, just leave this setting
alone, and accept the default.
</para>
<para>
When setting this property on a <c>ZipEntry</c> that is read from an
existing zip file, calling <c>ZipFile.Save()</c> will cause the new
<c>CompressionLevel</c> to be used on the entry in the newly saved zip file.
</para>
<para>
Setting this property may have the side effect of modifying the
<c>CompressionMethod</c> property. If you set the <c>CompressionLevel</c>
to a value other than <c>None</c>, <c>CompressionMethod</c> will be set
to <c>Deflate</c>, if it was previously <c>None</c>.
</para>
<para>
Setting this property has no effect if the <c>CompressionMethod</c> is something
other than <c>Deflate</c> or <c>None</c>.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.CompressionMethod"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.CompressedSize">
<summary>
The compressed size of the file, in bytes, within the zip archive.
</summary>
<remarks>
When reading a <c>ZipFile</c>, this value is read in from the existing
zip file. When creating or updating a <c>ZipFile</c>, the compressed
size is computed during compression. Therefore the value on a
<c>ZipEntry</c> is valid after a call to <c>Save()</c> (or one of its
overloads) in that case.
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.UncompressedSize"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.UncompressedSize">
<summary>
The size of the file, in bytes, before compression, or after extraction.
</summary>
<remarks>
When reading a <c>ZipFile</c>, this value is read in from the existing
zip file. When creating or updating a <c>ZipFile</c>, the uncompressed
size is computed during compression. Therefore the value on a
<c>ZipEntry</c> is valid after a call to <c>Save()</c> (or one of its
overloads) in that case.
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.CompressedSize"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.CompressionRatio">
<summary>
The ratio of compressed size to uncompressed size of the ZipEntry.
</summary>
<remarks>
<para>
This is a ratio of the compressed size to the uncompressed size of the
entry, expressed as a double in the range of 0 to 100+. A value of 100
indicates no compression at all. It could be higher than 100 when the
compression algorithm actually inflates the data, as may occur for small
files, or uncompressible data that is encrypted.
</para>
<para>
You could format it for presentation to a user via a format string of
"{3,5:F0}%" to see it as a percentage.
</para>
<para>
If the size of the original uncompressed file is 0, implying a
denominator of 0, the return value will be zero.
</para>
<para>
This property is valid after reading in an existing zip file, or after
saving the <c>ZipFile</c> that contains the ZipEntry. You cannot know the
effect of a compression transform until you try it.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.Crc">
<summary>
The 32-bit CRC (Cyclic Redundancy Check) on the contents of the ZipEntry.
</summary>
<remarks>
<para> You probably don't need to concern yourself with this. It is used
internally by DotNetZip to verify files or streams upon extraction. </para>
<para> The value is a <see href="http://en.wikipedia.org/wiki/CRC32">32-bit
CRC</see> using 0xEDB88320 for the polynomial. This is the same CRC-32 used in
PNG, MPEG-2, and other protocols and formats. It is a read-only property; when
creating a Zip archive, the CRC for each entry is set only after a call to
<c>Save()</c> on the containing ZipFile. When reading an existing zip file, the value
of this property reflects the stored CRC for the entry. </para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.IsDirectory">
<summary>
True if the entry is a directory (not a file).
This is a readonly property on the entry.
</summary>
</member>
<member name="P:Ionic.Zip.ZipEntry.UsesEncryption">
<summary>
A derived property that is <c>true</c> if the entry uses encryption.
</summary>
<remarks>
<para>
This is a readonly property on the entry. When reading a zip file,
the value for the <c>ZipEntry</c> is determined by the data read
from the zip file. After saving a ZipFile, the value of this
property for each <c>ZipEntry</c> indicates whether encryption was
actually used (which will have been true if the <see cref="P:Ionic.Zip.ZipEntry.Password"/> was set and the <see cref="P:Ionic.Zip.ZipEntry.Encryption"/> property
was something other than <see cref="F:Ionic.Zip.EncryptionAlgorithm.None"/>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.Encryption">
<summary>
Set this to specify which encryption algorithm to use for the entry when
saving it to a zip archive.
</summary>
<remarks>
<para>
Set this property in order to encrypt the entry when the <c>ZipFile</c> is
saved. When setting this property, you must also set a <see cref="P:Ionic.Zip.ZipEntry.Password"/> on the entry. If you set a value other than <see cref="F:Ionic.Zip.EncryptionAlgorithm.None"/> on this property and do not set a
<c>Password</c> then the entry will not be encrypted. The <c>ZipEntry</c>
data is encrypted as the <c>ZipFile</c> is saved, when you call <see cref="M:Ionic.Zip.ZipFile.Save"/> or one of its cousins on the containing
<c>ZipFile</c> instance. You do not need to specify the <c>Encryption</c>
when extracting entries from an archive.
</para>
<para>
The Zip specification from PKWare defines a set of encryption algorithms,
and the data formats for the zip archive that support them, and PKWare
supports those algorithms in the tools it produces. Other vendors of tools
and libraries, such as WinZip or Xceed, typically support <em>a
subset</em> of the algorithms specified by PKWare. These tools can
sometimes support additional different encryption algorithms and data
formats, not specified by PKWare. The AES Encryption specified and
supported by WinZip is the most popular example. This library supports a
subset of the complete set of algorithms specified by PKWare and other
vendors.
</para>
<para>
There is no common, ubiquitous multi-vendor standard for strong encryption
within zip files. There is broad support for so-called "traditional" Zip
encryption, sometimes called Zip 2.0 encryption, as <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">specified
by PKWare</see>, but this encryption is considered weak and
breakable. This library currently supports the Zip 2.0 "weak" encryption,
and also a stronger WinZip-compatible AES encryption, using either 128-bit
or 256-bit key strength. If you want DotNetZip to support an algorithm
that is not currently supported, call the author of this library and maybe
we can talk business.
</para>
<para>
The <see cref="T:Ionic.Zip.ZipFile"/> class also has a <see cref="P:Ionic.Zip.ZipFile.Encryption"/> property. In most cases you will use
<em>that</em> property when setting encryption. This property takes
precedence over any <c>Encryption</c> set on the <c>ZipFile</c> itself.
Typically, you would use the per-entry Encryption when most entries in the
zip archive use one encryption algorithm, and a few entries use a
different one. If all entries in the zip file use the same Encryption,
then it is simpler to just set this property on the ZipFile itself, when
creating a zip archive.
</para>
<para>
Some comments on updating archives: If you read a <c>ZipFile</c>, you can
modify the Encryption on an encrypted entry: you can remove encryption
from an entry that was encrypted; you can encrypt an entry that was not
encrypted previously; or, you can change the encryption algorithm. The
changes in encryption are not made permanent until you call Save() on the
<c>ZipFile</c>. To effect changes in encryption, the entry content is
streamed through several transformations, depending on the modification
the application has requested. For example if the entry is not encrypted
and the application sets <c>Encryption</c> to <c>PkzipWeak</c>, then at
the time of <c>Save()</c>, the original entry is read and decompressed,
then re-compressed and encrypted. Conversely, if the original entry is
encrypted with <c>PkzipWeak</c> encryption, and the application sets the
<c>Encryption</c> property to <c>WinZipAes128</c>, then at the time of
<c>Save()</c>, the original entry is decrypted via PKZIP encryption and
decompressed, then re-compressed and re-encrypted with AES. This all
happens automatically within the library, but it can be time-consuming for
large entries.
</para>
<para>
Additionally, when updating archives, it is not possible to change the
password when changing the encryption algorithm. To change both the
algorithm and the password, you need to Save() the zipfile twice. First
set the <c>Encryption</c> to None, then call <c>Save()</c>. Then set the
<c>Encryption</c> to the new value (not "None"), then call <c>Save()</c>
once again.
</para>
<para>
The WinZip AES encryption algorithms are not supported on the .NET Compact
Framework.
</para>
</remarks>
<example>
<para>
This example creates a zip archive that uses encryption, and then extracts
entries from the archive. When creating the zip archive, the ReadMe.txt
file is zipped without using a password or encryption. The other file
uses encryption.
</para>
<code>
// Create a zip archive with AES Encryption.
using (ZipFile zip = new ZipFile())
{
zip.AddFile("ReadMe.txt")
ZipEntry e1= zip.AddFile("2008-Regional-Sales-Report.pdf");
e1.Encryption= EncryptionAlgorithm.WinZipAes256;
e1.Password= "Top.Secret.No.Peeking!";
zip.Save("EncryptedArchive.zip");
}
// Extract a zip archive that uses AES Encryption.
// You do not need to specify the algorithm during extraction.
using (ZipFile zip = ZipFile.Read("EncryptedArchive.zip"))
{
// Specify the password that is used during extraction, for
// all entries that require a password:
zip.Password= "Top.Secret.No.Peeking!";
zip.ExtractAll("extractDirectory");
}
</code>
<code lang="VB">
' Create a zip that uses Encryption.
Using zip As New ZipFile()
zip.AddFile("ReadMe.txt")
Dim e1 as ZipEntry
e1= zip.AddFile("2008-Regional-Sales-Report.pdf")
e1.Encryption= EncryptionAlgorithm.WinZipAes256
e1.Password= "Top.Secret.No.Peeking!"
zip.Save("EncryptedArchive.zip")
End Using
' Extract a zip archive that uses AES Encryption.
' You do not need to specify the algorithm during extraction.
Using (zip as ZipFile = ZipFile.Read("EncryptedArchive.zip"))
' Specify the password that is used during extraction, for
' all entries that require a password:
zip.Password= "Top.Secret.No.Peeking!"
zip.ExtractAll("extractDirectory")
End Using
</code>
</example>
<exception cref="T:System.InvalidOperationException">
Thrown in the setter if EncryptionAlgorithm.Unsupported is specified.
</exception>
<seealso cref="P:Ionic.Zip.ZipEntry.Password">ZipEntry.Password</seealso>
<seealso cref="P:Ionic.Zip.ZipFile.Encryption">ZipFile.Encryption</seealso>
</member>
<member name="P:Ionic.Zip.ZipEntry.Password">
<summary>
The Password to be used when encrypting a <c>ZipEntry</c> upon
<c>ZipFile.Save()</c>, or when decrypting an entry upon Extract().
</summary>
<remarks>
<para>
This is a write-only property on the entry. Set this to request that the
entry be encrypted when writing the zip archive, or set it to specify the
password to be used when extracting an existing entry that is encrypted.
</para>
<para>
The password set here is implicitly used to encrypt the entry during the
<see cref="M:Ionic.Zip.ZipFile.Save"/> operation, or to decrypt during the <see cref="M:Ionic.Zip.ZipEntry.Extract"/> or <see cref="M:Ionic.Zip.ZipEntry.OpenReader"/> operation. If you set
the Password on a <c>ZipEntry</c> after calling <c>Save()</c>, there is no
effect.
</para>
<para>
Consider setting the <see cref="P:Ionic.Zip.ZipEntry.Encryption"/> property when using a
password. Answering concerns that the standard password protection
supported by all zip tools is weak, WinZip has extended the ZIP
specification with a way to use AES Encryption to protect entries in the
Zip file. Unlike the "PKZIP 2.0" encryption specified in the PKZIP
specification, <see href="http://en.wikipedia.org/wiki/Advanced_Encryption_Standard">AES
Encryption</see> uses a standard, strong, tested, encryption
algorithm. DotNetZip can create zip archives that use WinZip-compatible
AES encryption, if you set the <see cref="P:Ionic.Zip.ZipEntry.Encryption"/> property. But,
archives created that use AES encryption may not be readable by all other
tools and libraries. For example, Windows Explorer cannot read a
"compressed folder" (a zip file) that uses AES encryption, though it can
read a zip file that uses "PKZIP encryption."
</para>
<para>
The <see cref="T:Ionic.Zip.ZipFile"/> class also has a <see cref="P:Ionic.Zip.ZipFile.Password"/>
property. This property takes precedence over any password set on the
ZipFile itself. Typically, you would use the per-entry Password when most
entries in the zip archive use one password, and a few entries use a
different password. If all entries in the zip file use the same password,
then it is simpler to just set this property on the ZipFile itself,
whether creating a zip archive or extracting a zip archive.
</para>
<para>
Some comments on updating archives: If you read a <c>ZipFile</c>, you
cannot modify the password on any encrypted entry, except by extracting
the entry with the original password (if any), removing the original entry
via <see cref="M:Ionic.Zip.ZipFile.RemoveEntry(Ionic.Zip.ZipEntry)"/>, and then adding a new
entry with a new Password.
</para>
<para>
For example, suppose you read a <c>ZipFile</c>, and there is an encrypted
entry. Setting the Password property on that <c>ZipEntry</c> and then
calling <c>Save()</c> on the <c>ZipFile</c> does not update the password
on that entry in the archive. Neither is an exception thrown. Instead,
what happens during the <c>Save()</c> is the existing entry is copied
through to the new zip archive, in its original encrypted form. Upon
re-reading that archive, the entry can be decrypted with its original
password.
</para>
<para>
If you read a ZipFile, and there is an un-encrypted entry, you can set the
<c>Password</c> on the entry and then call Save() on the ZipFile, and get
encryption on that entry.
</para>
</remarks>
<example>
<para>
This example creates a zip file with two entries, and then extracts the
entries from the zip file. When creating the zip file, the two files are
added to the zip file using password protection. Each entry uses a
different password. During extraction, each file is extracted with the
appropriate password.
</para>
<code>
// create a file with encryption
using (ZipFile zip = new ZipFile())
{
ZipEntry entry;
entry= zip.AddFile("Declaration.txt");
entry.Password= "123456!";
entry = zip.AddFile("Report.xls");
entry.Password= "1Secret!";
zip.Save("EncryptedArchive.zip");
}
// extract entries that use encryption
using (ZipFile zip = ZipFile.Read("EncryptedArchive.zip"))
{
ZipEntry entry;
entry = zip["Declaration.txt"];
entry.Password = "123456!";
entry.Extract("extractDir");
entry = zip["Report.xls"];
entry.Password = "1Secret!";
entry.Extract("extractDir");
}
</code>
<code lang="VB">
Using zip As New ZipFile
Dim entry as ZipEntry
entry= zip.AddFile("Declaration.txt")
entry.Password= "123456!"
entry = zip.AddFile("Report.xls")
entry.Password= "1Secret!"
zip.Save("EncryptedArchive.zip")
End Using
' extract entries that use encryption
Using (zip as ZipFile = ZipFile.Read("EncryptedArchive.zip"))
Dim entry as ZipEntry
entry = zip("Declaration.txt")
entry.Password = "123456!"
entry.Extract("extractDir")
entry = zip("Report.xls")
entry.Password = "1Secret!"
entry.Extract("extractDir")
End Using
</code>
</example>
<seealso cref="P:Ionic.Zip.ZipEntry.Encryption"/>
<seealso cref="P:Ionic.Zip.ZipFile.Password">ZipFile.Password</seealso>
</member>
<member name="P:Ionic.Zip.ZipEntry.ExtractExistingFile">
<summary>
The action the library should take when extracting a file that already exists.
</summary>
<remarks>
<para>
This property affects the behavior of the Extract methods (one of the
<c>Extract()</c> or <c>ExtractWithPassword()</c> overloads), when
extraction would would overwrite an existing filesystem file. If you do
not set this property, the library throws an exception when extracting
an entry would overwrite an existing file.
</para>
<para>
This property has no effect when extracting to a stream, or when the file to be
extracted does not already exist.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>
<example>
This example shows how to set the <c>ExtractExistingFile</c> property in
an <c>ExtractProgress</c> event, in response to user input. The
<c>ExtractProgress</c> event is invoked if and only if the
<c>ExtractExistingFile</c> property was previously set to
<c>ExtractExistingFileAction.InvokeExtractProgressEvent</c>.
<code lang="C#">
public static void ExtractProgress(object sender, ExtractProgressEventArgs e)
{
if (e.EventType == ZipProgressEventType.Extracting_BeforeExtractEntry)
Console.WriteLine("extract {0} ", e.CurrentEntry.FileName);
else if (e.EventType == ZipProgressEventType.Extracting_ExtractEntryWouldOverwrite)
{
ZipEntry entry = e.CurrentEntry;
string response = null;
// Ask the user if he wants overwrite the file
do
{
Console.Write("Overwrite {0} in {1} ? (y/n/C) ", entry.FileName, e.ExtractLocation);
response = Console.ReadLine();
Console.WriteLine();
} while (response != null && response[0]!='Y' &&
response[0]!='N' && response[0]!='C');
if (response[0]=='C')
e.Cancel = true;
else if (response[0]=='Y')
entry.ExtractExistingFile = ExtractExistingFileAction.OverwriteSilently;
else
entry.ExtractExistingFile= ExtractExistingFileAction.DoNotOverwrite;
}
}
</code>
</example>
</member>
<member name="P:Ionic.Zip.ZipEntry.ZipErrorAction">
<summary>
The action to take when an error is encountered while
opening or reading files as they are saved into a zip archive.
</summary>
<remarks>
<para>
Errors can occur within a call to <see cref="M:Ionic.Zip.ZipFile.Save">ZipFile.Save</see>, as the various files contained
in a ZipFile are being saved into the zip archive. During the
<c>Save</c>, DotNetZip will perform a <c>File.Open</c> on the file
associated to the ZipEntry, and then will read the entire contents of
the file as it is zipped. Either the open or the Read may fail, because
of lock conflicts or other reasons. Using this property, you can
specify the action to take when such errors occur.
</para>
<para>
Typically you will NOT set this property on individual ZipEntry
instances. Instead, you will set the <see cref="P:Ionic.Zip.ZipFile.ZipErrorAction">ZipFile.ZipErrorAction</see> property on
the ZipFile instance, before adding any entries to the
<c>ZipFile</c>. If you do this, errors encountered on behalf of any of
the entries in the ZipFile will be handled the same way.
</para>
<para>
But, if you use a <see cref="E:Ionic.Zip.ZipFile.ZipError"/> handler, you will want
to set this property on the <c>ZipEntry</c> within the handler, to
communicate back to DotNetZip what you would like to do with the
particular error.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>
<seealso cref="E:Ionic.Zip.ZipFile.ZipError"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.IncludedInMostRecentSave">
<summary>
Indicates whether the entry was included in the most recent save.
</summary>
<remarks>
An entry can be excluded or skipped from a save if there is an error
opening or reading the entry.
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.ZipErrorAction"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.SetCompression">
<summary>
A callback that allows the application to specify the compression to use
for a given entry that is about to be added to the zip archive.
</summary>
<remarks>
<para>
See <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.UseUnicodeAsNecessary">
<summary>
Set to indicate whether to use UTF-8 encoding for filenames and comments.
</summary>
<remarks>
<para>
If this flag is set, the comment and filename for the entry will be
encoded with UTF-8, as described in <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">the Zip
specification</see>, if necessary. "Necessary" means, the filename or
entry comment (if any) cannot be reflexively encoded and decoded using the
default code page, IBM437.
</para>
<para>
Setting this flag to true is equivalent to setting <see cref="P:Ionic.Zip.ZipEntry.ProvisionalAlternateEncoding"/> to <c>System.Text.Encoding.UTF8</c>.
</para>
<para>
This flag has no effect or relation to the text encoding used within the
file itself.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.ProvisionalAlternateEncoding">
<summary>
The text encoding to use for the FileName and Comment on this ZipEntry,
when the default encoding is insufficient.
</summary>
<remarks>
<para>
Don't use this property. See <see cref="P:Ionic.Zip.ZipEntry.AlternateEncoding"/>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipEntry.AlternateEncoding">
<summary>
Specifies the alternate text encoding used by this ZipEntry
</summary>
<remarks>
<para>
The default text encoding used in Zip files for encoding filenames and
comments is IBM437, which is something like a superset of ASCII. In
cases where this is insufficient, applications can specify an
alternate encoding.
</para>
<para>
When creating a zip file, the usage of the alternate encoding is
governed by the <see cref="P:Ionic.Zip.ZipEntry.AlternateEncodingUsage"/> property.
Typically you would set both properties to tell DotNetZip to employ an
encoding that is not IBM437 in the zipfile you are creating.
</para>
<para>
Keep in mind that because the ZIP specification states that the only
valid encodings to use are IBM437 and UTF-8, if you use something
other than that, then zip tools and libraries may not be able to
successfully read the zip archive you generate.
</para>
<para>
The zip specification states that applications should presume that
IBM437 is in use, except when a special bit is set, which indicates
UTF-8. There is no way to specify an arbitrary code page, within the
zip file itself. When you create a zip file encoded with gb2312 or
ibm861 or anything other than IBM437 or UTF-8, then the application
that reads the zip file needs to "know" which code page to use. In
some cases, the code page used when reading is chosen implicitly. For
example, WinRar uses the ambient code page for the host desktop
operating system. The pitfall here is that if you create a zip in
Copenhagen and send it to Tokyo, the reader of the zipfile may not be
able to decode successfully.
</para>
</remarks>
<example>
This example shows how to create a zipfile encoded with a
language-specific encoding:
<code>
using (var zip = new ZipFile())
{
zip.AlternateEnoding = System.Text.Encoding.GetEncoding("ibm861");
zip.AlternateEnodingUsage = ZipOption.Always;
zip.AddFileS(arrayOfFiles);
zip.Save("Myarchive-Encoded-in-IBM861.zip");
}
</code>
</example>
<seealso cref="P:Ionic.Zip.ZipFile.AlternateEncodingUsage"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.AlternateEncodingUsage">
<summary>
Describes if and when this instance should apply
AlternateEncoding to encode the FileName and Comment, when
saving.
</summary>
<seealso cref="P:Ionic.Zip.ZipFile.AlternateEncoding"/>
</member>
<member name="P:Ionic.Zip.ZipEntry.IsText">
<summary>
Indicates whether an entry is marked as a text file. Be careful when
using on this property. Unless you have a good reason, you should
probably ignore this property.
</summary>
<remarks>
<para>
The ZIP format includes a provision for specifying whether an entry in
the zip archive is a text or binary file. This property exposes that
metadata item. Be careful when using this property: It's not clear
that this property as a firm meaning, across tools and libraries.
</para>
<para>
To be clear, when reading a zip file, the property value may or may
not be set, and its value may or may not be valid. Not all entries
that you may think of as "text" entries will be so marked, and entries
marked as "text" are not guaranteed in any way to be text entries.
Whether the value is set and set correctly depends entirely on the
application that produced the zip file.
</para>
<para>
There are many zip tools available, and when creating zip files, some
of them "respect" the IsText metadata field, and some of them do not.
Unfortunately, even when an application tries to do "the right thing",
it's not always clear what "the right thing" is.
</para>
<para>
There's no firm definition of just what it means to be "a text file",
and the zip specification does not help in this regard. Twenty years
ago, text was ASCII, each byte was less than 127. IsText meant, all
bytes in the file were less than 127. These days, it is not the case
that all text files have all bytes less than 127. Any unicode file
may have bytes that are above 0x7f. The zip specification has nothing
to say on this topic. Therefore, it's not clear what IsText really
means.
</para>
<para>
This property merely tells a reading application what is stored in the
metadata for an entry, without guaranteeing its validity or its
meaning.
</para>
<para>
When DotNetZip is used to create a zipfile, it attempts to set this
field "correctly." For example, if a file ends in ".txt", this field
will be set. Your application may override that default setting. When
writing a zip file, you must set the property before calling
<c>Save()</c> on the ZipFile.
</para>
<para>
When reading a zip file, a more general way to decide just what kind
of file is contained in a particular entry is to use the file type
database stored in the operating system. The operating system stores
a table that says, a file with .jpg extension is a JPG image file, a
file with a .xml extension is an XML document, a file with a .txt is a
pure ASCII text document, and so on. To get this information on
Windows, <see
href="http://www.codeproject.com/KB/cs/GetFileTypeAndIcon.aspx"> you
need to read and parse the registry.</see> </para>
</remarks>
<example>
<code>
using (var zip = new ZipFile())
{
var e = zip.UpdateFile("Descriptions.mme", "");
e.IsText = true;
zip.Save(zipPath);
}
</code>
<code lang="VB">
Using zip As New ZipFile
Dim e2 as ZipEntry = zip.AddFile("Descriptions.mme", "")
e.IsText= True
zip.Save(zipPath)
End Using
</code>
</example>
</member>
<member name="T:Ionic.Zip.ZipEntryTimestamp">
<summary>
An enum that specifies the type of timestamp available on the ZipEntry.
</summary>
<remarks>
<para>
The last modified time of a file can be stored in multiple ways in
a zip file, and they are not mutually exclusive:
</para>
<list type="bullet">
<item>
In the so-called "DOS" format, which has a 2-second precision. Values
are rounded to the nearest even second. For example, if the time on the
file is 12:34:43, then it will be stored as 12:34:44. This first value
is accessible via the <c>LastModified</c> property. This value is always
present in the metadata for each zip entry. In some cases the value is
invalid, or zero.
</item>
<item>
In the so-called "Windows" or "NTFS" format, as an 8-byte integer
quantity expressed as the number of 1/10 milliseconds (in other words
the number of 100 nanosecond units) since January 1, 1601 (UTC). This
format is how Windows represents file times. This time is accessible
via the <c>ModifiedTime</c> property.
</item>
<item>
In the "Unix" format, a 4-byte quantity specifying the number of seconds since
January 1, 1970 UTC.
</item>
<item>
In an older format, now deprecated but still used by some current
tools. This format is also a 4-byte quantity specifying the number of
seconds since January 1, 1970 UTC.
</item>
</list>
<para>
This bit field describes which of the formats were found in a <c>ZipEntry</c> that was read.
</para>
</remarks>
</member>
<member name="F:Ionic.Zip.ZipEntryTimestamp.None">
<summary>
Default value.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntryTimestamp.DOS">
<summary>
A DOS timestamp with 2-second precision.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntryTimestamp.Windows">
<summary>
A Windows timestamp with 100-ns precision.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntryTimestamp.Unix">
<summary>
A Unix timestamp with 1-second precision.
</summary>
</member>
<member name="F:Ionic.Zip.ZipEntryTimestamp.InfoZip1">
<summary>
A Unix timestamp with 1-second precision, stored in InfoZip v1 format. This
format is outdated and is supported for reading archives only.
</summary>
</member>
<member name="T:Ionic.Zip.CompressionMethod">
<summary>
The method of compression to use for a particular ZipEntry.
</summary>
<remarks>
<see
href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWare's
ZIP Specification</see> describes a number of distinct
cmopression methods that can be used within a zip
file. DotNetZip supports a subset of them.
</remarks>
</member>
<member name="F:Ionic.Zip.CompressionMethod.None">
<summary>
No compression at all. For COM environments, the value is 0 (zero).
</summary>
</member>
<member name="F:Ionic.Zip.CompressionMethod.Deflate">
<summary>
DEFLATE compression, as described in <see
href="http://www.ietf.org/rfc/rfc1951.txt">IETF RFC
1951</see>. This is the "normal" compression used in zip
files. For COM environments, the value is 8.
</summary>
</member>
<member name="F:Ionic.Zip.CompressionMethod.BZip2">
<summary>
BZip2 compression, a compression algorithm developed by Julian Seward.
For COM environments, the value is 12.
</summary>
</member>
<member name="T:Ionic.Zip.ZipFile">
<summary>
The ZipFile type represents a zip archive file.
</summary>
<remarks>
<para>
This is the main type in the DotNetZip class library. This class reads and
writes zip files, as defined in the <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">specification
for zip files described by PKWare</see>. The compression for this
implementation is provided by a managed-code version of Zlib, included with
DotNetZip in the classes in the Ionic.Zlib namespace.
</para>
<para>
This class provides a general purpose zip file capability. Use it to read,
create, or update zip files. When you want to create zip files using a
<c>Stream</c> type to write the zip file, you may want to consider the <see cref="T:Ionic.Zip.ZipOutputStream"/> class.
</para>
<para>
Both the <c>ZipOutputStream</c> class and the <c>ZipFile</c> class can
be used to create zip files. Both of them support many of the common zip
features, including Unicode, different compression methods and levels,
and ZIP64. They provide very similar performance when creating zip
files.
</para>
<para>
The <c>ZipFile</c> class is generally easier to use than
<c>ZipOutputStream</c> and should be considered a higher-level interface. For
example, when creating a zip file via calls to the <c>PutNextEntry()</c> and
<c>Write()</c> methods on the <c>ZipOutputStream</c> class, the caller is
responsible for opening the file, reading the bytes from the file, writing
those bytes into the <c>ZipOutputStream</c>, setting the attributes on the
<c>ZipEntry</c>, and setting the created, last modified, and last accessed
timestamps on the zip entry. All of these things are done automatically by a
call to <see cref="M:Ionic.Zip.ZipFile.AddFile(System.String,System.String)">ZipFile.AddFile()</see>.
For this reason, the <c>ZipOutputStream</c> is generally recommended for use
only when your application emits arbitrary data, not necessarily data from a
filesystem file, directly into a zip file, and does so using a <c>Stream</c>
metaphor.
</para>
<para>
Aside from the differences in programming model, there are other
differences in capability between the two classes.
</para>
<list type="bullet">
<item>
<c>ZipFile</c> can be used to read and extract zip files, in addition to
creating zip files. <c>ZipOutputStream</c> cannot read zip files. If you want
to use a stream to read zip files, check out the <see cref="T:Ionic.Zip.ZipInputStream"/> class.
</item>
<item>
<c>ZipOutputStream</c> does not support the creation of segmented or spanned
zip files.
</item>
<item>
<c>ZipOutputStream</c> cannot produce a self-extracting archive.
</item>
</list>
<para>
Be aware that the <c>ZipFile</c> class implements the <see cref="T:System.IDisposable"/> interface. In order for <c>ZipFile</c> to
produce a valid zip file, you use use it within a using clause (<c>Using</c>
in VB), or call the <c>Dispose()</c> method explicitly. See the examples
for how to employ a using clause.
</para>
</remarks>
</member>
<member name="M:Ionic.Zip.ZipFile.AddItem(System.String)">
<summary>
Adds an item, either a file or a directory, to a zip file archive.
</summary>
<remarks>
<para>
This method is handy if you are adding things to zip archive and don't
want to bother distinguishing between directories or files. Any files are
added as single entries. A directory added through this method is added
recursively: all files and subdirectories contained within the directory
are added to the <c>ZipFile</c>.
</para>
<para>
The name of the item may be a relative path or a fully-qualified
path. Remember, the items contained in <c>ZipFile</c> instance get written
to the disk only when you call <see cref="M:Ionic.Zip.ZipFile.Save"/> or a similar
save method.
</para>
<para>
The directory name used for the file within the archive is the same
as the directory name (potentially a relative path) specified in the
<paramref name="fileOrDirectoryName"/>.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.AddFile(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.AddDirectory(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateItem(System.String)"/>
<overloads>This method has two overloads.</overloads>
<param name="fileOrDirectoryName">
the name of the file or directory to add.</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.AddItem(System.String,System.String)">
<summary>
Adds an item, either a file or a directory, to a zip file archive,
explicitly specifying the directory path to be used in the archive.
</summary>
<remarks>
<para>
If adding a directory, the add is recursive on all files and
subdirectories contained within it.
</para>
<para>
The name of the item may be a relative path or a fully-qualified path.
The item added by this call to the <c>ZipFile</c> is not read from the
disk nor written to the zip file archive until the application calls
Save() on the <c>ZipFile</c>.
</para>
<para>
This version of the method allows the caller to explicitly specify the
directory path to be used in the archive, which would override the
"natural" path of the filesystem file.
</para>
<para>
Encryption will be used on the file data if the <c>Password</c> has
been set on the <c>ZipFile</c> object, prior to calling this method.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<exception cref="T:System.IO.FileNotFoundException">
Thrown if the file or directory passed in does not exist.
</exception>
<param name="fileOrDirectoryName">the name of the file or directory to add.
</param>
<param name="directoryPathInArchive">
The name of the directory path to use within the zip archive. This path
need not refer to an extant directory in the current filesystem. If the
files within the zip are later extracted, this is the path used for the
extracted file. Passing <c>null</c> (<c>Nothing</c> in VB) will use the
path on the fileOrDirectoryName. Passing the empty string ("") will
insert the item at the root path within the archive.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.AddFile(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.AddDirectory(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateItem(System.String,System.String)"/>
<example>
This example shows how to zip up a set of files into a flat hierarchy,
regardless of where in the filesystem the files originated. The resulting
zip archive will contain a toplevel directory named "flat", which itself
will contain files Readme.txt, MyProposal.docx, and Image1.jpg. A
subdirectory under "flat" called SupportFiles will contain all the files
in the "c:\SupportFiles" directory on disk.
<code>
String[] itemnames= {
"c:\\fixedContent\\Readme.txt",
"MyProposal.docx",
"c:\\SupportFiles", // a directory
"images\\Image1.jpg"
};
try
{
using (ZipFile zip = new ZipFile())
{
for (int i = 1; i < itemnames.Length; i++)
{
// will add Files or Dirs, recurses and flattens subdirectories
zip.AddItem(itemnames[i],"flat");
}
zip.Save(ZipToCreate);
}
}
catch (System.Exception ex1)
{
System.Console.Error.WriteLine("exception: {0}", ex1);
}
</code>
<code lang="VB">
Dim itemnames As String() = _
New String() { "c:\fixedContent\Readme.txt", _
"MyProposal.docx", _
"SupportFiles", _
"images\Image1.jpg" }
Try
Using zip As New ZipFile
Dim i As Integer
For i = 1 To itemnames.Length - 1
' will add Files or Dirs, recursing and flattening subdirectories.
zip.AddItem(itemnames(i), "flat")
Next i
zip.Save(ZipToCreate)
End Using
Catch ex1 As Exception
Console.Error.WriteLine("exception: {0}", ex1.ToString())
End Try
</code>
</example>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.AddFile(System.String)">
<summary>
Adds a File to a Zip file archive.
</summary>
<remarks>
<para>
This call collects metadata for the named file in the filesystem,
including the file attributes and the timestamp, and inserts that metadata
into the resulting ZipEntry. Only when the application calls Save() on
the <c>ZipFile</c>, does DotNetZip read the file from the filesystem and
then write the content to the zip file archive.
</para>
<para>
This method will throw an exception if an entry with the same name already
exists in the <c>ZipFile</c>.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<example>
<para>
In this example, three files are added to a Zip archive. The ReadMe.txt
file will be placed in the root of the archive. The .png file will be
placed in a folder within the zip called photos\personal. The pdf file
will be included into a folder within the zip called Desktop.
</para>
<code>
try
{
using (ZipFile zip = new ZipFile())
{
zip.AddFile("c:\\photos\\personal\\7440-N49th.png");
zip.AddFile("c:\\Desktop\\2008-Regional-Sales-Report.pdf");
zip.AddFile("ReadMe.txt");
zip.Save("Package.zip");
}
}
catch (System.Exception ex1)
{
System.Console.Error.WriteLine("exception: " + ex1);
}
</code>
<code lang="VB">
Try
Using zip As ZipFile = New ZipFile
zip.AddFile("c:\photos\personal\7440-N49th.png")
zip.AddFile("c:\Desktop\2008-Regional-Sales-Report.pdf")
zip.AddFile("ReadMe.txt")
zip.Save("Package.zip")
End Using
Catch ex1 As Exception
Console.Error.WriteLine("exception: {0}", ex1.ToString)
End Try
</code>
</example>
<overloads>This method has two overloads.</overloads>
<seealso cref="M:Ionic.Zip.ZipFile.AddItem(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.AddDirectory(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateFile(System.String)"/>
<param name="fileName">
The name of the file to add. It should refer to a file in the filesystem.
The name of the file may be a relative path or a fully-qualified path.
</param>
<returns>The <c>ZipEntry</c> corresponding to the File added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.AddFile(System.String,System.String)">
<summary>
Adds a File to a Zip file archive, potentially overriding the path to be
used within the zip archive.
</summary>
<remarks>
<para>
The file added by this call to the <c>ZipFile</c> is not written to the
zip file archive until the application calls Save() on the <c>ZipFile</c>.
</para>
<para>
This method will throw an exception if an entry with the same name already
exists in the <c>ZipFile</c>.
</para>
<para>
This version of the method allows the caller to explicitly specify the
directory path to be used in the archive.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<example>
<para>
In this example, three files are added to a Zip archive. The ReadMe.txt
file will be placed in the root of the archive. The .png file will be
placed in a folder within the zip called images. The pdf file will be
included into a folder within the zip called files\docs, and will be
encrypted with the given password.
</para>
<code>
try
{
using (ZipFile zip = new ZipFile())
{
// the following entry will be inserted at the root in the archive.
zip.AddFile("c:\\datafiles\\ReadMe.txt", "");
// this image file will be inserted into the "images" directory in the archive.
zip.AddFile("c:\\photos\\personal\\7440-N49th.png", "images");
// the following will result in a password-protected file called
// files\\docs\\2008-Regional-Sales-Report.pdf in the archive.
zip.Password = "EncryptMe!";
zip.AddFile("c:\\Desktop\\2008-Regional-Sales-Report.pdf", "files\\docs");
zip.Save("Archive.zip");
}
}
catch (System.Exception ex1)
{
System.Console.Error.WriteLine("exception: {0}", ex1);
}
</code>
<code lang="VB">
Try
Using zip As ZipFile = New ZipFile
' the following entry will be inserted at the root in the archive.
zip.AddFile("c:\datafiles\ReadMe.txt", "")
' this image file will be inserted into the "images" directory in the archive.
zip.AddFile("c:\photos\personal\7440-N49th.png", "images")
' the following will result in a password-protected file called
' files\\docs\\2008-Regional-Sales-Report.pdf in the archive.
zip.Password = "EncryptMe!"
zip.AddFile("c:\Desktop\2008-Regional-Sales-Report.pdf", "files\documents")
zip.Save("Archive.zip")
End Using
Catch ex1 As Exception
Console.Error.WriteLine("exception: {0}", ex1)
End Try
</code>
</example>
<seealso cref="M:Ionic.Zip.ZipFile.AddItem(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.AddDirectory(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateFile(System.String,System.String)"/>
<param name="fileName">
The name of the file to add. The name of the file may be a relative path
or a fully-qualified path.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to override any path in the fileName.
This path may, or may not, correspond to a real directory in the current
filesystem. If the files within the zip are later extracted, this is the
path used for the extracted file. Passing <c>null</c> (<c>Nothing</c> in
VB) will use the path on the fileName, if any. Passing the empty string
("") will insert the item at the root path within the archive.
</param>
<returns>The <c>ZipEntry</c> corresponding to the file added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.RemoveEntries(System.Collections.Generic.ICollection{Ionic.Zip.ZipEntry})">
<summary>
This method removes a collection of entries from the <c>ZipFile</c>.
</summary>
<param name="entriesToRemove">
A collection of ZipEntry instances from this zip file to be removed. For
example, you can pass in an array of ZipEntry instances; or you can call
SelectEntries(), and then add or remove entries from that
ICollection<ZipEntry> (ICollection(Of ZipEntry) in VB), and pass
that ICollection to this method.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.SelectEntries(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.RemoveSelectedEntries(System.String)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.RemoveEntries(System.Collections.Generic.ICollection{System.String})">
<summary>
This method removes a collection of entries from the <c>ZipFile</c>, by name.
</summary>
<param name="entriesToRemove">
A collection of strings that refer to names of entries to be removed
from the <c>ZipFile</c>. For example, you can pass in an array or a
List of Strings that provide the names of entries to be removed.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.SelectEntries(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.RemoveSelectedEntries(System.String)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.AddFiles(System.Collections.Generic.IEnumerable{System.String})">
<summary>
This method adds a set of files to the <c>ZipFile</c>.
</summary>
<remarks>
<para>
Use this method to add a set of files to the zip archive, in one call.
For example, a list of files received from
<c>System.IO.Directory.GetFiles()</c> can be added to a zip archive in one
call.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to each
ZipEntry added.
</para>
</remarks>
<param name="fileNames">
The collection of names of the files to add. Each string should refer to a
file in the filesystem. The name of the file may be a relative path or a
fully-qualified path.
</param>
<example>
This example shows how to create a zip file, and add a few files into it.
<code>
String ZipFileToCreate = "archive1.zip";
String DirectoryToZip = "c:\\reports";
using (ZipFile zip = new ZipFile())
{
// Store all files found in the top level directory, into the zip archive.
String[] filenames = System.IO.Directory.GetFiles(DirectoryToZip);
zip.AddFiles(filenames);
zip.Save(ZipFileToCreate);
}
</code>
<code lang="VB">
Dim ZipFileToCreate As String = "archive1.zip"
Dim DirectoryToZip As String = "c:\reports"
Using zip As ZipFile = New ZipFile
' Store all files found in the top level directory, into the zip archive.
Dim filenames As String() = System.IO.Directory.GetFiles(DirectoryToZip)
zip.AddFiles(filenames)
zip.Save(ZipFileToCreate)
End Using
</code>
</example>
<seealso cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateFiles(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Adds or updates a set of files in the <c>ZipFile</c>.
</summary>
<remarks>
<para>
Any files that already exist in the archive are updated. Any files that
don't yet exist in the archive are added.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to each
ZipEntry added.
</para>
</remarks>
<param name="fileNames">
The collection of names of the files to update. Each string should refer to a file in
the filesystem. The name of the file may be a relative path or a fully-qualified path.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.AddFiles(System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Adds a set of files to the <c>ZipFile</c>, using the
specified directory path in the archive.
</summary>
<remarks>
<para>
Any directory structure that may be present in the
filenames contained in the list is "flattened" in the
archive. Each file in the list is added to the archive in
the specified top-level directory.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>, <see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their respective values at the
time of this call will be applied to each ZipEntry added.
</para>
</remarks>
<param name="fileNames">
The names of the files to add. Each string should refer to
a file in the filesystem. The name of the file may be a
relative path or a fully-qualified path.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to override any path in the file name.
Th is path may, or may not, correspond to a real directory in the current
filesystem. If the files within the zip are later extracted, this is the
path used for the extracted file. Passing <c>null</c> (<c>Nothing</c> in
VB) will use the path on each of the <c>fileNames</c>, if any. Passing
the empty string ("") will insert the item at the root path within the
archive.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.AddFiles(System.Collections.Generic.IEnumerable{System.String},System.Boolean,System.String)">
<summary>
Adds a set of files to the <c>ZipFile</c>, using the specified directory
path in the archive, and preserving the full directory structure in the
filenames.
</summary>
<remarks>
<para>
If preserveDirHierarchy is true, any directory structure present in the
filenames contained in the list is preserved in the archive. On the other
hand, if preserveDirHierarchy is false, any directory structure that may
be present in the filenames contained in the list is "flattened" in the
archive; Each file in the list is added to the archive in the specified
top-level directory.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to each
ZipEntry added.
</para>
</remarks>
<param name="fileNames">
The names of the files to add. Each string should refer to a file in the
filesystem. The name of the file may be a relative path or a
fully-qualified path.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to override any path in the file name.
This path may, or may not, correspond to a real directory in the current
filesystem. If the files within the zip are later extracted, this is the
path used for the extracted file. Passing <c>null</c> (<c>Nothing</c> in
VB) will use the path on each of the <c>fileNames</c>, if any. Passing
the empty string ("") will insert the item at the root path within the
archive.
</param>
<param name="preserveDirHierarchy">
whether the entries in the zip archive will reflect the directory
hierarchy that is present in the various filenames. For example, if <paramref name="fileNames"/>
includes two paths, \Animalia\Chordata\Mammalia\Info.txt and
\Plantae\Magnoliophyta\Dicotyledon\Info.txt, then calling this method with
<paramref name="preserveDirHierarchy"/> = <c>false</c> will result in an
exception because of a duplicate entry name, while calling this method
with <paramref name="preserveDirHierarchy"/> = <c>true</c> will result in the
full direcory paths being included in the entries added to the ZipFile.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateFiles(System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Adds or updates a set of files to the <c>ZipFile</c>, using the specified
directory path in the archive.
</summary>
<remarks>
<para>
Any files that already exist in the archive are updated. Any files that
don't yet exist in the archive are added.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to each
ZipEntry added.
</para>
</remarks>
<param name="fileNames">
The names of the files to add or update. Each string should refer to a
file in the filesystem. The name of the file may be a relative path or a
fully-qualified path.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to override any path in the file name.
This path may, or may not, correspond to a real directory in the current
filesystem. If the files within the zip are later extracted, this is the
path used for the extracted file. Passing <c>null</c> (<c>Nothing</c> in
VB) will use the path on each of the <c>fileNames</c>, if any. Passing
the empty string ("") will insert the item at the root path within the
archive.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateFile(System.String)">
<summary>
Adds or Updates a File in a Zip file archive.
</summary>
<remarks>
<para>
This method adds a file to a zip archive, or, if the file already exists
in the zip archive, this method Updates the content of that given filename
in the zip archive. The <c>UpdateFile</c> method might more accurately be
called "AddOrUpdateFile".
</para>
<para>
Upon success, there is no way for the application to learn whether the file
was added versus updated.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<example>
This example shows how to Update an existing entry in a zipfile. The first
call to UpdateFile adds the file to the newly-created zip archive. The
second call to UpdateFile updates the content for that file in the zip
archive.
<code>
using (ZipFile zip1 = new ZipFile())
{
// UpdateFile might more accurately be called "AddOrUpdateFile"
zip1.UpdateFile("MyDocuments\\Readme.txt");
zip1.UpdateFile("CustomerList.csv");
zip1.Comment = "This zip archive has been created.";
zip1.Save("Content.zip");
}
using (ZipFile zip2 = ZipFile.Read("Content.zip"))
{
zip2.UpdateFile("Updates\\Readme.txt");
zip2.Comment = "This zip archive has been updated: The Readme.txt file has been changed.";
zip2.Save();
}
</code>
<code lang="VB">
Using zip1 As New ZipFile
' UpdateFile might more accurately be called "AddOrUpdateFile"
zip1.UpdateFile("MyDocuments\Readme.txt")
zip1.UpdateFile("CustomerList.csv")
zip1.Comment = "This zip archive has been created."
zip1.Save("Content.zip")
End Using
Using zip2 As ZipFile = ZipFile.Read("Content.zip")
zip2.UpdateFile("Updates\Readme.txt")
zip2.Comment = "This zip archive has been updated: The Readme.txt file has been changed."
zip2.Save
End Using
</code>
</example>
<seealso cref="M:Ionic.Zip.ZipFile.AddFile(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateDirectory(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateItem(System.String)"/>
<param name="fileName">
The name of the file to add or update. It should refer to a file in the
filesystem. The name of the file may be a relative path or a
fully-qualified path.
</param>
<returns>
The <c>ZipEntry</c> corresponding to the File that was added or updated.
</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateFile(System.String,System.String)">
<summary>
Adds or Updates a File in a Zip file archive.
</summary>
<remarks>
<para>
This method adds a file to a zip archive, or, if the file already exists
in the zip archive, this method Updates the content of that given filename
in the zip archive.
</para>
<para>
This version of the method allows the caller to explicitly specify the
directory path to be used in the archive. The entry to be added or
updated is found by using the specified directory path, combined with the
basename of the specified filename.
</para>
<para>
Upon success, there is no way for the application to learn if the file was
added versus updated.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.AddFile(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateDirectory(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateItem(System.String,System.String)"/>
<param name="fileName">
The name of the file to add or update. It should refer to a file in the
filesystem. The name of the file may be a relative path or a
fully-qualified path.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to override any path in the
<c>fileName</c>. This path may, or may not, correspond to a real
directory in the current filesystem. If the files within the zip are
later extracted, this is the path used for the extracted file. Passing
<c>null</c> (<c>Nothing</c> in VB) will use the path on the
<c>fileName</c>, if any. Passing the empty string ("") will insert the
item at the root path within the archive.
</param>
<returns>
The <c>ZipEntry</c> corresponding to the File that was added or updated.
</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateDirectory(System.String)">
<summary>
Add or update a directory in a zip archive.
</summary>
<remarks>
If the specified directory does not exist in the archive, then this method
is equivalent to calling <c>AddDirectory()</c>. If the specified
directory already exists in the archive, then this method updates any
existing entries, and adds any new entries. Any entries that are in the
zip archive but not in the specified directory, are left alone. In other
words, the contents of the zip file will be a union of the previous
contents and the new files.
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateFile(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.AddDirectory(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateItem(System.String)"/>
<param name="directoryName">
The path to the directory to be added to the zip archive, or updated in
the zip archive.
</param>
<returns>
The <c>ZipEntry</c> corresponding to the Directory that was added or updated.
</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateDirectory(System.String,System.String)">
<summary>
Add or update a directory in the zip archive at the specified root
directory in the archive.
</summary>
<remarks>
If the specified directory does not exist in the archive, then this method
is equivalent to calling <c>AddDirectory()</c>. If the specified
directory already exists in the archive, then this method updates any
existing entries, and adds any new entries. Any entries that are in the
zip archive but not in the specified directory, are left alone. In other
words, the contents of the zip file will be a union of the previous
contents and the new files.
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateFile(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.AddDirectory(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateItem(System.String,System.String)"/>
<param name="directoryName">
The path to the directory to be added to the zip archive, or updated
in the zip archive.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to override any path in the
<c>directoryName</c>. This path may, or may not, correspond to a real
directory in the current filesystem. If the files within the zip are
later extracted, this is the path used for the extracted file. Passing
<c>null</c> (<c>Nothing</c> in VB) will use the path on the
<c>directoryName</c>, if any. Passing the empty string ("") will insert
the item at the root path within the archive.
</param>
<returns>
The <c>ZipEntry</c> corresponding to the Directory that was added or updated.
</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateItem(System.String)">
<summary>
Add or update a file or directory in the zip archive.
</summary>
<remarks>
<para>
This is useful when the application is not sure or does not care if the
item to be added is a file or directory, and does not know or does not
care if the item already exists in the <c>ZipFile</c>. Calling this method
is equivalent to calling <c>RemoveEntry()</c> if an entry by the same name
already exists, followed calling by <c>AddItem()</c>.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.AddItem(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateFile(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateDirectory(System.String)"/>
<param name="itemName">
the path to the file or directory to be added or updated.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateItem(System.String,System.String)">
<summary>
Add or update a file or directory.
</summary>
<remarks>
<para>
This method is useful when the application is not sure or does not care if
the item to be added is a file or directory, and does not know or does not
care if the item already exists in the <c>ZipFile</c>. Calling this method
is equivalent to calling <c>RemoveEntry()</c>, if an entry by that name
exists, and then calling <c>AddItem()</c>.
</para>
<para>
This version of the method allows the caller to explicitly specify the
directory path to be used for the item being added to the archive. The
entry or entries that are added or updated will use the specified
<c>DirectoryPathInArchive</c>. Extracting the entry from the archive will
result in a file stored in that directory path.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.AddItem(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateFile(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateDirectory(System.String,System.String)"/>
<param name="itemName">
The path for the File or Directory to be added or updated.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to override any path in the
<c>itemName</c>. This path may, or may not, correspond to a real
directory in the current filesystem. If the files within the zip are
later extracted, this is the path used for the extracted file. Passing
<c>null</c> (<c>Nothing</c> in VB) will use the path on the
<c>itemName</c>, if any. Passing the empty string ("") will insert the
item at the root path within the archive.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.String)">
<summary>
Adds a named entry into the zip archive, taking content for the entry
from a string.
</summary>
<remarks>
Calling this method creates an entry using the given fileName and
directory path within the archive. There is no need for a file by the
given name to exist in the filesystem; the name is used within the zip
archive only. The content for the entry is encoded using the default text
encoding for the machine, or on Silverlight, using UTF-8.
</remarks>
<param name="content">
The content of the file, should it be extracted from the zip.
</param>
<param name="entryName">
The name, including any path, to use for the entry within the archive.
</param>
<returns>The <c>ZipEntry</c> added.</returns>
<example>
This example shows how to add an entry to the zipfile, using a string as
content for that entry.
<code lang="C#">
string Content = "This string will be the content of the Readme.txt file in the zip archive.";
using (ZipFile zip1 = new ZipFile())
{
zip1.AddFile("MyDocuments\\Resume.doc", "files");
zip1.AddEntry("Readme.txt", Content);
zip1.Comment = "This zip file was created at " + System.DateTime.Now.ToString("G");
zip1.Save("Content.zip");
}
</code>
<code lang="VB">
Public Sub Run()
Dim Content As String = "This string will be the content of the Readme.txt file in the zip archive."
Using zip1 As ZipFile = New ZipFile
zip1.AddEntry("Readme.txt", Content)
zip1.AddFile("MyDocuments\Resume.doc", "files")
zip1.Comment = ("This zip file was created at " & DateTime.Now.ToString("G"))
zip1.Save("Content.zip")
End Using
End Sub
</code>
</example>
</member>
<member name="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.String,System.Text.Encoding)">
<summary>
Adds a named entry into the zip archive, taking content for the entry
from a string, and using the specified text encoding.
</summary>
<remarks>
<para>
Calling this method creates an entry using the given fileName and
directory path within the archive. There is no need for a file by the
given name to exist in the filesystem; the name is used within the zip
archive only.
</para>
<para>
The content for the entry, a string value, is encoded using the given
text encoding. A BOM (byte-order-mark) is emitted into the file, if the
Encoding parameter is set for that.
</para>
<para>
Most Encoding classes support a constructor that accepts a boolean,
indicating whether to emit a BOM or not. For example see <see cref="M:System.Text.UTF8Encoding.#ctor(System.Boolean)"/>.
</para>
</remarks>
<param name="entryName">
The name, including any path, to use within the archive for the entry.
</param>
<param name="content">
The content of the file, should it be extracted from the zip.
</param>
<param name="encoding">
The text encoding to use when encoding the string. Be aware: This is
distinct from the text encoding used to encode the fileName, as specified
in <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>.
</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.IO.Stream)">
<summary>
Create an entry in the <c>ZipFile</c> using the given <c>Stream</c>
as input. The entry will have the given filename.
</summary>
<remarks>
<para>
The application should provide an open, readable stream; in this case it
will be read during the call to <see cref="M:Ionic.Zip.ZipFile.Save"/> or one of
its overloads.
</para>
<para>
The passed stream will be read from its current position. If
necessary, callers should set the position in the stream before
calling AddEntry(). This might be appropriate when using this method
with a MemoryStream, for example.
</para>
<para>
In cases where a large number of streams will be added to the
<c>ZipFile</c>, the application may wish to avoid maintaining all of the
streams open simultaneously. To handle this situation, the application
should use the <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)"/>
overload.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<example>
<para>
This example adds a single entry to a <c>ZipFile</c> via a <c>Stream</c>.
</para>
<code lang="C#">
String zipToCreate = "Content.zip";
String fileNameInArchive = "Content-From-Stream.bin";
using (System.IO.Stream streamToRead = MyStreamOpener())
{
using (ZipFile zip = new ZipFile())
{
ZipEntry entry= zip.AddEntry(fileNameInArchive, streamToRead);
zip.AddFile("Readme.txt");
zip.Save(zipToCreate); // the stream is read implicitly here
}
}
</code>
<code lang="VB">
Dim zipToCreate As String = "Content.zip"
Dim fileNameInArchive As String = "Content-From-Stream.bin"
Using streamToRead as System.IO.Stream = MyStreamOpener()
Using zip As ZipFile = New ZipFile()
Dim entry as ZipEntry = zip.AddEntry(fileNameInArchive, streamToRead)
zip.AddFile("Readme.txt")
zip.Save(zipToCreate) '' the stream is read implicitly, here
End Using
End Using
</code>
</example>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateEntry(System.String,System.IO.Stream)"/>
<param name="entryName">
The name, including any path, which is shown in the zip file for the added
entry.
</param>
<param name="stream">
The input stream from which to grab content for the file
</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.WriteDelegate)">
<summary>
Add a ZipEntry for which content is written directly by the application.
</summary>
<remarks>
<para>
When the application needs to write the zip entry data, use this
method to add the ZipEntry. For example, in the case that the
application wishes to write the XML representation of a DataSet into
a ZipEntry, the application can use this method to do so.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
<para>
About progress events: When using the WriteDelegate, DotNetZip does
not issue any SaveProgress events with <c>EventType</c> = <see cref="F:Ionic.Zip.ZipProgressEventType.Saving_EntryBytesRead">
Saving_EntryBytesRead</see>. (This is because it is the
application's code that runs in WriteDelegate - there's no way for
DotNetZip to know when to issue a EntryBytesRead event.)
Applications that want to update a progress bar or similar status
indicator should do so from within the WriteDelegate
itself. DotNetZip will issue the other SaveProgress events,
including <see cref="F:Ionic.Zip.ZipProgressEventType.Saving_Started">
Saving_Started</see>,
<see cref="F:Ionic.Zip.ZipProgressEventType.Saving_BeforeWriteEntry">
Saving_BeforeWriteEntry</see>, and <see cref="F:Ionic.Zip.ZipProgressEventType.Saving_AfterWriteEntry">
Saving_AfterWriteEntry</see>.
</para>
<para>
Note: When you use PKZip encryption, it's normally necessary to
compute the CRC of the content to be encrypted, before compressing or
encrypting it. Therefore, when using PKZip encryption with a
WriteDelegate, the WriteDelegate CAN BE called twice: once to compute
the CRC, and the second time to potentially compress and
encrypt. Surprising, but true. This is because PKWARE specified that
the encryption initialization data depends on the CRC.
If this happens, for each call of the delegate, your
application must stream the same entry data in its entirety. If your
application writes different data during the second call, it will
result in a corrupt zip file.
</para>
<para>
The double-read behavior happens with all types of entries, not only
those that use WriteDelegate. It happens if you add an entry from a
filesystem file, or using a string, or a stream, or an opener/closer
pair. But in those cases, DotNetZip takes care of reading twice; in
the case of the WriteDelegate, the application code gets invoked
twice. Be aware.
</para>
<para>
As you can imagine, this can cause performance problems for large
streams, and it can lead to correctness problems when you use a
<c>WriteDelegate</c>. This is a pretty big pitfall. There are two
ways to avoid it. First, and most preferred: don't use PKZIP
encryption. If you use the WinZip AES encryption, this problem
doesn't occur, because the encryption protocol doesn't require the CRC
up front. Second: if you do choose to use PKZIP encryption, write out
to a non-seekable stream (like standard output, or the
Response.OutputStream in an ASP.NET application). In this case,
DotNetZip will use an alternative encryption protocol that does not
rely on the CRC of the content. This also implies setting bit 3 in
the zip entry, which still presents problems for some zip tools.
</para>
<para>
In the future I may modify DotNetZip to *always* use bit 3 when PKZIP
encryption is in use. This seems like a win overall, but there will
be some work involved. If you feel strongly about it, visit the
DotNetZip forums and vote up <see href="http://dotnetzip.codeplex.com/workitem/13686">the Workitem
tracking this issue</see>.
</para>
</remarks>
<param name="entryName">the name of the entry to add</param>
<param name="writer">the delegate which will write the entry content</param>
<returns>the ZipEntry added</returns>
<example>
This example shows an application filling a DataSet, then saving the
contents of that DataSet as XML, into a ZipEntry in a ZipFile, using an
anonymous delegate in C#. The DataSet XML is never saved to a disk file.
<code lang="C#">
var c1= new System.Data.SqlClient.SqlConnection(connstring1);
var da = new System.Data.SqlClient.SqlDataAdapter()
{
SelectCommand= new System.Data.SqlClient.SqlCommand(strSelect, c1)
};
DataSet ds1 = new DataSet();
da.Fill(ds1, "Invoices");
using(Ionic.Zip.ZipFile zip = new Ionic.Zip.ZipFile())
{
zip.AddEntry(zipEntryName, (name,stream) => ds1.WriteXml(stream) );
zip.Save(zipFileName);
}
</code>
</example>
<example>
This example uses an anonymous method in C# as the WriteDelegate to provide
the data for the ZipEntry. The example is a bit contrived - the
<c>AddFile()</c> method is a simpler way to insert the contents of a file
into an entry in a zip file. On the other hand, if there is some sort of
processing or transformation of the file contents required before writing,
the application could use the <c>WriteDelegate</c> to do it, in this way.
<code lang="C#">
using (var input = File.Open(filename, FileMode.Open, FileAccess.Read, FileShare.ReadWrite ))
{
using(Ionic.Zip.ZipFile zip = new Ionic.Zip.ZipFile())
{
zip.AddEntry(zipEntryName, (name,output) =>
{
byte[] buffer = new byte[BufferSize];
int n;
while ((n = input.Read(buffer, 0, buffer.Length)) != 0)
{
// could transform the data here...
output.Write(buffer, 0, n);
// could update a progress bar here
}
});
zip.Save(zipFileName);
}
}
</code>
</example>
<example>
This example uses a named delegate in VB to write data for the given
ZipEntry (VB9 does not have anonymous delegates). The example here is a bit
contrived - a simpler way to add the contents of a file to a ZipEntry is to
simply use the appropriate <c>AddFile()</c> method. The key scenario for
which the <c>WriteDelegate</c> makes sense is saving a DataSet, in XML
format, to the zip file. The DataSet can write XML to a stream, and the
WriteDelegate is the perfect place to write into the zip file. There may be
other data structures that can write to a stream, but cannot be read as a
stream. The <c>WriteDelegate</c> would be appropriate for those cases as
well.
<code lang="VB">
Private Sub WriteEntry (ByVal name As String, ByVal output As Stream)
Using input As FileStream = File.Open(filename, FileMode.Open, FileAccess.Read, FileShare.ReadWrite)
Dim n As Integer = -1
Dim buffer As Byte() = New Byte(BufferSize){}
Do While n <> 0
n = input.Read(buffer, 0, buffer.Length)
output.Write(buffer, 0, n)
Loop
End Using
End Sub
Public Sub Run()
Using zip = New ZipFile
zip.AddEntry(zipEntryName, New WriteDelegate(AddressOf WriteEntry))
zip.Save(zipFileName)
End Using
End Sub
</code>
</example>
</member>
<member name="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)">
<summary>
Add an entry, for which the application will provide a stream,
just-in-time.
</summary>
<remarks>
<para>
In cases where the application wishes to open the stream that holds
the content for the ZipEntry, on a just-in-time basis, the application
can use this method and provide delegates to open and close the
stream.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<example>
This example uses anonymous methods in C# to open and close the
source stream for the content for a zip entry. In a real
application, the logic for the OpenDelegate would probably be more
involved.
<code lang="C#">
using(Ionic.Zip.ZipFile zip = new Ionic.Zip.ZipFile())
{
zip.AddEntry(zipEntryName,
(name) => File.Open(filename, FileMode.Open, FileAccess.Read, FileShare.ReadWrite ),
(name, stream) => stream.Close()
);
zip.Save(zipFileName);
}
</code>
</example>
<example>
This example uses delegates in VB.NET to open and close the
the source stream for the content for a zip entry. VB 9.0 lacks
support for "Sub" lambda expressions, and so the CloseDelegate must
be an actual, named Sub.
<code lang="VB">
Function MyStreamOpener(ByVal entryName As String) As Stream
'' This simply opens a file. You probably want to do somethinig
'' more involved here: open a stream to read from a database,
'' open a stream on an HTTP connection, and so on.
Return File.OpenRead(entryName)
End Function
Sub MyStreamCloser(entryName As String, stream As Stream)
stream.Close()
End Sub
Public Sub Run()
Dim dirToZip As String = "fodder"
Dim zipFileToCreate As String = "Archive.zip"
Dim opener As OpenDelegate = AddressOf MyStreamOpener
Dim closer As CloseDelegate = AddressOf MyStreamCloser
Dim numFilestoAdd As Int32 = 4
Using zip As ZipFile = New ZipFile
Dim i As Integer
For i = 0 To numFilesToAdd - 1
zip.AddEntry(String.Format("content-{0:000}.txt"), opener, closer)
Next i
zip.Save(zipFileToCreate)
End Using
End Sub
</code>
</example>
<param name="entryName">the name of the entry to add</param>
<param name="opener">
the delegate that will be invoked to open the stream
</param>
<param name="closer">
the delegate that will be invoked to close the stream
</param>
<returns>the ZipEntry added</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateEntry(System.String,System.String)">
<summary>
Updates the given entry in the <c>ZipFile</c>, using the given
string as content for the <c>ZipEntry</c>.
</summary>
<remarks>
<para>
Calling this method is equivalent to removing the <c>ZipEntry</c> for
the given file name and directory path, if it exists, and then calling
<see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.String)"/>. See the documentation for
that method for further explanation. The string content is encoded
using the default encoding for the machine, or on Silverlight, using
UTF-8. This encoding is distinct from the encoding used for the
filename itself. See <see cref="P:Ionic.Zip.ZipFile.AlternateEncoding"/>.
</para>
</remarks>
<param name="entryName">
The name, including any path, to use within the archive for the entry.
</param>
<param name="content">
The content of the file, should it be extracted from the zip.
</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateEntry(System.String,System.String,System.Text.Encoding)">
<summary>
Updates the given entry in the <c>ZipFile</c>, using the given string as
content for the <c>ZipEntry</c>.
</summary>
<remarks>
Calling this method is equivalent to removing the <c>ZipEntry</c> for the
given file name and directory path, if it exists, and then calling <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.String,System.Text.Encoding)"/>. See the
documentation for that method for further explanation.
</remarks>
<param name="entryName">
The name, including any path, to use within the archive for the entry.
</param>
<param name="content">
The content of the file, should it be extracted from the zip.
</param>
<param name="encoding">
The text encoding to use when encoding the string. Be aware: This is
distinct from the text encoding used to encode the filename. See <see cref="P:Ionic.Zip.ZipFile.AlternateEncoding"/>.
</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateEntry(System.String,Ionic.Zip.WriteDelegate)">
<summary>
Updates the given entry in the <c>ZipFile</c>, using the given delegate
as the source for content for the <c>ZipEntry</c>.
</summary>
<remarks>
Calling this method is equivalent to removing the <c>ZipEntry</c> for the
given file name and directory path, if it exists, and then calling <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.WriteDelegate)"/>. See the
documentation for that method for further explanation.
</remarks>
<param name="entryName">
The name, including any path, to use within the archive for the entry.
</param>
<param name="writer">the delegate which will write the entry content.</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)">
<summary>
Updates the given entry in the <c>ZipFile</c>, using the given delegates
to open and close the stream that provides the content for the <c>ZipEntry</c>.
</summary>
<remarks>
Calling this method is equivalent to removing the <c>ZipEntry</c> for the
given file name and directory path, if it exists, and then calling <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,Ionic.Zip.OpenDelegate,Ionic.Zip.CloseDelegate)"/>. See the
documentation for that method for further explanation.
</remarks>
<param name="entryName">
The name, including any path, to use within the archive for the entry.
</param>
<param name="opener">
the delegate that will be invoked to open the stream
</param>
<param name="closer">
the delegate that will be invoked to close the stream
</param>
<returns>The <c>ZipEntry</c> added or updated.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateEntry(System.String,System.IO.Stream)">
<summary>
Updates the given entry in the <c>ZipFile</c>, using the given stream as
input, and the given filename and given directory Path.
</summary>
<remarks>
<para>
Calling the method is equivalent to calling <c>RemoveEntry()</c> if an
entry by the same name already exists, and then calling <c>AddEntry()</c>
with the given <c>fileName</c> and stream.
</para>
<para>
The stream must be open and readable during the call to
<c>ZipFile.Save</c>. You can dispense the stream on a just-in-time basis
using the <see cref="P:Ionic.Zip.ZipEntry.InputStream"/> property. Check the
documentation of that property for more information.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to the
<c>ZipEntry</c> added.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.IO.Stream)"/>
<seealso cref="P:Ionic.Zip.ZipEntry.InputStream"/>
<param name="entryName">
The name, including any path, to use within the archive for the entry.
</param>
<param name="stream">The input stream from which to read file data.</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.Byte[])">
<summary>
Add an entry into the zip archive using the given filename and
directory path within the archive, and the given content for the
file. No file is created in the filesystem.
</summary>
<param name="byteContent">The data to use for the entry.</param>
<param name="entryName">
The name, including any path, to use within the archive for the entry.
</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateEntry(System.String,System.Byte[])">
<summary>
Updates the given entry in the <c>ZipFile</c>, using the given byte
array as content for the entry.
</summary>
<remarks>
Calling this method is equivalent to removing the <c>ZipEntry</c>
for the given filename and directory path, if it exists, and then
calling <see cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.Byte[])"/>. See the
documentation for that method for further explanation.
</remarks>
<param name="entryName">
The name, including any path, to use within the archive for the entry.
</param>
<param name="byteContent">The content to use for the <c>ZipEntry</c>.</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.AddDirectory(System.String)">
<summary>
Adds the contents of a filesystem directory to a Zip file archive.
</summary>
<remarks>
<para>
The name of the directory may be a relative path or a fully-qualified
path. Any files within the named directory are added to the archive. Any
subdirectories within the named directory are also added to the archive,
recursively.
</para>
<para>
Top-level entries in the named directory will appear as top-level entries
in the zip archive. Entries in subdirectories in the named directory will
result in entries in subdirectories in the zip archive.
</para>
<para>
If you want the entries to appear in a containing directory in the zip
archive itself, then you should call the AddDirectory() overload that
allows you to explicitly specify a directory path for use in the archive.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to each
ZipEntry added.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.AddItem(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.AddFile(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateDirectory(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.AddDirectory(System.String,System.String)"/>
<overloads>This method has 2 overloads.</overloads>
<param name="directoryName">The name of the directory to add.</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.AddDirectory(System.String,System.String)">
<summary>
Adds the contents of a filesystem directory to a Zip file archive,
overriding the path to be used for entries in the archive.
</summary>
<remarks>
<para>
The name of the directory may be a relative path or a fully-qualified
path. The add operation is recursive, so that any files or subdirectories
within the name directory are also added to the archive.
</para>
<para>
Top-level entries in the named directory will appear as top-level entries
in the zip archive. Entries in subdirectories in the named directory will
result in entries in subdirectories in the zip archive.
</para>
<para>
For <c>ZipFile</c> properties including <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.SetCompression"/>, <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>, <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>,
<see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, their
respective values at the time of this call will be applied to each
ZipEntry added.
</para>
</remarks>
<example>
<para>
In this code, calling the ZipUp() method with a value of "c:\reports" for
the directory parameter will result in a zip file structure in which all
entries are contained in a toplevel "reports" directory.
</para>
<code lang="C#">
public void ZipUp(string targetZip, string directory)
{
using (var zip = new ZipFile())
{
zip.AddDirectory(directory, System.IO.Path.GetFileName(directory));
zip.Save(targetZip);
}
}
</code>
</example>
<seealso cref="M:Ionic.Zip.ZipFile.AddItem(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.AddFile(System.String,System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.UpdateDirectory(System.String,System.String)"/>
<param name="directoryName">The name of the directory to add.</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to override any path in the
DirectoryName. This path may, or may not, correspond to a real directory
in the current filesystem. If the zip is later extracted, this is the
path used for the extracted file or directory. Passing <c>null</c>
(<c>Nothing</c> in VB) or the empty string ("") will insert the items at
the root path within the archive.
</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.AddDirectoryByName(System.String)">
<summary>
Creates a directory in the zip archive.
</summary>
<remarks>
<para>
Use this when you want to create a directory in the archive but there is
no corresponding filesystem representation for that directory.
</para>
<para>
You will probably not need to do this in your code. One of the only times
you will want to do this is if you want an empty directory in the zip
archive. The reason: if you add a file to a zip archive that is stored
within a multi-level directory, all of the directory tree is implicitly
created in the zip archive.
</para>
</remarks>
<param name="directoryNameInArchive">
The name of the directory to create in the archive.
</param>
<returns>The <c>ZipEntry</c> added.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.CheckZip(System.String)">
<summary>
Checks a zip file to see if its directory is consistent.
</summary>
<remarks>
<para>
In cases of data error, the directory within a zip file can get out
of synch with the entries in the zip file. This method checks the
given zip file and returns true if this has occurred.
</para>
<para> This method may take a long time to run for large zip files. </para>
<para>
This method is not supported in the Reduced or Compact Framework
versions of DotNetZip.
</para>
<para>
Developers using COM can use the <see cref="M:Ionic.Zip.ComHelper.CheckZip(System.String)">ComHelper.CheckZip(String)</see>
method.
</para>
</remarks>
<param name="zipFileName">The filename to of the zip file to check.</param>
<returns>true if the named zip file checks OK. Otherwise, false. </returns>
<seealso cref="M:Ionic.Zip.ZipFile.FixZipDirectory(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.CheckZip(System.String,System.Boolean,System.IO.TextWriter)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.CheckZip(System.String,System.Boolean,System.IO.TextWriter)">
<summary>
Checks a zip file to see if its directory is consistent,
and optionally fixes the directory if necessary.
</summary>
<remarks>
<para>
In cases of data error, the directory within a zip file can get out of
synch with the entries in the zip file. This method checks the given
zip file, and returns true if this has occurred. It also optionally
fixes the zipfile, saving the fixed copy in <em>Name</em>_Fixed.zip.
</para>
<para>
This method may take a long time to run for large zip files. It
will take even longer if the file actually needs to be fixed, and if
<c>fixIfNecessary</c> is true.
</para>
<para>
This method is not supported in the Reduced or Compact
Framework versions of DotNetZip.
</para>
</remarks>
<param name="zipFileName">The filename to of the zip file to check.</param>
<param name="fixIfNecessary">If true, the method will fix the zip file if
necessary.</param>
<param name="writer">
a TextWriter in which messages generated while checking will be written.
</param>
<returns>true if the named zip is OK; false if the file needs to be fixed.</returns>
<seealso cref="M:Ionic.Zip.ZipFile.CheckZip(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.FixZipDirectory(System.String)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.FixZipDirectory(System.String)">
<summary>
Rewrite the directory within a zipfile.
</summary>
<remarks>
<para>
In cases of data error, the directory in a zip file can get out of
synch with the entries in the zip file. This method attempts to fix
the zip file if this has occurred.
</para>
<para> This can take a long time for large zip files. </para>
<para> This won't work if the zip file uses a non-standard
code page - neither IBM437 nor UTF-8. </para>
<para>
This method is not supported in the Reduced or Compact Framework
versions of DotNetZip.
</para>
<para>
Developers using COM can use the <see cref="M:Ionic.Zip.ComHelper.FixZipDirectory(System.String)">ComHelper.FixZipDirectory(String)</see>
method.
</para>
</remarks>
<param name="zipFileName">The filename to of the zip file to fix.</param>
<seealso cref="M:Ionic.Zip.ZipFile.CheckZip(System.String)"/>
<seealso cref="M:Ionic.Zip.ZipFile.CheckZip(System.String,System.Boolean,System.IO.TextWriter)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.CheckZipPassword(System.String,System.String)">
<summary>
Verify the password on a zip file.
</summary>
<remarks>
<para>
Keep in mind that passwords in zipfiles are applied to
zip entries, not to the entire zip file. So testing a
zipfile for a particular password doesn't work in the
general case. On the other hand, it's often the case
that a single password will be used on all entries in a
zip file. This method works for that case.
</para>
<para>
There is no way to check a password without doing the
decryption. So this code decrypts and extracts the given
zipfile into <see cref="F:System.IO.Stream.Null"/>
</para>
</remarks>
<param name="zipFileName">The filename to of the zip file to fix.</param>
<param name="password">The password to check.</param>
<returns>a bool indicating whether the password matches.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.ContainsEntry(System.String)">
<summary>
Returns true if an entry by the given name exists in the ZipFile.
</summary>
<param name='name'>the name of the entry to find</param>
<returns>true if an entry with the given name exists; otherwise false.
</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.ToString">
<summary>Provides a string representation of the instance.</summary>
<returns>a string representation of the instance.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.#ctor(System.String)">
<summary>
Creates a new <c>ZipFile</c> instance, using the specified filename.
</summary>
<remarks>
<para>
Applications can use this constructor to create a new ZipFile for writing,
or to slurp in an existing zip archive for read and update purposes.
</para>
<para>
To create a new zip archive, an application can call this constructor,
passing the name of a file that does not exist. The name may be a fully
qualified path. Then the application can add directories or files to the
<c>ZipFile</c> via <c>AddDirectory()</c>, <c>AddFile()</c>, <c>AddItem()</c>
and then write the zip archive to the disk by calling <c>Save()</c>. The
zip file is not actually opened and written to the disk until the
application calls <c>ZipFile.Save()</c>. At that point the new zip file
with the given name is created.
</para>
<para>
If you won't know the name of the <c>Zipfile</c> until the time you call
<c>ZipFile.Save()</c>, or if you plan to save to a stream (which has no
name), then you should use the no-argument constructor.
</para>
<para>
The application can also call this constructor to read an existing zip
archive. passing the name of a valid zip file that does exist. But, it's
better form to use the static <see cref="M:Ionic.Zip.ZipFile.Read(System.String)"/> method,
passing the name of the zip file, because using <c>ZipFile.Read()</c> in
your code communicates very clearly what you are doing. In either case,
the file is then read into the <c>ZipFile</c> instance. The app can then
enumerate the entries or can modify the zip file, for example adding
entries, removing entries, changing comments, and so on.
</para>
<para>
One advantage to this parameterized constructor: it allows applications to
use the same code to add items to a zip archive, regardless of whether the
zip file exists.
</para>
<para>
Instances of the <c>ZipFile</c> class are not multi-thread safe. You may
not party on a single instance with multiple threads. You may have
multiple threads that each use a distinct <c>ZipFile</c> instance, or you
can synchronize multi-thread access to a single instance.
</para>
<para>
By the way, since DotNetZip is so easy to use, don't you think <see href="http://cheeso.members.winisp.net/DotNetZipDonate.aspx">you should
donate $5 or $10</see>?
</para>
</remarks>
<exception cref="T:Ionic.Zip.ZipException">
Thrown if name refers to an existing file that is not a valid zip file.
</exception>
<example>
This example shows how to create a zipfile, and add a few files into it.
<code>
String ZipFileToCreate = "archive1.zip";
String DirectoryToZip = "c:\\reports";
using (ZipFile zip = new ZipFile())
{
// Store all files found in the top level directory, into the zip archive.
String[] filenames = System.IO.Directory.GetFiles(DirectoryToZip);
zip.AddFiles(filenames, "files");
zip.Save(ZipFileToCreate);
}
</code>
<code lang="VB">
Dim ZipFileToCreate As String = "archive1.zip"
Dim DirectoryToZip As String = "c:\reports"
Using zip As ZipFile = New ZipFile()
Dim filenames As String() = System.IO.Directory.GetFiles(DirectoryToZip)
zip.AddFiles(filenames, "files")
zip.Save(ZipFileToCreate)
End Using
</code>
</example>
<param name="fileName">The filename to use for the new zip archive.</param>
</member>
<member name="M:Ionic.Zip.ZipFile.#ctor(System.String,System.Text.Encoding)">
<summary>
Creates a new <c>ZipFile</c> instance, using the specified name for the
filename, and the specified Encoding.
</summary>
<remarks>
<para>
See the documentation on the <see cref="M:Ionic.Zip.ZipFile.#ctor(System.String)">ZipFile
constructor that accepts a single string argument</see> for basic
information on all the <c>ZipFile</c> constructors.
</para>
<para>
The Encoding is used as the default alternate encoding for entries with
filenames or comments that cannot be encoded with the IBM437 code page.
This is equivalent to setting the <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/> property on the <c>ZipFile</c>
instance after construction.
</para>
<para>
Instances of the <c>ZipFile</c> class are not multi-thread safe. You may
not party on a single instance with multiple threads. You may have
multiple threads that each use a distinct <c>ZipFile</c> instance, or you
can synchronize multi-thread access to a single instance.
</para>
</remarks>
<exception cref="T:Ionic.Zip.ZipException">
Thrown if name refers to an existing file that is not a valid zip file.
</exception>
<param name="fileName">The filename to use for the new zip archive.</param>
<param name="encoding">The Encoding is used as the default alternate
encoding for entries with filenames or comments that cannot be encoded
with the IBM437 code page. </param>
</member>
<member name="M:Ionic.Zip.ZipFile.#ctor">
<summary>
Create a zip file, without specifying a target filename or stream to save to.
</summary>
<remarks>
<para>
See the documentation on the <see cref="M:Ionic.Zip.ZipFile.#ctor(System.String)">ZipFile
constructor that accepts a single string argument</see> for basic
information on all the <c>ZipFile</c> constructors.
</para>
<para>
After instantiating with this constructor and adding entries to the
archive, the application should call <see cref="M:Ionic.Zip.ZipFile.Save(System.String)"/> or
<see cref="M:Ionic.Zip.ZipFile.Save(System.IO.Stream)"/> to save to a file or a
stream, respectively. The application can also set the <see cref="P:Ionic.Zip.ZipFile.Name"/>
property and then call the no-argument <see cref="M:Ionic.Zip.ZipFile.Save"/> method. (This
is the preferred approach for applications that use the library through
COM interop.) If you call the no-argument <see cref="M:Ionic.Zip.ZipFile.Save"/> method
without having set the <c>Name</c> of the <c>ZipFile</c>, either through
the parameterized constructor or through the explicit property , the
Save() will throw, because there is no place to save the file. </para>
<para>
Instances of the <c>ZipFile</c> class are not multi-thread safe. You may
have multiple threads that each use a distinct <c>ZipFile</c> instance, or
you can synchronize multi-thread access to a single instance. </para>
</remarks>
<example>
This example creates a Zip archive called Backup.zip, containing all the files
in the directory DirectoryToZip. Files within subdirectories are not zipped up.
<code>
using (ZipFile zip = new ZipFile())
{
// Store all files found in the top level directory, into the zip archive.
// note: this code does not recurse subdirectories!
String[] filenames = System.IO.Directory.GetFiles(DirectoryToZip);
zip.AddFiles(filenames, "files");
zip.Save("Backup.zip");
}
</code>
<code lang="VB">
Using zip As New ZipFile
' Store all files found in the top level directory, into the zip archive.
' note: this code does not recurse subdirectories!
Dim filenames As String() = System.IO.Directory.GetFiles(DirectoryToZip)
zip.AddFiles(filenames, "files")
zip.Save("Backup.zip")
End Using
</code>
</example>
</member>
<member name="M:Ionic.Zip.ZipFile.#ctor(System.Text.Encoding)">
<summary>
Create a zip file, specifying a text Encoding, but without specifying a
target filename or stream to save to.
</summary>
<remarks>
<para>
See the documentation on the <see cref="M:Ionic.Zip.ZipFile.#ctor(System.String)">ZipFile
constructor that accepts a single string argument</see> for basic
information on all the <c>ZipFile</c> constructors.
</para>
</remarks>
<param name="encoding">
The Encoding is used as the default alternate encoding for entries with
filenames or comments that cannot be encoded with the IBM437 code page.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.#ctor(System.String,System.IO.TextWriter)">
<summary>
Creates a new <c>ZipFile</c> instance, using the specified name for the
filename, and the specified status message writer.
</summary>
<remarks>
<para>
See the documentation on the <see cref="M:Ionic.Zip.ZipFile.#ctor(System.String)">ZipFile
constructor that accepts a single string argument</see> for basic
information on all the <c>ZipFile</c> constructors.
</para>
<para>
This version of the constructor allows the caller to pass in a TextWriter,
to which verbose messages will be written during extraction or creation of
the zip archive. A console application may wish to pass
System.Console.Out to get messages on the Console. A graphical or headless
application may wish to capture the messages in a different
<c>TextWriter</c>, for example, a <c>StringWriter</c>, and then display
the messages in a TextBox, or generate an audit log of ZipFile operations.
</para>
<para>
To encrypt the data for the files added to the <c>ZipFile</c> instance,
set the Password property after creating the <c>ZipFile</c> instance.
</para>
<para>
Instances of the <c>ZipFile</c> class are not multi-thread safe. You may
not party on a single instance with multiple threads. You may have
multiple threads that each use a distinct <c>ZipFile</c> instance, or you
can synchronize multi-thread access to a single instance.
</para>
</remarks>
<exception cref="T:Ionic.Zip.ZipException">
Thrown if name refers to an existing file that is not a valid zip file.
</exception>
<example>
<code>
using (ZipFile zip = new ZipFile("Backup.zip", Console.Out))
{
// Store all files found in the top level directory, into the zip archive.
// note: this code does not recurse subdirectories!
// Status messages will be written to Console.Out
String[] filenames = System.IO.Directory.GetFiles(DirectoryToZip);
zip.AddFiles(filenames);
zip.Save();
}
</code>
<code lang="VB">
Using zip As New ZipFile("Backup.zip", Console.Out)
' Store all files found in the top level directory, into the zip archive.
' note: this code does not recurse subdirectories!
' Status messages will be written to Console.Out
Dim filenames As String() = System.IO.Directory.GetFiles(DirectoryToZip)
zip.AddFiles(filenames)
zip.Save()
End Using
</code>
</example>
<param name="fileName">The filename to use for the new zip archive.</param>
<param name="statusMessageWriter">A TextWriter to use for writing
verbose status messages.</param>
</member>
<member name="M:Ionic.Zip.ZipFile.#ctor(System.String,System.IO.TextWriter,System.Text.Encoding)">
<summary>
Creates a new <c>ZipFile</c> instance, using the specified name for the
filename, the specified status message writer, and the specified Encoding.
</summary>
<remarks>
<para>
This constructor works like the <see cref="M:Ionic.Zip.ZipFile.#ctor(System.String)">ZipFile
constructor that accepts a single string argument.</see> See that
reference for detail on what this constructor does.
</para>
<para>
This version of the constructor allows the caller to pass in a
<c>TextWriter</c>, and an Encoding. The <c>TextWriter</c> will collect
verbose messages that are generated by the library during extraction or
creation of the zip archive. A console application may wish to pass
<c>System.Console.Out</c> to get messages on the Console. A graphical or
headless application may wish to capture the messages in a different
<c>TextWriter</c>, for example, a <c>StringWriter</c>, and then display
the messages in a <c>TextBox</c>, or generate an audit log of
<c>ZipFile</c> operations.
</para>
<para>
The <c>Encoding</c> is used as the default alternate encoding for entries
with filenames or comments that cannot be encoded with the IBM437 code
page. This is a equivalent to setting the <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/> property on the <c>ZipFile</c>
instance after construction.
</para>
<para>
To encrypt the data for the files added to the <c>ZipFile</c> instance,
set the <c>Password</c> property after creating the <c>ZipFile</c>
instance.
</para>
<para>
Instances of the <c>ZipFile</c> class are not multi-thread safe. You may
not party on a single instance with multiple threads. You may have
multiple threads that each use a distinct <c>ZipFile</c> instance, or you
can synchronize multi-thread access to a single instance.
</para>
</remarks>
<exception cref="T:Ionic.Zip.ZipException">
Thrown if <c>fileName</c> refers to an existing file that is not a valid zip file.
</exception>
<param name="fileName">The filename to use for the new zip archive.</param>
<param name="statusMessageWriter">A TextWriter to use for writing verbose
status messages.</param>
<param name="encoding">
The Encoding is used as the default alternate encoding for entries with
filenames or comments that cannot be encoded with the IBM437 code page.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.Initialize(System.String)">
<summary>
Initialize a <c>ZipFile</c> instance by reading in a zip file.
</summary>
<remarks>
<para>
This method is primarily useful from COM Automation environments, when
reading or extracting zip files. In COM, it is not possible to invoke
parameterized constructors for a class. A COM Automation application can
update a zip file by using the <see cref="M:Ionic.Zip.ZipFile.#ctor">default (no argument)
constructor</see>, then calling <c>Initialize()</c> to read the contents
of an on-disk zip archive into the <c>ZipFile</c> instance.
</para>
<para>
.NET applications are encouraged to use the <c>ZipFile.Read()</c> methods
for better clarity.
</para>
</remarks>
<param name="fileName">the name of the existing zip file to read in.</param>
</member>
<member name="M:Ionic.Zip.ZipFile.RemoveEntry(Ionic.Zip.ZipEntry)">
<summary>
Removes the given <c>ZipEntry</c> from the zip archive.
</summary>
<remarks>
<para>
After calling <c>RemoveEntry</c>, the application must call <c>Save</c> to
make the changes permanent.
</para>
</remarks>
<exception cref="T:System.ArgumentException">
Thrown if the specified <c>ZipEntry</c> does not exist in the <c>ZipFile</c>.
</exception>
<example>
In this example, all entries in the zip archive dating from before
December 31st, 2007, are removed from the archive. This is actually much
easier if you use the RemoveSelectedEntries method. But I needed an
example for RemoveEntry, so here it is.
<code>
String ZipFileToRead = "ArchiveToModify.zip";
System.DateTime Threshold = new System.DateTime(2007,12,31);
using (ZipFile zip = ZipFile.Read(ZipFileToRead))
{
var EntriesToRemove = new System.Collections.Generic.List<ZipEntry>();
foreach (ZipEntry e in zip)
{
if (e.LastModified < Threshold)
{
// We cannot remove the entry from the list, within the context of
// an enumeration of said list.
// So we add the doomed entry to a list to be removed later.
EntriesToRemove.Add(e);
}
}
// actually remove the doomed entries.
foreach (ZipEntry zombie in EntriesToRemove)
zip.RemoveEntry(zombie);
zip.Comment= String.Format("This zip archive was updated at {0}.",
System.DateTime.Now.ToString("G"));
// save with a different name
zip.Save("Archive-Updated.zip");
}
</code>
<code lang="VB">
Dim ZipFileToRead As String = "ArchiveToModify.zip"
Dim Threshold As New DateTime(2007, 12, 31)
Using zip As ZipFile = ZipFile.Read(ZipFileToRead)
Dim EntriesToRemove As New System.Collections.Generic.List(Of ZipEntry)
Dim e As ZipEntry
For Each e In zip
If (e.LastModified < Threshold) Then
' We cannot remove the entry from the list, within the context of
' an enumeration of said list.
' So we add the doomed entry to a list to be removed later.
EntriesToRemove.Add(e)
End If
Next
' actually remove the doomed entries.
Dim zombie As ZipEntry
For Each zombie In EntriesToRemove
zip.RemoveEntry(zombie)
Next
zip.Comment = String.Format("This zip archive was updated at {0}.", DateTime.Now.ToString("G"))
'save as a different name
zip.Save("Archive-Updated.zip")
End Using
</code>
</example>
<param name="entry">
The <c>ZipEntry</c> to remove from the zip.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.RemoveSelectedEntries(System.String)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.RemoveEntry(System.String)">
<summary>
Removes the <c>ZipEntry</c> with the given filename from the zip archive.
</summary>
<remarks>
<para>
After calling <c>RemoveEntry</c>, the application must call <c>Save</c> to
make the changes permanent.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">
Thrown if the <c>ZipFile</c> is not updatable.
</exception>
<exception cref="T:System.ArgumentException">
Thrown if a <c>ZipEntry</c> with the specified filename does not exist in
the <c>ZipFile</c>.
</exception>
<example>
This example shows one way to remove an entry with a given filename from
an existing zip archive.
<code>
String zipFileToRead= "PackedDocuments.zip";
string candidate = "DatedMaterial.xps";
using (ZipFile zip = ZipFile.Read(zipFileToRead))
{
if (zip.EntryFilenames.Contains(candidate))
{
zip.RemoveEntry(candidate);
zip.Comment= String.Format("The file '{0}' has been removed from this archive.",
Candidate);
zip.Save();
}
}
</code>
<code lang="VB">
Dim zipFileToRead As String = "PackedDocuments.zip"
Dim candidate As String = "DatedMaterial.xps"
Using zip As ZipFile = ZipFile.Read(zipFileToRead)
If zip.EntryFilenames.Contains(candidate) Then
zip.RemoveEntry(candidate)
zip.Comment = String.Format("The file '{0}' has been removed from this archive.", Candidate)
zip.Save
End If
End Using
</code>
</example>
<param name="fileName">
The name of the file, including any directory path, to remove from the zip.
The filename match is not case-sensitive by default; you can use the
<c>CaseSensitiveRetrieval</c> property to change this behavior. The
pathname can use forward-slashes or backward slashes.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.Dispose">
<summary>
Closes the read and write streams associated
to the <c>ZipFile</c>, if necessary.
</summary>
<remarks>
The Dispose() method is generally employed implicitly, via a <c>using(..) {..}</c>
statement. (<c>Using...End Using</c> in VB) If you do not employ a using
statement, insure that your application calls Dispose() explicitly. For
example, in a Powershell application, or an application that uses the COM
interop interface, you must call Dispose() explicitly.
</remarks>
<example>
This example extracts an entry selected by name, from the Zip file to the
Console.
<code>
using (ZipFile zip = ZipFile.Read(zipfile))
{
foreach (ZipEntry e in zip)
{
if (WantThisEntry(e.FileName))
zip.Extract(e.FileName, Console.OpenStandardOutput());
}
} // Dispose() is called implicitly here.
</code>
<code lang="VB">
Using zip As ZipFile = ZipFile.Read(zipfile)
Dim e As ZipEntry
For Each e In zip
If WantThisEntry(e.FileName) Then
zip.Extract(e.FileName, Console.OpenStandardOutput())
End If
Next
End Using ' Dispose is implicity called here
</code>
</example>
</member>
<member name="M:Ionic.Zip.ZipFile.Dispose(System.Boolean)">
<summary>
Disposes any managed resources, if the flag is set, then marks the
instance disposed. This method is typically not called explicitly from
application code.
</summary>
<remarks>
Applications should call <see cref="M:Ionic.Zip.ZipFile.Dispose">the no-arg Dispose method</see>.
</remarks>
<param name="disposeManagedResources">
indicates whether the method should dispose streams or not.
</param>
</member>
<member name="F:Ionic.Zip.ZipFile.BufferSizeDefault">
<summary>
Default size of the buffer used for IO.
</summary>
</member>
<member name="M:Ionic.Zip.ZipFile.ExtractAll(System.String)">
<summary>
Extracts all of the items in the zip archive, to the specified path in the
filesystem. The path can be relative or fully-qualified.
</summary>
<remarks>
<para>
This method will extract all entries in the <c>ZipFile</c> to the
specified path.
</para>
<para>
If an extraction of a file from the zip archive would overwrite an
existing file in the filesystem, the action taken is dictated by the
ExtractExistingFile property, which overrides any setting you may have
made on individual ZipEntry instances. By default, if you have not
set that property on the <c>ZipFile</c> instance, the entry will not
be extracted, the existing file will not be overwritten and an
exception will be thrown. To change this, set the property, or use the
<see cref="M:Ionic.Zip.ZipFile.ExtractAll(System.String,Ionic.Zip.ExtractExistingFileAction)"/> overload that allows you to
specify an ExtractExistingFileAction parameter.
</para>
<para>
The action to take when an extract would overwrite an existing file
applies to all entries. If you want to set this on a per-entry basis,
then you must use one of the <see cref="M:Ionic.Zip.ZipEntry.Extract">ZipEntry.Extract</see> methods.
</para>
<para>
This method will send verbose output messages to the <see cref="P:Ionic.Zip.ZipFile.StatusMessageTextWriter"/>, if it is set on the <c>ZipFile</c>
instance.
</para>
<para>
You may wish to take advantage of the <c>ExtractProgress</c> event.
</para>
<para>
About timestamps: When extracting a file entry from a zip archive, the
extracted file gets the last modified time of the entry as stored in
the archive. The archive may also store extended file timestamp
information, including last accessed and created times. If these are
present in the <c>ZipEntry</c>, then the extracted file will also get
these times.
</para>
<para>
A Directory entry is somewhat different. It will get the times as
described for a file entry, but, if there are file entries in the zip
archive that, when extracted, appear in the just-created directory,
then when those file entries are extracted, the last modified and last
accessed times of the directory will change, as a side effect. The
result is that after an extraction of a directory and a number of
files within the directory, the last modified and last accessed
timestamps on the directory will reflect the time that the last file
was extracted into the directory, rather than the time stored in the
zip archive for the directory.
</para>
<para>
To compensate, when extracting an archive with <c>ExtractAll</c>,
DotNetZip will extract all the file and directory entries as described
above, but it will then make a second pass on the directories, and
reset the times on the directories to reflect what is stored in the
zip archive.
</para>
<para>
This compensation is performed only within the context of an
<c>ExtractAll</c>. If you call <c>ZipEntry.Extract</c> on a directory
entry, the timestamps on directory in the filesystem will reflect the
times stored in the zip. If you then call <c>ZipEntry.Extract</c> on
a file entry, which is extracted into the directory, the timestamps on
the directory will be updated to the current time.
</para>
</remarks>
<example>
This example extracts all the entries in a zip archive file, to the
specified target directory. The extraction will overwrite any
existing files silently.
<code>
String TargetDirectory= "unpack";
using(ZipFile zip= ZipFile.Read(ZipFileToExtract))
{
zip.ExtractExistingFile= ExtractExistingFileAction.OverwriteSilently;
zip.ExtractAll(TargetDirectory);
}
</code>
<code lang="VB">
Dim TargetDirectory As String = "unpack"
Using zip As ZipFile = ZipFile.Read(ZipFileToExtract)
zip.ExtractExistingFile= ExtractExistingFileAction.OverwriteSilently
zip.ExtractAll(TargetDirectory)
End Using
</code>
</example>
<seealso cref="E:Ionic.Zip.ZipFile.ExtractProgress"/>
<seealso cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/>
<param name="path">
The path to which the contents of the zipfile will be extracted.
The path can be relative or fully-qualified.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.ExtractAll(System.String,Ionic.Zip.ExtractExistingFileAction)">
<summary>
Extracts all of the items in the zip archive, to the specified path in the
filesystem, using the specified behavior when extraction would overwrite an
existing file.
</summary>
<remarks>
<para>
This method will extract all entries in the <c>ZipFile</c> to the specified
path. For an extraction that would overwrite an existing file, the behavior
is dictated by <paramref name="extractExistingFile"/>, which overrides any
setting you may have made on individual ZipEntry instances.
</para>
<para>
The action to take when an extract would overwrite an existing file
applies to all entries. If you want to set this on a per-entry basis,
then you must use <see cref="M:Ionic.Zip.ZipEntry.Extract(System.String,Ionic.Zip.ExtractExistingFileAction)"/> or one of the similar methods.
</para>
<para>
Calling this method is equivalent to setting the <see cref="P:Ionic.Zip.ZipFile.ExtractExistingFile"/> property and then calling <see cref="M:Ionic.Zip.ZipFile.ExtractAll(System.String)"/>.
</para>
<para>
This method will send verbose output messages to the
<see cref="P:Ionic.Zip.ZipFile.StatusMessageTextWriter"/>, if it is set on the <c>ZipFile</c> instance.
</para>
</remarks>
<example>
This example extracts all the entries in a zip archive file, to the
specified target directory. It does not overwrite any existing files.
<code>
String TargetDirectory= "c:\\unpack";
using(ZipFile zip= ZipFile.Read(ZipFileToExtract))
{
zip.ExtractAll(TargetDirectory, ExtractExistingFileAction.DontOverwrite);
}
</code>
<code lang="VB">
Dim TargetDirectory As String = "c:\unpack"
Using zip As ZipFile = ZipFile.Read(ZipFileToExtract)
zip.ExtractAll(TargetDirectory, ExtractExistingFileAction.DontOverwrite)
End Using
</code>
</example>
<param name="path">
The path to which the contents of the zipfile will be extracted.
The path can be relative or fully-qualified.
</param>
<param name="extractExistingFile">
The action to take if extraction would overwrite an existing file.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.ExtractSelectedEntries(System.String,Ionic.Zip.ExtractExistingFileAction)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.Read(System.String)">
<summary>
Reads a zip file archive and returns the instance.
</summary>
<remarks>
<para>
The stream is read using the default <c>System.Text.Encoding</c>, which is the
<c>IBM437</c> codepage.
</para>
</remarks>
<exception cref="T:System.Exception">
Thrown if the <c>ZipFile</c> cannot be read. The implementation of this method
relies on <c>System.IO.File.OpenRead</c>, which can throw a variety of exceptions,
including specific exceptions if a file is not found, an unauthorized access
exception, exceptions for poorly formatted filenames, and so on.
</exception>
<param name="fileName">
The name of the zip archive to open. This can be a fully-qualified or relative
pathname.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.Read(System.String,Ionic.Zip.ReadOptions)"/>.
<returns>The instance read from the zip archive.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.Read(System.String,Ionic.Zip.ReadOptions)">
<summary>
Reads a zip file archive from the named filesystem file using the
specified options.
</summary>
<remarks>
<para>
This version of the <c>Read()</c> method allows the caller to pass
in a <c>TextWriter</c> an <c>Encoding</c>, via an instance of the
<c>ReadOptions</c> class. The <c>ZipFile</c> is read in using the
specified encoding for entries where UTF-8 encoding is not
explicitly specified.
</para>
</remarks>
<example>
<para>
This example shows how to read a zip file using the Big-5 Chinese
code page (950), and extract each entry in the zip file, while
sending status messages out to the Console.
</para>
<para>
For this code to work as intended, the zipfile must have been
created using the big5 code page (CP950). This is typical, for
example, when using WinRar on a machine with CP950 set as the
default code page. In that case, the names of entries within the
Zip archive will be stored in that code page, and reading the zip
archive must be done using that code page. If the application did
not use the correct code page in ZipFile.Read(), then names of
entries within the zip archive would not be correctly retrieved.
</para>
<code lang="C#">
string zipToExtract = "MyArchive.zip";
string extractDirectory = "extract";
var options = new ReadOptions
{
StatusMessageWriter = System.Console.Out,
Encoding = System.Text.Encoding.GetEncoding(950)
};
using (ZipFile zip = ZipFile.Read(zipToExtract, options))
{
foreach (ZipEntry e in zip)
{
e.Extract(extractDirectory);
}
}
</code>
<code lang="VB">
Dim zipToExtract as String = "MyArchive.zip"
Dim extractDirectory as String = "extract"
Dim options as New ReadOptions
options.Encoding = System.Text.Encoding.GetEncoding(950)
options.StatusMessageWriter = System.Console.Out
Using zip As ZipFile = ZipFile.Read(zipToExtract, options)
Dim e As ZipEntry
For Each e In zip
e.Extract(extractDirectory)
Next
End Using
</code>
</example>
<example>
<para>
This example shows how to read a zip file using the default
code page, to remove entries that have a modified date before a given threshold,
sending status messages out to a <c>StringWriter</c>.
</para>
<code lang="C#">
var options = new ReadOptions
{
StatusMessageWriter = new System.IO.StringWriter()
};
using (ZipFile zip = ZipFile.Read("PackedDocuments.zip", options))
{
var Threshold = new DateTime(2007,7,4);
// We cannot remove the entry from the list, within the context of
// an enumeration of said list.
// So we add the doomed entry to a list to be removed later.
// pass 1: mark the entries for removal
var MarkedEntries = new System.Collections.Generic.List<ZipEntry>();
foreach (ZipEntry e in zip)
{
if (e.LastModified < Threshold)
MarkedEntries.Add(e);
}
// pass 2: actually remove the entry.
foreach (ZipEntry zombie in MarkedEntries)
zip.RemoveEntry(zombie);
zip.Comment = "This archive has been updated.";
zip.Save();
}
// can now use contents of sw, eg store in an audit log
</code>
<code lang="VB">
Dim options as New ReadOptions
options.StatusMessageWriter = New System.IO.StringWriter
Using zip As ZipFile = ZipFile.Read("PackedDocuments.zip", options)
Dim Threshold As New DateTime(2007, 7, 4)
' We cannot remove the entry from the list, within the context of
' an enumeration of said list.
' So we add the doomed entry to a list to be removed later.
' pass 1: mark the entries for removal
Dim MarkedEntries As New System.Collections.Generic.List(Of ZipEntry)
Dim e As ZipEntry
For Each e In zip
If (e.LastModified < Threshold) Then
MarkedEntries.Add(e)
End If
Next
' pass 2: actually remove the entry.
Dim zombie As ZipEntry
For Each zombie In MarkedEntries
zip.RemoveEntry(zombie)
Next
zip.Comment = "This archive has been updated."
zip.Save
End Using
' can now use contents of sw, eg store in an audit log
</code>
</example>
<exception cref="T:System.Exception">
Thrown if the zipfile cannot be read. The implementation of
this method relies on <c>System.IO.File.OpenRead</c>, which
can throw a variety of exceptions, including specific
exceptions if a file is not found, an unauthorized access
exception, exceptions for poorly formatted filenames, and so
on.
</exception>
<param name="fileName">
The name of the zip archive to open.
This can be a fully-qualified or relative pathname.
</param>
<param name="options">
The set of options to use when reading the zip file.
</param>
<returns>The ZipFile instance read from the zip archive.</returns>
<seealso cref="M:Ionic.Zip.ZipFile.Read(System.IO.Stream,Ionic.Zip.ReadOptions)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.Read(System.String,System.IO.TextWriter,System.Text.Encoding,System.EventHandler{Ionic.Zip.ReadProgressEventArgs})">
<summary>
Reads a zip file archive using the specified text encoding, the specified
TextWriter for status messages, and the specified ReadProgress event handler,
and returns the instance.
</summary>
<param name="fileName">
The name of the zip archive to open.
This can be a fully-qualified or relative pathname.
</param>
<param name="readProgress">
An event handler for Read operations.
</param>
<param name="statusMessageWriter">
The <c>System.IO.TextWriter</c> to use for writing verbose status messages
during operations on the zip archive. A console application may wish to
pass <c>System.Console.Out</c> to get messages on the Console. A graphical
or headless application may wish to capture the messages in a different
<c>TextWriter</c>, such as a <c>System.IO.StringWriter</c>.
</param>
<param name="encoding">
The <c>System.Text.Encoding</c> to use when reading in the zip archive. Be
careful specifying the encoding. If the value you use here is not the same
as the Encoding used when the zip archive was created (possibly by a
different archiver) you will get unexpected results and possibly exceptions.
</param>
<returns>The instance read from the zip archive.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.Read(System.IO.Stream)">
<summary>
Reads a zip archive from a stream.
</summary>
<remarks>
<para>
When reading from a file, it's probably easier to just use
<see cref="M:Ionic.Zip.ZipFile.Read(System.String,Ionic.Zip.ReadOptions)">ZipFile.Read(String, ReadOptions)</see>. This
overload is useful when when the zip archive content is
available from an already-open stream. The stream must be
open and readable and seekable when calling this method. The
stream is left open when the reading is completed.
</para>
<para>
Using this overload, the stream is read using the default
<c>System.Text.Encoding</c>, which is the <c>IBM437</c>
codepage. If you want to specify the encoding to use when
reading the zipfile content, see
<see cref="M:Ionic.Zip.ZipFile.Read(System.IO.Stream,Ionic.Zip.ReadOptions)">ZipFile.Read(Stream, ReadOptions)</see>. This
</para>
<para>
Reading of zip content begins at the current position in the
stream. This means if you have a stream that concatenates
regular data and zip data, if you position the open, readable
stream at the start of the zip data, you will be able to read
the zip archive using this constructor, or any of the ZipFile
constructors that accept a <see cref="T:System.IO.Stream"/> as
input. Some examples of where this might be useful: the zip
content is concatenated at the end of a regular EXE file, as
some self-extracting archives do. (Note: SFX files produced
by DotNetZip do not work this way; they can be read as normal
ZIP files). Another example might be a stream being read from
a database, where the zip content is embedded within an
aggregate stream of data.
</para>
</remarks>
<example>
<para>
This example shows how to Read zip content from a stream, and
extract one entry into a different stream. In this example,
the filename "NameOfEntryInArchive.doc", refers only to the
name of the entry within the zip archive. A file by that
name is not created in the filesystem. The I/O is done
strictly with the given streams.
</para>
<code>
using (ZipFile zip = ZipFile.Read(InputStream))
{
zip.Extract("NameOfEntryInArchive.doc", OutputStream);
}
</code>
<code lang="VB">
Using zip as ZipFile = ZipFile.Read(InputStream)
zip.Extract("NameOfEntryInArchive.doc", OutputStream)
End Using
</code>
</example>
<param name="zipStream">the stream containing the zip data.</param>
<returns>The ZipFile instance read from the stream</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.Read(System.IO.Stream,Ionic.Zip.ReadOptions)">
<summary>
Reads a zip file archive from the given stream using the
specified options.
</summary>
<remarks>
<para>
When reading from a file, it's probably easier to just use
<see cref="M:Ionic.Zip.ZipFile.Read(System.String,Ionic.Zip.ReadOptions)">ZipFile.Read(String, ReadOptions)</see>. This
overload is useful when when the zip archive content is
available from an already-open stream. The stream must be
open and readable and seekable when calling this method. The
stream is left open when the reading is completed.
</para>
<para>
Reading of zip content begins at the current position in the
stream. This means if you have a stream that concatenates
regular data and zip data, if you position the open, readable
stream at the start of the zip data, you will be able to read
the zip archive using this constructor, or any of the ZipFile
constructors that accept a <see cref="T:System.IO.Stream"/> as
input. Some examples of where this might be useful: the zip
content is concatenated at the end of a regular EXE file, as
some self-extracting archives do. (Note: SFX files produced
by DotNetZip do not work this way; they can be read as normal
ZIP files). Another example might be a stream being read from
a database, where the zip content is embedded within an
aggregate stream of data.
</para>
</remarks>
<param name="zipStream">the stream containing the zip data.</param>
<param name="options">
The set of options to use when reading the zip file.
</param>
<exception cref="T:System.Exception">
Thrown if the zip archive cannot be read.
</exception>
<returns>The ZipFile instance read from the stream.</returns>
<seealso cref="M:Ionic.Zip.ZipFile.Read(System.String,Ionic.Zip.ReadOptions)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.Read(System.IO.Stream,System.IO.TextWriter,System.Text.Encoding,System.EventHandler{Ionic.Zip.ReadProgressEventArgs})">
<summary>
Reads a zip archive from a stream, using the specified text Encoding, the
specified TextWriter for status messages,
and the specified ReadProgress event handler.
</summary>
<remarks>
<para>
Reading of zip content begins at the current position in the stream. This
means if you have a stream that concatenates regular data and zip data, if
you position the open, readable stream at the start of the zip data, you
will be able to read the zip archive using this constructor, or any of the
ZipFile constructors that accept a <see cref="T:System.IO.Stream"/> as
input. Some examples of where this might be useful: the zip content is
concatenated at the end of a regular EXE file, as some self-extracting
archives do. (Note: SFX files produced by DotNetZip do not work this
way). Another example might be a stream being read from a database, where
the zip content is embedded within an aggregate stream of data.
</para>
</remarks>
<param name="zipStream">the stream containing the zip data.</param>
<param name="statusMessageWriter">
The <c>System.IO.TextWriter</c> to which verbose status messages are written
during operations on the <c>ZipFile</c>. For example, in a console
application, System.Console.Out works, and will get a message for each entry
added to the ZipFile. If the TextWriter is <c>null</c>, no verbose messages
are written.
</param>
<param name="encoding">
The text encoding to use when reading entries that do not have the UTF-8
encoding bit set. Be careful specifying the encoding. If the value you use
here is not the same as the Encoding used when the zip archive was created
(possibly by a different archiver) you will get unexpected results and
possibly exceptions. See the <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>
property for more information.
</param>
<param name="readProgress">
An event handler for Read operations.
</param>
<returns>an instance of ZipFile</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.IsZipFile(System.String)">
<summary>
Checks the given file to see if it appears to be a valid zip file.
</summary>
<remarks>
<para>
Calling this method is equivalent to calling <see cref="M:Ionic.Zip.ZipFile.IsZipFile(System.String,System.Boolean)"/> with the testExtract parameter set to false.
</para>
</remarks>
<param name="fileName">The file to check.</param>
<returns>true if the file appears to be a zip file.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.IsZipFile(System.String,System.Boolean)">
<summary>
Checks a file to see if it is a valid zip file.
</summary>
<remarks>
<para>
This method opens the specified zip file, reads in the zip archive,
verifying the ZIP metadata as it reads.
</para>
<para>
If everything succeeds, then the method returns true. If anything fails -
for example if an incorrect signature or CRC is found, indicating a
corrupt file, the the method returns false. This method also returns
false for a file that does not exist.
</para>
<para>
If <paramref name="testExtract"/> is true, as part of its check, this
method reads in the content for each entry, expands it, and checks CRCs.
This provides an additional check beyond verifying the zip header and
directory data.
</para>
<para>
If <paramref name="testExtract"/> is true, and if any of the zip entries
are protected with a password, this method will return false. If you want
to verify a <c>ZipFile</c> that has entries which are protected with a
password, you will need to do that manually.
</para>
</remarks>
<param name="fileName">The zip file to check.</param>
<param name="testExtract">true if the caller wants to extract each entry.</param>
<returns>true if the file contains a valid zip file.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.IsZipFile(System.IO.Stream,System.Boolean)">
<summary>
Checks a stream to see if it contains a valid zip archive.
</summary>
<remarks>
<para>
This method reads the zip archive contained in the specified stream, verifying
the ZIP metadata as it reads. If testExtract is true, this method also extracts
each entry in the archive, dumping all the bits into <see cref="F:System.IO.Stream.Null"/>.
</para>
<para>
If everything succeeds, then the method returns true. If anything fails -
for example if an incorrect signature or CRC is found, indicating a corrupt
file, the the method returns false. This method also returns false for a
file that does not exist.
</para>
<para>
If <c>testExtract</c> is true, this method reads in the content for each
entry, expands it, and checks CRCs. This provides an additional check
beyond verifying the zip header data.
</para>
<para>
If <c>testExtract</c> is true, and if any of the zip entries are protected
with a password, this method will return false. If you want to verify a
ZipFile that has entries which are protected with a password, you will need
to do that manually.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.IsZipFile(System.String,System.Boolean)"/>
<param name="stream">The stream to check.</param>
<param name="testExtract">true if the caller wants to extract each entry.</param>
<returns>true if the stream contains a valid zip archive.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.DeleteFileWithRetry(System.String)">
<summary>
Delete file with retry on UnauthorizedAccessException.
</summary>
<remarks>
<para>
When calling File.Delete() on a file that has been "recently"
created, the call sometimes fails with
UnauthorizedAccessException. This method simply retries the Delete 3
times with a sleep between tries.
</para>
</remarks>
<param name='filename'>the name of the file to be deleted</param>
</member>
<member name="M:Ionic.Zip.ZipFile.Save">
<summary>
Saves the Zip archive to a file, specified by the Name property of the
<c>ZipFile</c>.
</summary>
<remarks>
<para>
The <c>ZipFile</c> instance is written to storage, typically a zip file
in a filesystem, only when the caller calls <c>Save</c>. In the typical
case, the Save operation writes the zip content to a temporary file, and
then renames the temporary file to the desired name. If necessary, this
method will delete a pre-existing file before the rename.
</para>
<para>
The <see cref="P:Ionic.Zip.ZipFile.Name"/> property is specified either explicitly,
or implicitly using one of the parameterized ZipFile constructors. For
COM Automation clients, the <c>Name</c> property must be set explicitly,
because COM Automation clients cannot call parameterized constructors.
</para>
<para>
When using a filesystem file for the Zip output, it is possible to call
<c>Save</c> multiple times on the <c>ZipFile</c> instance. With each
call the zip content is re-written to the same output file.
</para>
<para>
Data for entries that have been added to the <c>ZipFile</c> instance is
written to the output when the <c>Save</c> method is called. This means
that the input streams for those entries must be available at the time
the application calls <c>Save</c>. If, for example, the application
adds entries with <c>AddEntry</c> using a dynamically-allocated
<c>MemoryStream</c>, the memory stream must not have been disposed
before the call to <c>Save</c>. See the <see cref="P:Ionic.Zip.ZipEntry.InputStream"/> property for more discussion of the
availability requirements of the input stream for an entry, and an
approach for providing just-in-time stream lifecycle management.
</para>
</remarks>
<seealso cref="M:Ionic.Zip.ZipFile.AddEntry(System.String,System.IO.Stream)"/>
<exception cref="T:Ionic.Zip.BadStateException">
Thrown if you haven't specified a location or stream for saving the zip,
either in the constructor or by setting the Name property, or if you try
to save a regular zip archive to a filename with a .exe extension.
</exception>
<exception cref="T:System.OverflowException">
Thrown if <see cref="P:Ionic.Zip.ZipFile.MaxOutputSegmentSize"/> is non-zero, and the number
of segments that would be generated for the spanned zip file during the
save operation exceeds 99. If this happens, you need to increase the
segment size.
</exception>
</member>
<member name="M:Ionic.Zip.ZipFile.Save(System.String)">
<summary>
Save the file to a new zipfile, with the given name.
</summary>
<remarks>
<para>
This method allows the application to explicitly specify the name of the zip
file when saving. Use this when creating a new zip file, or when
updating a zip archive.
</para>
<para>
An application can also save a zip archive in several places by calling this
method multiple times in succession, with different filenames.
</para>
<para>
The <c>ZipFile</c> instance is written to storage, typically a zip file in a
filesystem, only when the caller calls <c>Save</c>. The Save operation writes
the zip content to a temporary file, and then renames the temporary file
to the desired name. If necessary, this method will delete a pre-existing file
before the rename.
</para>
</remarks>
<exception cref="T:System.ArgumentException">
Thrown if you specify a directory for the filename.
</exception>
<param name="fileName">
The name of the zip archive to save to. Existing files will
be overwritten with great prejudice.
</param>
<example>
This example shows how to create and Save a zip file.
<code>
using (ZipFile zip = new ZipFile())
{
zip.AddDirectory(@"c:\reports\January");
zip.Save("January.zip");
}
</code>
<code lang="VB">
Using zip As New ZipFile()
zip.AddDirectory("c:\reports\January")
zip.Save("January.zip")
End Using
</code>
</example>
<example>
This example shows how to update a zip file.
<code>
using (ZipFile zip = ZipFile.Read("ExistingArchive.zip"))
{
zip.AddFile("NewData.csv");
zip.Save("UpdatedArchive.zip");
}
</code>
<code lang="VB">
Using zip As ZipFile = ZipFile.Read("ExistingArchive.zip")
zip.AddFile("NewData.csv")
zip.Save("UpdatedArchive.zip")
End Using
</code>
</example>
</member>
<member name="M:Ionic.Zip.ZipFile.Save(System.IO.Stream)">
<summary>
Save the zip archive to the specified stream.
</summary>
<remarks>
<para>
The <c>ZipFile</c> instance is written to storage - typically a zip file
in a filesystem, but using this overload, the storage can be anything
accessible via a writable stream - only when the caller calls <c>Save</c>.
</para>
<para>
Use this method to save the zip content to a stream directly. A common
scenario is an ASP.NET application that dynamically generates a zip file
and allows the browser to download it. The application can call
<c>Save(Response.OutputStream)</c> to write a zipfile directly to the
output stream, without creating a zip file on the disk on the ASP.NET
server.
</para>
<para>
Be careful when saving a file to a non-seekable stream, including
<c>Response.OutputStream</c>. When DotNetZip writes to a non-seekable
stream, the zip archive is formatted in such a way that may not be
compatible with all zip tools on all platforms. It's a perfectly legal
and compliant zip file, but some people have reported problems opening
files produced this way using the Mac OS archive utility.
</para>
</remarks>
<example>
This example saves the zipfile content into a MemoryStream, and
then gets the array of bytes from that MemoryStream.
<code lang="C#">
using (var zip = new Ionic.Zip.ZipFile())
{
zip.CompressionLevel= Ionic.Zlib.CompressionLevel.BestCompression;
zip.Password = "VerySecret.";
zip.Encryption = EncryptionAlgorithm.WinZipAes128;
zip.AddFile(sourceFileName);
MemoryStream output = new MemoryStream();
zip.Save(output);
byte[] zipbytes = output.ToArray();
}
</code>
</example>
<example>
<para>
This example shows a pitfall you should avoid. DO NOT read
from a stream, then try to save to the same stream. DO
NOT DO THIS:
</para>
<code lang="C#">
using (var fs = new FileSteeam(filename, FileMode.Open))
{
using (var zip = Ionic.Zip.ZipFile.Read(inputStream))
{
zip.AddEntry("Name1.txt", "this is the content");
zip.Save(inputStream); // NO NO NO!!
}
}
</code>
<para>
Better like this:
</para>
<code lang="C#">
using (var zip = Ionic.Zip.ZipFile.Read(filename))
{
zip.AddEntry("Name1.txt", "this is the content");
zip.Save(); // YES!
}
</code>
</example>
<param name="outputStream">
The <c>System.IO.Stream</c> to write to. It must be
writable. If you created the ZipFile instanct by calling
ZipFile.Read(), this stream must not be the same stream
you passed to ZipFile.Read().
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)">
<summary>
Adds to the ZipFile a set of files from the current working directory on
disk, that conform to the specified criteria.
</summary>
<remarks>
<para>
This method selects files from the the current working directory matching
the specified criteria, and adds them to the ZipFile.
</para>
<para>
Specify the criteria in statements of 3 elements: a noun, an operator, and
a value. Consider the string "name != *.doc" . The noun is "name". The
operator is "!=", implying "Not Equal". The value is "*.doc". That
criterion, in English, says "all files with a name that does not end in
the .doc extension."
</para>
<para>
Supported nouns include "name" (or "filename") for the filename; "atime",
"mtime", and "ctime" for last access time, last modfied time, and created
time of the file, respectively; "attributes" (or "attrs") for the file
attributes; "size" (or "length") for the file length (uncompressed), and
"type" for the type of object, either a file or a directory. The
"attributes", "name" and "type" nouns both support = and != as operators.
The "size", "atime", "mtime", and "ctime" nouns support = and !=, and
>, >=, <, <= as well. The times are taken to be expressed in
local time.
</para>
<para>
Specify values for the file attributes as a string with one or more of the
characters H,R,S,A,I,L in any order, implying file attributes of Hidden,
ReadOnly, System, Archive, NotContextIndexed, and ReparsePoint (symbolic
link) respectively.
</para>
<para>
To specify a time, use YYYY-MM-DD-HH:mm:ss or YYYY/MM/DD-HH:mm:ss as the
format. If you omit the HH:mm:ss portion, it is assumed to be 00:00:00
(midnight).
</para>
<para>
The value for a size criterion is expressed in integer quantities of bytes,
kilobytes (use k or kb after the number), megabytes (m or mb), or gigabytes
(g or gb).
</para>
<para>
The value for a name is a pattern to match against the filename, potentially
including wildcards. The pattern follows CMD.exe glob rules: * implies one
or more of any character, while ? implies one character. If the name
pattern contains any slashes, it is matched to the entire filename,
including the path; otherwise, it is matched against only the filename
without the path. This means a pattern of "*\*.*" matches all files one
directory level deep, while a pattern of "*.*" matches all files in all
directories.
</para>
<para>
To specify a name pattern that includes spaces, use single quotes around the
pattern. A pattern of "'* *.*'" will match all files that have spaces in
the filename. The full criteria string for that would be "name = '* *.*'" .
</para>
<para>
The value for a type criterion is either F (implying a file) or D (implying
a directory).
</para>
<para>
Some examples:
</para>
<list type="table">
<listheader>
<term>criteria</term>
<description>Files retrieved</description>
</listheader>
<item>
<term>name != *.xls </term>
<description>any file with an extension that is not .xls
</description>
</item>
<item>
<term>name = *.mp3 </term>
<description>any file with a .mp3 extension.
</description>
</item>
<item>
<term>*.mp3</term>
<description>(same as above) any file with a .mp3 extension.
</description>
</item>
<item>
<term>attributes = A </term>
<description>all files whose attributes include the Archive bit.
</description>
</item>
<item>
<term>attributes != H </term>
<description>all files whose attributes do not include the Hidden bit.
</description>
</item>
<item>
<term>mtime > 2009-01-01</term>
<description>all files with a last modified time after January 1st, 2009.
</description>
</item>
<item>
<term>size > 2gb</term>
<description>all files whose uncompressed size is greater than 2gb.
</description>
</item>
<item>
<term>type = D</term>
<description>all directories in the filesystem. </description>
</item>
</list>
<para>
You can combine criteria with the conjunctions AND or OR. Using a string
like "name = *.txt AND size >= 100k" for the selectionCriteria retrieves
entries whose names end in .txt, and whose uncompressed size is greater than
or equal to 100 kilobytes.
</para>
<para>
For more complex combinations of criteria, you can use parenthesis to group
clauses in the boolean logic. Without parenthesis, the precedence of the
criterion atoms is determined by order of appearance. Unlike the C#
language, the AND conjunction does not take precendence over the logical OR.
This is important only in strings that contain 3 or more criterion atoms.
In other words, "name = *.txt and size > 1000 or attributes = H" implies
"((name = *.txt AND size > 1000) OR attributes = H)" while "attributes =
H OR name = *.txt and size > 1000" evaluates to "((attributes = H OR name
= *.txt) AND size > 1000)". When in doubt, use parenthesis.
</para>
<para>
Using time properties requires some extra care. If you want to retrieve all
entries that were last updated on 2009 February 14, specify a time range
like so:"mtime >= 2009-02-14 AND mtime < 2009-02-15". Read this to
say: all files updated after 12:00am on February 14th, until 12:00am on
February 15th. You can use the same bracketing approach to specify any time
period - a year, a month, a week, and so on.
</para>
<para>
The syntax allows one special case: if you provide a string with no spaces, it is
treated as a pattern to match for the filename. Therefore a string like "*.xls"
will be equivalent to specifying "name = *.xls".
</para>
<para>
There is no logic in this method that insures that the file inclusion
criteria are internally consistent. For example, it's possible to specify
criteria that says the file must have a size of less than 100 bytes, as well
as a size that is greater than 1000 bytes. Obviously no file will ever
satisfy such criteria, but this method does not detect such logical
inconsistencies. The caller is responsible for insuring the criteria are
sensible.
</para>
<para>
Using this method, the file selection does not recurse into
subdirectories, and the full path of the selected files is included in the
entries added into the zip archive. If you don't like these behaviors,
see the other overloads of this method.
</para>
</remarks>
<example>
This example zips up all *.csv files in the current working directory.
<code>
using (ZipFile zip = new ZipFile())
{
// To just match on filename wildcards,
// use the shorthand form of the selectionCriteria string.
zip.AddSelectedFiles("*.csv");
zip.Save(PathToZipArchive);
}
</code>
<code lang="VB">
Using zip As ZipFile = New ZipFile()
zip.AddSelectedFiles("*.csv")
zip.Save(PathToZipArchive)
End Using
</code>
</example>
<param name="selectionCriteria">The criteria for file selection</param>
</member>
<member name="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.Boolean)">
<summary>
Adds to the ZipFile a set of files from the disk that conform to the
specified criteria, optionally recursing into subdirectories.
</summary>
<remarks>
<para>
This method selects files from the the current working directory matching
the specified criteria, and adds them to the ZipFile. If
<c>recurseDirectories</c> is true, files are also selected from
subdirectories, and the directory structure in the filesystem is
reproduced in the zip archive, rooted at the current working directory.
</para>
<para>
Using this method, the full path of the selected files is included in the
entries added into the zip archive. If you don't want this behavior, use
one of the overloads of this method that allows the specification of a
<c>directoryInArchive</c>.
</para>
<para>
For details on the syntax for the selectionCriteria parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
</remarks>
<example>
This example zips up all *.xml files in the current working directory, or any
subdirectory, that are larger than 1mb.
<code>
using (ZipFile zip = new ZipFile())
{
// Use a compound expression in the selectionCriteria string.
zip.AddSelectedFiles("name = *.xml and size > 1024kb", true);
zip.Save(PathToZipArchive);
}
</code>
<code lang="VB">
Using zip As ZipFile = New ZipFile()
' Use a compound expression in the selectionCriteria string.
zip.AddSelectedFiles("name = *.xml and size > 1024kb", true)
zip.Save(PathToZipArchive)
End Using
</code>
</example>
<param name="selectionCriteria">The criteria for file selection</param>
<param name="recurseDirectories">
If true, the file selection will recurse into subdirectories.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String)">
<summary>
Adds to the ZipFile a set of files from a specified directory in the
filesystem, that conform to the specified criteria.
</summary>
<remarks>
<para>
This method selects files that conform to the specified criteria, from the
the specified directory on disk, and adds them to the ZipFile. The search
does not recurse into subdirectores.
</para>
<para>
Using this method, the full filesystem path of the files on disk is
reproduced on the entries added to the zip file. If you don't want this
behavior, use one of the other overloads of this method.
</para>
<para>
For details on the syntax for the selectionCriteria parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
</remarks>
<example>
This example zips up all *.xml files larger than 1mb in the directory
given by "d:\rawdata".
<code>
using (ZipFile zip = new ZipFile())
{
// Use a compound expression in the selectionCriteria string.
zip.AddSelectedFiles("name = *.xml and size > 1024kb", "d:\\rawdata");
zip.Save(PathToZipArchive);
}
</code>
<code lang="VB">
Using zip As ZipFile = New ZipFile()
' Use a compound expression in the selectionCriteria string.
zip.AddSelectedFiles("name = *.xml and size > 1024kb", "d:\rawdata)
zip.Save(PathToZipArchive)
End Using
</code>
</example>
<param name="selectionCriteria">The criteria for file selection</param>
<param name="directoryOnDisk">
The name of the directory on the disk from which to select files.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String,System.Boolean)">
<summary>
Adds to the ZipFile a set of files from the specified directory on disk,
that conform to the specified criteria.
</summary>
<remarks>
<para>
This method selects files from the the specified disk directory matching
the specified selection criteria, and adds them to the ZipFile. If
<c>recurseDirectories</c> is true, files are also selected from
subdirectories.
</para>
<para>
The full directory structure in the filesystem is reproduced on the
entries added to the zip archive. If you don't want this behavior, use
one of the overloads of this method that allows the specification of a
<c>directoryInArchive</c>.
</para>
<para>
For details on the syntax for the selectionCriteria parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
</remarks>
<example>
This example zips up all *.csv files in the "files" directory, or any
subdirectory, that have been saved since 2009 February 14th.
<code>
using (ZipFile zip = new ZipFile())
{
// Use a compound expression in the selectionCriteria string.
zip.AddSelectedFiles("name = *.csv and mtime > 2009-02-14", "files", true);
zip.Save(PathToZipArchive);
}
</code>
<code lang="VB">
Using zip As ZipFile = New ZipFile()
' Use a compound expression in the selectionCriteria string.
zip.AddSelectedFiles("name = *.csv and mtime > 2009-02-14", "files", true)
zip.Save(PathToZipArchive)
End Using
</code>
</example>
<example>
This example zips up all files in the current working
directory, and all its child directories, except those in
the <c>excludethis</c> subdirectory.
<code lang="VB">
Using Zip As ZipFile = New ZipFile(zipfile)
Zip.AddSelectedFfiles("name != 'excludethis\*.*'", datapath, True)
Zip.Save()
End Using
</code>
</example>
<param name="selectionCriteria">The criteria for file selection</param>
<param name="directoryOnDisk">
The filesystem path from which to select files.
</param>
<param name="recurseDirectories">
If true, the file selection will recurse into subdirectories.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String,System.String)">
<summary>
Adds to the ZipFile a selection of files from the specified directory on
disk, that conform to the specified criteria, and using a specified root
path for entries added to the zip archive.
</summary>
<remarks>
<para>
This method selects files from the specified disk directory matching the
specified selection criteria, and adds those files to the ZipFile, using
the specified directory path in the archive. The search does not recurse
into subdirectories. For details on the syntax for the selectionCriteria
parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
</remarks>
<example>
This example zips up all *.psd files in the "photos" directory that have
been saved since 2009 February 14th, and puts them all in a zip file,
using the directory name of "content" in the zip archive itself. When the
zip archive is unzipped, the folder containing the .psd files will be
named "content".
<code>
using (ZipFile zip = new ZipFile())
{
// Use a compound expression in the selectionCriteria string.
zip.AddSelectedFiles("name = *.psd and mtime > 2009-02-14", "photos", "content");
zip.Save(PathToZipArchive);
}
</code>
<code lang="VB">
Using zip As ZipFile = New ZipFile
zip.AddSelectedFiles("name = *.psd and mtime > 2009-02-14", "photos", "content")
zip.Save(PathToZipArchive)
End Using
</code>
</example>
<param name="selectionCriteria">
The criteria for selection of files to add to the <c>ZipFile</c>.
</param>
<param name="directoryOnDisk">
The path to the directory in the filesystem from which to select files.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to in place of the
<c>directoryOnDisk</c>. This path may, or may not, correspond to a real
directory in the current filesystem. If the files within the zip are
later extracted, this is the path used for the extracted file. Passing
null (nothing in VB) will use the path on the file name, if any; in other
words it would use <c>directoryOnDisk</c>, plus any subdirectory. Passing
the empty string ("") will insert the item at the root path within the
archive.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String,System.String,System.Boolean)">
<summary>
Adds to the ZipFile a selection of files from the specified directory on
disk, that conform to the specified criteria, optionally recursing through
subdirectories, and using a specified root path for entries added to the
zip archive.
</summary>
<remarks>
This method selects files from the specified disk directory that match the
specified selection criteria, and adds those files to the ZipFile, using
the specified directory path in the archive. If <c>recurseDirectories</c>
is true, files are also selected from subdirectories, and the directory
structure in the filesystem is reproduced in the zip archive, rooted at
the directory specified by <c>directoryOnDisk</c>. For details on the
syntax for the selectionCriteria parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</remarks>
<example>
This example zips up all files that are NOT *.pst files, in the current
working directory and any subdirectories.
<code>
using (ZipFile zip = new ZipFile())
{
zip.AddSelectedFiles("name != *.pst", SourceDirectory, "backup", true);
zip.Save(PathToZipArchive);
}
</code>
<code lang="VB">
Using zip As ZipFile = New ZipFile
zip.AddSelectedFiles("name != *.pst", SourceDirectory, "backup", true)
zip.Save(PathToZipArchive)
End Using
</code>
</example>
<param name="selectionCriteria">
The criteria for selection of files to add to the <c>ZipFile</c>.
</param>
<param name="directoryOnDisk">
The path to the directory in the filesystem from which to select files.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to in place of the
<c>directoryOnDisk</c>. This path may, or may not, correspond to a real
directory in the current filesystem. If the files within the zip are
later extracted, this is the path used for the extracted file. Passing
null (nothing in VB) will use the path on the file name, if any; in other
words it would use <c>directoryOnDisk</c>, plus any subdirectory. Passing
the empty string ("") will insert the item at the root path within the
archive.
</param>
<param name="recurseDirectories">
If true, the method also scans subdirectories for files matching the
criteria.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.UpdateSelectedFiles(System.String,System.String,System.String,System.Boolean)">
<summary>
Updates the ZipFile with a selection of files from the disk that conform
to the specified criteria.
</summary>
<remarks>
This method selects files from the specified disk directory that match the
specified selection criteria, and Updates the <c>ZipFile</c> with those
files, using the specified directory path in the archive. If
<c>recurseDirectories</c> is true, files are also selected from
subdirectories, and the directory structure in the filesystem is
reproduced in the zip archive, rooted at the directory specified by
<c>directoryOnDisk</c>. For details on the syntax for the
selectionCriteria parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</remarks>
<param name="selectionCriteria">
The criteria for selection of files to add to the <c>ZipFile</c>.
</param>
<param name="directoryOnDisk">
The path to the directory in the filesystem from which to select files.
</param>
<param name="directoryPathInArchive">
Specifies a directory path to use to in place of the
<c>directoryOnDisk</c>. This path may, or may not, correspond to a
real directory in the current filesystem. If the files within the zip
are later extracted, this is the path used for the extracted file.
Passing null (nothing in VB) will use the path on the file name, if
any; in other words it would use <c>directoryOnDisk</c>, plus any
subdirectory. Passing the empty string ("") will insert the item at
the root path within the archive.
</param>
<param name="recurseDirectories">
If true, the method also scans subdirectories for files matching the criteria.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String,System.String,System.String,System.Boolean)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.SelectEntries(System.String)">
<summary>
Retrieve entries from the zipfile by specified criteria.
</summary>
<remarks>
<para>
This method allows callers to retrieve the collection of entries from the zipfile
that fit the specified criteria. The criteria are described in a string format, and
can include patterns for the filename; constraints on the size of the entry;
constraints on the last modified, created, or last accessed time for the file
described by the entry; or the attributes of the entry.
</para>
<para>
For details on the syntax for the selectionCriteria parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
<para>
This method is intended for use with a ZipFile that has been read from storage.
When creating a new ZipFile, this method will work only after the ZipArchive has
been Saved to the disk (the ZipFile class subsequently and implicitly reads the Zip
archive from storage.) Calling SelectEntries on a ZipFile that has not yet been
saved will deliver undefined results.
</para>
</remarks>
<exception cref="T:System.Exception">
Thrown if selectionCriteria has an invalid syntax.
</exception>
<example>
This example selects all the PhotoShop files from within an archive, and extracts them
to the current working directory.
<code>
using (ZipFile zip1 = ZipFile.Read(ZipFileName))
{
var PhotoShopFiles = zip1.SelectEntries("*.psd");
foreach (ZipEntry psd in PhotoShopFiles)
{
psd.Extract();
}
}
</code>
<code lang="VB">
Using zip1 As ZipFile = ZipFile.Read(ZipFileName)
Dim PhotoShopFiles as ICollection(Of ZipEntry)
PhotoShopFiles = zip1.SelectEntries("*.psd")
Dim psd As ZipEntry
For Each psd In PhotoShopFiles
psd.Extract
Next
End Using
</code>
</example>
<param name="selectionCriteria">the string that specifies which entries to select</param>
<returns>a collection of ZipEntry objects that conform to the inclusion spec</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.SelectEntries(System.String,System.String)">
<summary>
Retrieve entries from the zipfile by specified criteria.
</summary>
<remarks>
<para>
This method allows callers to retrieve the collection of entries from the zipfile
that fit the specified criteria. The criteria are described in a string format, and
can include patterns for the filename; constraints on the size of the entry;
constraints on the last modified, created, or last accessed time for the file
described by the entry; or the attributes of the entry.
</para>
<para>
For details on the syntax for the selectionCriteria parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
<para>
This method is intended for use with a ZipFile that has been read from storage.
When creating a new ZipFile, this method will work only after the ZipArchive has
been Saved to the disk (the ZipFile class subsequently and implicitly reads the Zip
archive from storage.) Calling SelectEntries on a ZipFile that has not yet been
saved will deliver undefined results.
</para>
</remarks>
<exception cref="T:System.Exception">
Thrown if selectionCriteria has an invalid syntax.
</exception>
<example>
<code>
using (ZipFile zip1 = ZipFile.Read(ZipFileName))
{
var UpdatedPhotoShopFiles = zip1.SelectEntries("*.psd", "UpdatedFiles");
foreach (ZipEntry e in UpdatedPhotoShopFiles)
{
// prompt for extract here
if (WantExtract(e.FileName))
e.Extract();
}
}
</code>
<code lang="VB">
Using zip1 As ZipFile = ZipFile.Read(ZipFileName)
Dim UpdatedPhotoShopFiles As ICollection(Of ZipEntry) = zip1.SelectEntries("*.psd", "UpdatedFiles")
Dim e As ZipEntry
For Each e In UpdatedPhotoShopFiles
' prompt for extract here
If Me.WantExtract(e.FileName) Then
e.Extract
End If
Next
End Using
</code>
</example>
<param name="selectionCriteria">the string that specifies which entries to select</param>
<param name="directoryPathInArchive">
the directory in the archive from which to select entries. If null, then
all directories in the archive are used.
</param>
<returns>a collection of ZipEntry objects that conform to the inclusion spec</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.RemoveSelectedEntries(System.String)">
<summary>
Remove entries from the zipfile by specified criteria.
</summary>
<remarks>
<para>
This method allows callers to remove the collection of entries from the zipfile
that fit the specified criteria. The criteria are described in a string format, and
can include patterns for the filename; constraints on the size of the entry;
constraints on the last modified, created, or last accessed time for the file
described by the entry; or the attributes of the entry.
</para>
<para>
For details on the syntax for the selectionCriteria parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
<para>
This method is intended for use with a ZipFile that has been read from storage.
When creating a new ZipFile, this method will work only after the ZipArchive has
been Saved to the disk (the ZipFile class subsequently and implicitly reads the Zip
archive from storage.) Calling SelectEntries on a ZipFile that has not yet been
saved will deliver undefined results.
</para>
</remarks>
<exception cref="T:System.Exception">
Thrown if selectionCriteria has an invalid syntax.
</exception>
<example>
This example removes all entries in a zip file that were modified prior to January 1st, 2008.
<code>
using (ZipFile zip1 = ZipFile.Read(ZipFileName))
{
// remove all entries from prior to Jan 1, 2008
zip1.RemoveEntries("mtime < 2008-01-01");
// don't forget to save the archive!
zip1.Save();
}
</code>
<code lang="VB">
Using zip As ZipFile = ZipFile.Read(ZipFileName)
' remove all entries from prior to Jan 1, 2008
zip1.RemoveEntries("mtime < 2008-01-01")
' do not forget to save the archive!
zip1.Save
End Using
</code>
</example>
<param name="selectionCriteria">the string that specifies which entries to select</param>
<returns>the number of entries removed</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.RemoveSelectedEntries(System.String,System.String)">
<summary>
Remove entries from the zipfile by specified criteria, and within the specified
path in the archive.
</summary>
<remarks>
<para>
This method allows callers to remove the collection of entries from the zipfile
that fit the specified criteria. The criteria are described in a string format, and
can include patterns for the filename; constraints on the size of the entry;
constraints on the last modified, created, or last accessed time for the file
described by the entry; or the attributes of the entry.
</para>
<para>
For details on the syntax for the selectionCriteria parameter, see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
<para>
This method is intended for use with a ZipFile that has been read from storage.
When creating a new ZipFile, this method will work only after the ZipArchive has
been Saved to the disk (the ZipFile class subsequently and implicitly reads the Zip
archive from storage.) Calling SelectEntries on a ZipFile that has not yet been
saved will deliver undefined results.
</para>
</remarks>
<exception cref="T:System.Exception">
Thrown if selectionCriteria has an invalid syntax.
</exception>
<example>
<code>
using (ZipFile zip1 = ZipFile.Read(ZipFileName))
{
// remove all entries from prior to Jan 1, 2008
zip1.RemoveEntries("mtime < 2008-01-01", "documents");
// a call to ZipFile.Save will make the modifications permanent
zip1.Save();
}
</code>
<code lang="VB">
Using zip As ZipFile = ZipFile.Read(ZipFileName)
' remove all entries from prior to Jan 1, 2008
zip1.RemoveEntries("mtime < 2008-01-01", "documents")
' a call to ZipFile.Save will make the modifications permanent
zip1.Save
End Using
</code>
</example>
<param name="selectionCriteria">the string that specifies which entries to select</param>
<param name="directoryPathInArchive">
the directory in the archive from which to select entries. If null, then
all directories in the archive are used.
</param>
<returns>the number of entries removed</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.ExtractSelectedEntries(System.String)">
<summary>
Selects and Extracts a set of Entries from the ZipFile.
</summary>
<remarks>
<para>
The entries are extracted into the current working directory.
</para>
<para>
If any of the files to be extracted already exist, then the action taken is as
specified in the <see cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/> property on the
corresponding ZipEntry instance. By default, the action taken in this case is to
throw an exception.
</para>
<para>
For information on the syntax of the selectionCriteria string,
see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
</remarks>
<example>
This example shows how extract all XML files modified after 15 January 2009.
<code>
using (ZipFile zip = ZipFile.Read(zipArchiveName))
{
zip.ExtractSelectedEntries("name = *.xml and mtime > 2009-01-15");
}
</code>
</example>
<param name="selectionCriteria">the selection criteria for entries to extract.</param>
<seealso cref="M:Ionic.Zip.ZipFile.ExtractSelectedEntries(System.String,Ionic.Zip.ExtractExistingFileAction)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.ExtractSelectedEntries(System.String,Ionic.Zip.ExtractExistingFileAction)">
<summary>
Selects and Extracts a set of Entries from the ZipFile.
</summary>
<remarks>
<para>
The entries are extracted into the current working directory. When extraction would would
overwrite an existing filesystem file, the action taken is as specified in the
<paramref name="extractExistingFile"/> parameter.
</para>
<para>
For information on the syntax of the string describing the entry selection criteria,
see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
</remarks>
<example>
This example shows how extract all XML files modified after 15 January 2009,
overwriting any existing files.
<code>
using (ZipFile zip = ZipFile.Read(zipArchiveName))
{
zip.ExtractSelectedEntries("name = *.xml and mtime > 2009-01-15",
ExtractExistingFileAction.OverwriteSilently);
}
</code>
</example>
<param name="selectionCriteria">the selection criteria for entries to extract.</param>
<param name="extractExistingFile">
The action to take if extraction would overwrite an existing file.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.ExtractSelectedEntries(System.String,System.String)">
<summary>
Selects and Extracts a set of Entries from the ZipFile.
</summary>
<remarks>
<para>
The entries are selected from the specified directory within the archive, and then
extracted into the current working directory.
</para>
<para>
If any of the files to be extracted already exist, then the action taken is as
specified in the <see cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/> property on the
corresponding ZipEntry instance. By default, the action taken in this case is to
throw an exception.
</para>
<para>
For information on the syntax of the string describing the entry selection criteria,
see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
</remarks>
<example>
This example shows how extract all XML files modified after 15 January 2009,
and writes them to the "unpack" directory.
<code>
using (ZipFile zip = ZipFile.Read(zipArchiveName))
{
zip.ExtractSelectedEntries("name = *.xml and mtime > 2009-01-15","unpack");
}
</code>
</example>
<param name="selectionCriteria">the selection criteria for entries to extract.</param>
<param name="directoryPathInArchive">
the directory in the archive from which to select entries. If null, then
all directories in the archive are used.
</param>
<seealso cref="M:Ionic.Zip.ZipFile.ExtractSelectedEntries(System.String,System.String,System.String,Ionic.Zip.ExtractExistingFileAction)"/>
</member>
<member name="M:Ionic.Zip.ZipFile.ExtractSelectedEntries(System.String,System.String,System.String)">
<summary>
Selects and Extracts a set of Entries from the ZipFile.
</summary>
<remarks>
<para>
The entries are extracted into the specified directory. If any of the files to be
extracted already exist, an exception will be thrown.
</para>
<para>
For information on the syntax of the string describing the entry selection criteria,
see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
</remarks>
<param name="selectionCriteria">the selection criteria for entries to extract.</param>
<param name="directoryInArchive">
the directory in the archive from which to select entries. If null, then
all directories in the archive are used.
</param>
<param name="extractDirectory">
the directory on the disk into which to extract. It will be created
if it does not exist.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.ExtractSelectedEntries(System.String,System.String,System.String,Ionic.Zip.ExtractExistingFileAction)">
<summary>
Selects and Extracts a set of Entries from the ZipFile.
</summary>
<remarks>
<para>
The entries are extracted into the specified directory. When extraction would would
overwrite an existing filesystem file, the action taken is as specified in the
<paramref name="extractExistingFile"/> parameter.
</para>
<para>
For information on the syntax of the string describing the entry selection criteria,
see <see cref="M:Ionic.Zip.ZipFile.AddSelectedFiles(System.String)"/>.
</para>
</remarks>
<example>
This example shows how extract all files with an XML extension or with a size larger than 100,000 bytes,
and puts them in the unpack directory. For any files that already exist in
that destination directory, they will not be overwritten.
<code>
using (ZipFile zip = ZipFile.Read(zipArchiveName))
{
zip.ExtractSelectedEntries("name = *.xml or size > 100000",
null,
"unpack",
ExtractExistingFileAction.DontOverwrite);
}
</code>
</example>
<param name="selectionCriteria">the selection criteria for entries to extract.</param>
<param name="extractDirectory">
The directory on the disk into which to extract. It will be created if it does not exist.
</param>
<param name="directoryPathInArchive">
The directory in the archive from which to select entries. If null, then
all directories in the archive are used.
</param>
<param name="extractExistingFile">
The action to take if extraction would overwrite an existing file.
</param>
</member>
<member name="M:Ionic.Zip.ZipFile.SaveSelfExtractor(System.String,Ionic.Zip.SelfExtractorFlavor)">
<summary>
Saves the ZipFile instance to a self-extracting zip archive.
</summary>
<remarks>
<para>
The generated exe image will execute on any machine that has the .NET
Framework 2.0 installed on it. The generated exe image is also a
valid ZIP file, readable with DotNetZip or another Zip library or tool
such as WinZip.
</para>
<para>
There are two "flavors" of self-extracting archive. The
<c>WinFormsApplication</c> version will pop up a GUI and allow the
user to select a target directory into which to extract. There's also
a checkbox allowing the user to specify to overwrite existing files,
and another checkbox to allow the user to request that Explorer be
opened to see the extracted files after extraction. The other flavor
is <c>ConsoleApplication</c>. A self-extractor generated with that
flavor setting will run from the command line. It accepts command-line
options to set the overwrite behavior, and to specify the target
extraction directory.
</para>
<para>
There are a few temporary files created during the saving to a
self-extracting zip. These files are created in the directory pointed
to by <see cref="P:Ionic.Zip.ZipFile.TempFileFolder"/>, which defaults to <see cref="M:System.IO.Path.GetTempPath"/>. These temporary files are
removed upon successful completion of this method.
</para>
<para>
When a user runs the WinForms SFX, the user's personal directory (<see cref="F:System.Environment.SpecialFolder.Personal">Environment.SpecialFolder.Personal</see>)
will be used as the default extract location. If you want to set the
default extract location, you should use the other overload of
<c>SaveSelfExtractor()</c>/ The user who runs the SFX will have the
opportunity to change the extract directory before extracting. When
the user runs the Command-Line SFX, the user must explicitly specify
the directory to which to extract. The .NET Framework 2.0 is required
on the computer when the self-extracting archive is run.
</para>
<para>
NB: This method is not available in the version of DotNetZip build for
the .NET Compact Framework, nor in the "Reduced" DotNetZip library.
</para>
</remarks>
<example>
<code>
string DirectoryPath = "c:\\Documents\\Project7";
using (ZipFile zip = new ZipFile())
{
zip.AddDirectory(DirectoryPath, System.IO.Path.GetFileName(DirectoryPath));
zip.Comment = "This will be embedded into a self-extracting console-based exe";
zip.SaveSelfExtractor("archive.exe", SelfExtractorFlavor.ConsoleApplication);
}
</code>
<code lang="VB">
Dim DirectoryPath As String = "c:\Documents\Project7"
Using zip As New ZipFile()
zip.AddDirectory(DirectoryPath, System.IO.Path.GetFileName(DirectoryPath))
zip.Comment = "This will be embedded into a self-extracting console-based exe"
zip.SaveSelfExtractor("archive.exe", SelfExtractorFlavor.ConsoleApplication)
End Using
</code>
</example>
<param name="exeToGenerate">
a pathname, possibly fully qualified, to be created. Typically it
will end in an .exe extension.</param>
<param name="flavor">
Indicates whether a Winforms or Console self-extractor is
desired. </param>
</member>
<member name="M:Ionic.Zip.ZipFile.SaveSelfExtractor(System.String,Ionic.Zip.SelfExtractorSaveOptions)">
<summary>
Saves the ZipFile instance to a self-extracting zip archive, using
the specified save options.
</summary>
<remarks>
<para>
This method saves a self extracting archive, using the specified save
options. These options include the flavor of the SFX, the default extract
directory, the icon file, and so on. See the documentation
for <see cref="M:Ionic.Zip.ZipFile.SaveSelfExtractor(System.String,Ionic.Zip.SelfExtractorFlavor)"/> for more
details.
</para>
<para>
The user who runs the SFX will have the opportunity to change the extract
directory before extracting. If at the time of extraction, the specified
directory does not exist, the SFX will create the directory before
extracting the files.
</para>
</remarks>
<example>
This example saves a WinForms-based self-extracting archive EXE that
will use c:\ExtractHere as the default extract location. The C# code
shows syntax for .NET 3.0, which uses an object initializer for
the SelfExtractorOptions object.
<code>
string DirectoryPath = "c:\\Documents\\Project7";
using (ZipFile zip = new ZipFile())
{
zip.AddDirectory(DirectoryPath, System.IO.Path.GetFileName(DirectoryPath));
zip.Comment = "This will be embedded into a self-extracting WinForms-based exe";
var options = new SelfExtractorOptions
{
Flavor = SelfExtractorFlavor.WinFormsApplication,
DefaultExtractDirectory = "%USERPROFILE%\\ExtractHere",
PostExtractCommandLine = ExeToRunAfterExtract,
SfxExeWindowTitle = "My Custom Window Title",
RemoveUnpackedFilesAfterExecute = true
};
zip.SaveSelfExtractor("archive.exe", options);
}
</code>
<code lang="VB">
Dim DirectoryPath As String = "c:\Documents\Project7"
Using zip As New ZipFile()
zip.AddDirectory(DirectoryPath, System.IO.Path.GetFileName(DirectoryPath))
zip.Comment = "This will be embedded into a self-extracting console-based exe"
Dim options As New SelfExtractorOptions()
options.Flavor = SelfExtractorFlavor.WinFormsApplication
options.DefaultExtractDirectory = "%USERPROFILE%\\ExtractHere"
options.PostExtractCommandLine = ExeToRunAfterExtract
options.SfxExeWindowTitle = "My Custom Window Title"
options.RemoveUnpackedFilesAfterExecute = True
zip.SaveSelfExtractor("archive.exe", options)
End Using
</code>
</example>
<param name="exeToGenerate">The name of the EXE to generate.</param>
<param name="options">provides the options for creating the
Self-extracting archive.</param>
</member>
<member name="M:Ionic.Zip.ZipFile.GetEnumerator">
<summary>
Generic IEnumerator support, for use of a ZipFile in an enumeration.
</summary>
<remarks>
You probably do not want to call <c>GetEnumerator</c> explicitly. Instead
it is implicitly called when you use a <see langword="foreach"/> loop in C#, or a
<c>For Each</c> loop in VB.NET.
</remarks>
<example>
This example reads a zipfile of a given name, then enumerates the
entries in that zip file, and displays the information about each
entry on the Console.
<code>
using (ZipFile zip = ZipFile.Read(zipfile))
{
bool header = true;
foreach (ZipEntry e in zip)
{
if (header)
{
System.Console.WriteLine("Zipfile: {0}", zip.Name);
System.Console.WriteLine("Version Needed: 0x{0:X2}", e.VersionNeeded);
System.Console.WriteLine("BitField: 0x{0:X2}", e.BitField);
System.Console.WriteLine("Compression Method: 0x{0:X2}", e.CompressionMethod);
System.Console.WriteLine("\n{1,-22} {2,-6} {3,4} {4,-8} {0}",
"Filename", "Modified", "Size", "Ratio", "Packed");
System.Console.WriteLine(new System.String('-', 72));
header = false;
}
System.Console.WriteLine("{1,-22} {2,-6} {3,4:F0}% {4,-8} {0}",
e.FileName,
e.LastModified.ToString("yyyy-MM-dd HH:mm:ss"),
e.UncompressedSize,
e.CompressionRatio,
e.CompressedSize);
e.Extract();
}
}
</code>
<code lang="VB">
Dim ZipFileToExtract As String = "c:\foo.zip"
Using zip As ZipFile = ZipFile.Read(ZipFileToExtract)
Dim header As Boolean = True
Dim e As ZipEntry
For Each e In zip
If header Then
Console.WriteLine("Zipfile: {0}", zip.Name)
Console.WriteLine("Version Needed: 0x{0:X2}", e.VersionNeeded)
Console.WriteLine("BitField: 0x{0:X2}", e.BitField)
Console.WriteLine("Compression Method: 0x{0:X2}", e.CompressionMethod)
Console.WriteLine(ChrW(10) & "{1,-22} {2,-6} {3,4} {4,-8} {0}", _
"Filename", "Modified", "Size", "Ratio", "Packed" )
Console.WriteLine(New String("-"c, 72))
header = False
End If
Console.WriteLine("{1,-22} {2,-6} {3,4:F0}% {4,-8} {0}", _
e.FileName, _
e.LastModified.ToString("yyyy-MM-dd HH:mm:ss"), _
e.UncompressedSize, _
e.CompressionRatio, _
e.CompressedSize )
e.Extract
Next
End Using
</code>
</example>
<returns>A generic enumerator suitable for use within a foreach loop.</returns>
</member>
<member name="M:Ionic.Zip.ZipFile.GetNewEnum">
<summary>
An IEnumerator, for use of a ZipFile in a foreach construct.
</summary>
<remarks>
This method is included for COM support. An application generally does not call
this method directly. It is called implicitly by COM clients when enumerating
the entries in the ZipFile instance. In VBScript, this is done with a <c>For Each</c>
statement. In Javascript, this is done with <c>new Enumerator(zipfile)</c>.
</remarks>
<returns>
The IEnumerator over the entries in the ZipFile.
</returns>
</member>
<member name="P:Ionic.Zip.ZipFile.Info">
<summary>
Provides a human-readable string with information about the ZipFile.
</summary>
<remarks>
<para>
The information string contains 10 lines or so, about each ZipEntry,
describing whether encryption is in use, the compressed and uncompressed
length of the entry, the offset of the entry, and so on. As a result the
information string can be very long for zip files that contain many
entries.
</para>
<para>
This information is mostly useful for diagnostic purposes.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.FullScan">
<summary>
Indicates whether to perform a full scan of the zip file when reading it.
</summary>
<remarks>
<para>
You almost never want to use this property.
</para>
<para>
When reading a zip file, if this flag is <c>true</c> (<c>True</c> in
VB), the entire zip archive will be scanned and searched for entries.
For large archives, this can take a very, long time. The much more
efficient default behavior is to read the zip directory, which is
stored at the end of the zip file. But, in some cases the directory is
corrupted and you need to perform a full scan of the zip file to
determine the contents of the zip file. This property lets you do
that, when necessary.
</para>
<para>
This flag is effective only when calling <see cref="M:Ionic.Zip.ZipFile.Initialize(System.String)"/>. Normally you would read a ZipFile with the
static <see cref="M:Ionic.Zip.ZipFile.Read(System.String)">ZipFile.Read</see>
method. But you can't set the <c>FullScan</c> property on the
<c>ZipFile</c> instance when you use a static factory method like
<c>ZipFile.Read</c>.
</para>
</remarks>
<example>
This example shows how to read a zip file using the full scan approach,
and then save it, thereby producing a corrected zip file.
<code lang="C#">
using (var zip = new ZipFile())
{
zip.FullScan = true;
zip.Initialize(zipFileName);
zip.Save(newName);
}
</code>
<code lang="VB">
Using zip As New ZipFile
zip.FullScan = True
zip.Initialize(zipFileName)
zip.Save(newName)
End Using
</code>
</example>
</member>
<member name="P:Ionic.Zip.ZipFile.SortEntriesBeforeSaving">
<summary>
Whether to sort the ZipEntries before saving the file.
</summary>
<remarks>
The default is false. If you have a large number of zip entries, the sort
alone can consume significant time.
</remarks>
<example>
<code lang="C#">
using (var zip = new ZipFile())
{
zip.AddFiles(filesToAdd);
zip.SortEntriesBeforeSaving = true;
zip.Save(name);
}
</code>
<code lang="VB">
Using zip As New ZipFile
zip.AddFiles(filesToAdd)
zip.SortEntriesBeforeSaving = True
zip.Save(name)
End Using
</code>
</example>
</member>
<member name="P:Ionic.Zip.ZipFile.AddDirectoryWillTraverseReparsePoints">
<summary>
Indicates whether NTFS Reparse Points, like junctions, should be
traversed during calls to <c>AddDirectory()</c>.
</summary>
<remarks>
By default, calls to AddDirectory() will traverse NTFS reparse
points, like mounted volumes, and directory junctions. An example
of a junction is the "My Music" directory in Windows Vista. In some
cases you may not want DotNetZip to traverse those directories. In
that case, set this property to false.
</remarks>
<example>
<code lang="C#">
using (var zip = new ZipFile())
{
zip.AddDirectoryWillTraverseReparsePoints = false;
zip.AddDirectory(dirToZip,"fodder");
zip.Save(zipFileToCreate);
}
</code>
</example>
</member>
<member name="P:Ionic.Zip.ZipFile.BufferSize">
<summary>
Size of the IO buffer used while saving.
</summary>
<remarks>
<para>
First, let me say that you really don't need to bother with this. It is
here to allow for optimizations that you probably won't make! It will work
fine if you don't set or get this property at all. Ok?
</para>
<para>
Now that we have <em>that</em> out of the way, the fine print: This
property affects the size of the buffer that is used for I/O for each
entry contained in the zip file. When a file is read in to be compressed,
it uses a buffer given by the size here. When you update a zip file, the
data for unmodified entries is copied from the first zip file to the
other, through a buffer given by the size here.
</para>
<para>
Changing the buffer size affects a few things: first, for larger buffer
sizes, the memory used by the <c>ZipFile</c>, obviously, will be larger
during I/O operations. This may make operations faster for very much
larger files. Last, for any given entry, when you use a larger buffer
there will be fewer progress events during I/O operations, because there's
one progress event generated for each time the buffer is filled and then
emptied.
</para>
<para>
The default buffer size is 8k. Increasing the buffer size may speed
things up as you compress larger files. But there are no hard-and-fast
rules here, eh? You won't know til you test it. And there will be a
limit where ever larger buffers actually slow things down. So as I said
in the beginning, it's probably best if you don't set or get this property
at all.
</para>
</remarks>
<example>
This example shows how you might set a large buffer size for efficiency when
dealing with zip entries that are larger than 1gb.
<code lang="C#">
using (ZipFile zip = new ZipFile())
{
zip.SaveProgress += this.zip1_SaveProgress;
zip.AddDirectory(directoryToZip, "");
zip.UseZip64WhenSaving = Zip64Option.Always;
zip.BufferSize = 65536*8; // 65536 * 8 = 512k
zip.Save(ZipFileToCreate);
}
</code>
</example>
</member>
<member name="P:Ionic.Zip.ZipFile.CodecBufferSize">
<summary>
Size of the work buffer to use for the ZLIB codec during compression.
</summary>
<remarks>
<para>
When doing ZLIB or Deflate compression, the library fills a buffer,
then passes it to the compressor for compression. Then the library
reads out the compressed bytes. This happens repeatedly until there
is no more uncompressed data to compress. This property sets the
size of the buffer that will be used for chunk-wise compression. In
order for the setting to take effect, your application needs to set
this property before calling one of the <c>ZipFile.Save()</c>
overloads.
</para>
<para>
Setting this affects the performance and memory efficiency of
compression and decompression. For larger files, setting this to a
larger size may improve compression performance, but the exact
numbers vary depending on available memory, the size of the streams
you are compressing, and a bunch of other variables. I don't have
good firm recommendations on how to set it. You'll have to test it
yourself. Or just leave it alone and accept the default.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.FlattenFoldersOnExtract">
<summary>
Indicates whether extracted files should keep their paths as
stored in the zip archive.
</summary>
<remarks>
<para>
This property affects Extraction. It is not used when creating zip
archives.
</para>
<para>
With this property set to <c>false</c>, the default, extracting entries
from a zip file will create files in the filesystem that have the full
path associated to the entry within the zip file. With this property set
to <c>true</c>, extracting entries from the zip file results in files
with no path: the folders are "flattened."
</para>
<para>
An example: suppose the zip file contains entries /directory1/file1.txt and
/directory2/file2.txt. With <c>FlattenFoldersOnExtract</c> set to false,
the files created will be \directory1\file1.txt and \directory2\file2.txt.
With the property set to true, the files created are file1.txt and file2.txt.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.Strategy">
<summary>
The compression strategy to use for all entries.
</summary>
<remarks>
Set the Strategy used by the ZLIB-compatible compressor, when
compressing entries using the DEFLATE method. Different compression
strategies work better on different sorts of data. The strategy
parameter can affect the compression ratio and the speed of
compression but not the correctness of the compresssion. For more
information see <see cref="T:Ionic.Zlib.CompressionStrategy">Ionic.Zlib.CompressionStrategy</see>.
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.Name">
<summary>
The name of the <c>ZipFile</c>, on disk.
</summary>
<remarks>
<para>
When the <c>ZipFile</c> instance was created by reading an archive using
one of the <c>ZipFile.Read</c> methods, this property represents the name
of the zip file that was read. When the <c>ZipFile</c> instance was
created by using the no-argument constructor, this value is <c>null</c>
(<c>Nothing</c> in VB).
</para>
<para>
If you use the no-argument constructor, and you then explicitly set this
property, when you call <see cref="M:Ionic.Zip.ZipFile.Save"/>, this name will
specify the name of the zip file created. Doing so is equivalent to
calling <see cref="M:Ionic.Zip.ZipFile.Save(System.String)"/>. When instantiating a
<c>ZipFile</c> by reading from a stream or byte array, the <c>Name</c>
property remains <c>null</c>. When saving to a stream, the <c>Name</c>
property is implicitly set to <c>null</c>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.CompressionLevel">
<summary>
Sets the compression level to be used for entries subsequently added to
the zip archive.
</summary>
<remarks>
<para>
Varying the compression level used on entries can affect the
size-vs-speed tradeoff when compression and decompressing data streams
or files.
</para>
<para>
As with some other properties on the <c>ZipFile</c> class, like <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, and <see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>, setting this property on a <c>ZipFile</c>
instance will cause the specified <c>CompressionLevel</c> to be used on all
<see cref="T:Ionic.Zip.ZipEntry"/> items that are subsequently added to the
<c>ZipFile</c> instance. If you set this property after you have added
items to the <c>ZipFile</c>, but before you have called <c>Save()</c>,
those items will not use the specified compression level.
</para>
<para>
If you do not set this property, the default compression level is used,
which normally gives a good balance of compression efficiency and
compression speed. In some tests, using <c>BestCompression</c> can
double the time it takes to compress, while delivering just a small
increase in compression efficiency. This behavior will vary with the
type of data you compress. If you are in doubt, just leave this setting
alone, and accept the default.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.CompressionMethod">
<summary>
The compression method for the zipfile.
</summary>
<remarks>
<para>
By default, the compression method is <c>CompressionMethod.Deflate.</c>
</para>
</remarks>
<seealso cref="T:Ionic.Zip.CompressionMethod"/>
</member>
<member name="P:Ionic.Zip.ZipFile.Comment">
<summary>
A comment attached to the zip archive.
</summary>
<remarks>
<para>
This property is read/write. It allows the application to specify a
comment for the <c>ZipFile</c>, or read the comment for the
<c>ZipFile</c>. After setting this property, changes are only made
permanent when you call a <c>Save()</c> method.
</para>
<para>
According to <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's
zip specification</see>, the comment is not encrypted, even if there is a
password set on the zip file.
</para>
<para>
The specification does not describe how to indicate the encoding used
on a comment string. Many "compliant" zip tools and libraries use
IBM437 as the code page for comments; DotNetZip, too, follows that
practice. On the other hand, there are situations where you want a
Comment to be encoded with something else, for example using code page
950 "Big-5 Chinese". To fill that need, DotNetZip will encode the
comment following the same procedure it follows for encoding
filenames: (a) if <see cref="P:Ionic.Zip.ZipFile.AlternateEncodingUsage"/> is
<c>Never</c>, it uses the default encoding (IBM437). (b) if <see cref="P:Ionic.Zip.ZipFile.AlternateEncodingUsage"/> is <c>Always</c>, it always uses the
alternate encoding (<see cref="P:Ionic.Zip.ZipFile.AlternateEncoding"/>). (c) if <see cref="P:Ionic.Zip.ZipFile.AlternateEncodingUsage"/> is <c>AsNecessary</c>, it uses the
alternate encoding only if the default encoding is not sufficient for
encoding the comment - in other words if decoding the result does not
produce the original string. This decision is taken at the time of
the call to <c>ZipFile.Save()</c>.
</para>
<para>
When creating a zip archive using this library, it is possible to change
the value of <see cref="P:Ionic.Zip.ZipFile.AlternateEncoding"/> between each
entry you add, and between adding entries and the call to
<c>Save()</c>. Don't do this. It will likely result in a zip file that is
not readable by any tool or application. For best interoperability, leave
<see cref="P:Ionic.Zip.ZipFile.AlternateEncoding"/> alone, or specify it only
once, before adding any entries to the <c>ZipFile</c> instance.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.EmitTimesInWindowsFormatWhenSaving">
<summary>
Specifies whether the Creation, Access, and Modified times for entries
added to the zip file will be emitted in “Windows format”
when the zip archive is saved.
</summary>
<remarks>
<para>
An application creating a zip archive can use this flag to explicitly
specify that the file times for the entries should or should not be stored
in the zip archive in the format used by Windows. By default this flag is
<c>true</c>, meaning the Windows-format times are stored in the zip
archive.
</para>
<para>
When adding an entry from a file or directory, the Creation (<see cref="P:Ionic.Zip.ZipEntry.CreationTime"/>), Access (<see cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>), and Modified (<see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>) times for the given entry are
automatically set from the filesystem values. When adding an entry from a
stream or string, all three values are implicitly set to
<c>DateTime.Now</c>. Applications can also explicitly set those times by
calling <see cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/>.
</para>
<para>
<see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's
zip specification</see> describes multiple ways to format these times in a
zip file. One is the format Windows applications normally use: 100ns ticks
since January 1, 1601 UTC. The other is a format Unix applications typically
use: seconds since January 1, 1970 UTC. Each format can be stored in an
"extra field" in the zip entry when saving the zip archive. The former
uses an extra field with a Header Id of 0x000A, while the latter uses a
header ID of 0x5455, although you probably don't need to know that.
</para>
<para>
Not all tools and libraries can interpret these fields. Windows
compressed folders is one that can read the Windows Format timestamps,
while I believe <see href="http://www.info-zip.org/">the Infozip
tools</see> can read the Unix format timestamps. Some tools and libraries
may be able to read only one or the other. DotNetZip can read or write
times in either or both formats.
</para>
<para>
The times stored are taken from <see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>, <see cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>, and <see cref="P:Ionic.Zip.ZipEntry.CreationTime"/>.
</para>
<para>
The value set here applies to all entries subsequently added to the
<c>ZipFile</c>.
</para>
<para>
This property is not mutually exclusive of the <see cref="P:Ionic.Zip.ZipFile.EmitTimesInUnixFormatWhenSaving"/> property. It is possible and
legal and valid to produce a zip file that contains timestamps encoded in
the Unix format as well as in the Windows format, in addition to the <see cref="P:Ionic.Zip.ZipEntry.LastModified">LastModified</see> time attached to each
entry in the archive, a time that is always stored in "DOS format". And,
notwithstanding the names PKWare uses for these time formats, any of them
can be read and written by any computer, on any operating system. But,
there are no guarantees that a program running on Mac or Linux will
gracefully handle a zip file with "Windows" formatted times, or that an
application that does not use DotNetZip but runs on Windows will be able to
handle file times in Unix format.
</para>
<para>
When in doubt, test. Sorry, I haven't got a complete list of tools and
which sort of timestamps they can use and will tolerate. If you get any
good information and would like to pass it on, please do so and I will
include that information in this documentation.
</para>
</remarks>
<example>
This example shows how to save a zip file that contains file timestamps
in a format normally used by Unix.
<code lang="C#">
using (var zip = new ZipFile())
{
// produce a zip file the Mac will like
zip.EmitTimesInWindowsFormatWhenSaving = false;
zip.EmitTimesInUnixFormatWhenSaving = true;
zip.AddDirectory(directoryToZip, "files");
zip.Save(outputFile);
}
</code>
<code lang="VB">
Using zip As New ZipFile
'' produce a zip file the Mac will like
zip.EmitTimesInWindowsFormatWhenSaving = False
zip.EmitTimesInUnixFormatWhenSaving = True
zip.AddDirectory(directoryToZip, "files")
zip.Save(outputFile)
End Using
</code>
</example>
<seealso cref="P:Ionic.Zip.ZipEntry.EmitTimesInWindowsFormatWhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipFile.EmitTimesInUnixFormatWhenSaving"/>
</member>
<member name="P:Ionic.Zip.ZipFile.EmitTimesInUnixFormatWhenSaving">
<summary>
Specifies whether the Creation, Access, and Modified times
for entries added to the zip file will be emitted in "Unix(tm)
format" when the zip archive is saved.
</summary>
<remarks>
<para>
An application creating a zip archive can use this flag to explicitly
specify that the file times for the entries should or should not be stored
in the zip archive in the format used by Unix. By default this flag is
<c>false</c>, meaning the Unix-format times are not stored in the zip
archive.
</para>
<para>
When adding an entry from a file or directory, the Creation (<see cref="P:Ionic.Zip.ZipEntry.CreationTime"/>), Access (<see cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>), and Modified (<see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>) times for the given entry are
automatically set from the filesystem values. When adding an entry from a
stream or string, all three values are implicitly set to DateTime.Now.
Applications can also explicitly set those times by calling <see cref="M:Ionic.Zip.ZipEntry.SetEntryTimes(System.DateTime,System.DateTime,System.DateTime)"/>.
</para>
<para>
<see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's
zip specification</see> describes multiple ways to format these times in a
zip file. One is the format Windows applications normally use: 100ns ticks
since January 1, 1601 UTC. The other is a format Unix applications
typically use: seconds since January 1, 1970 UTC. Each format can be
stored in an "extra field" in the zip entry when saving the zip
archive. The former uses an extra field with a Header Id of 0x000A, while
the latter uses a header ID of 0x5455, although you probably don't need to
know that.
</para>
<para>
Not all tools and libraries can interpret these fields. Windows
compressed folders is one that can read the Windows Format timestamps,
while I believe the <see href="http://www.info-zip.org/">Infozip</see>
tools can read the Unix format timestamps. Some tools and libraries may be
able to read only one or the other. DotNetZip can read or write times in
either or both formats.
</para>
<para>
The times stored are taken from <see cref="P:Ionic.Zip.ZipEntry.ModifiedTime"/>, <see cref="P:Ionic.Zip.ZipEntry.AccessedTime"/>, and <see cref="P:Ionic.Zip.ZipEntry.CreationTime"/>.
</para>
<para>
This property is not mutually exclusive of the <see cref="P:Ionic.Zip.ZipFile.EmitTimesInWindowsFormatWhenSaving"/> property. It is possible and
legal and valid to produce a zip file that contains timestamps encoded in
the Unix format as well as in the Windows format, in addition to the <see cref="P:Ionic.Zip.ZipEntry.LastModified">LastModified</see> time attached to each
entry in the zip archive, a time that is always stored in "DOS
format". And, notwithstanding the names PKWare uses for these time
formats, any of them can be read and written by any computer, on any
operating system. But, there are no guarantees that a program running on
Mac or Linux will gracefully handle a zip file with "Windows" formatted
times, or that an application that does not use DotNetZip but runs on
Windows will be able to handle file times in Unix format.
</para>
<para>
When in doubt, test. Sorry, I haven't got a complete list of tools and
which sort of timestamps they can use and will tolerate. If you get any
good information and would like to pass it on, please do so and I will
include that information in this documentation.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.EmitTimesInUnixFormatWhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipFile.EmitTimesInWindowsFormatWhenSaving"/>
</member>
<member name="P:Ionic.Zip.ZipFile.Verbose">
<summary>
Indicates whether verbose output is sent to the <see cref="P:Ionic.Zip.ZipFile.StatusMessageTextWriter"/> during <c>AddXxx()</c> and
<c>ReadXxx()</c> operations.
</summary>
<remarks>
This is a <em>synthetic</em> property. It returns true if the <see cref="P:Ionic.Zip.ZipFile.StatusMessageTextWriter"/> is non-null.
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.CaseSensitiveRetrieval">
<summary>
Indicates whether to perform case-sensitive matching on the filename when
retrieving entries in the zipfile via the string-based indexer.
</summary>
<remarks>
The default value is <c>false</c>, which means don't do case-sensitive
matching. In other words, retrieving zip["ReadMe.Txt"] is the same as
zip["readme.txt"]. It really makes sense to set this to <c>true</c> only
if you are not running on Windows, which has case-insensitive
filenames. But since this library is not built for non-Windows platforms,
in most cases you should just leave this property alone.
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.UseUnicodeAsNecessary">
<summary>
Indicates whether to encode entry filenames and entry comments using Unicode
(UTF-8).
</summary>
<remarks>
<para>
<see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">The
PKWare zip specification</see> provides for encoding file names and file
comments in either the IBM437 code page, or in UTF-8. This flag selects
the encoding according to that specification. By default, this flag is
false, and filenames and comments are encoded into the zip file in the
IBM437 codepage. Setting this flag to true will specify that filenames
and comments that cannot be encoded with IBM437 will be encoded with
UTF-8.
</para>
<para>
Zip files created with strict adherence to the PKWare specification with
respect to UTF-8 encoding can contain entries with filenames containing
any combination of Unicode characters, including the full range of
characters from Chinese, Latin, Hebrew, Greek, Cyrillic, and many other
alphabets. However, because at this time, the UTF-8 portion of the PKWare
specification is not broadly supported by other zip libraries and
utilities, such zip files may not be readable by your favorite zip tool or
archiver. In other words, interoperability will decrease if you set this
flag to true.
</para>
<para>
In particular, Zip files created with strict adherence to the PKWare
specification with respect to UTF-8 encoding will not work well with
Explorer in Windows XP or Windows Vista, because Windows compressed
folders, as far as I know, do not support UTF-8 in zip files. Vista can
read the zip files, but shows the filenames incorrectly. Unpacking from
Windows Vista Explorer will result in filenames that have rubbish
characters in place of the high-order UTF-8 bytes.
</para>
<para>
Also, zip files that use UTF-8 encoding will not work well with Java
applications that use the java.util.zip classes, as of v5.0 of the Java
runtime. The Java runtime does not correctly implement the PKWare
specification in this regard.
</para>
<para>
As a result, we have the unfortunate situation that "correct" behavior by
the DotNetZip library with regard to Unicode encoding of filenames during
zip creation will result in zip files that are readable by strictly
compliant and current tools (for example the most recent release of the
commercial WinZip tool); but these zip files will not be readable by
various other tools or libraries, including Windows Explorer.
</para>
<para>
The DotNetZip library can read and write zip files with UTF8-encoded
entries, according to the PKware spec. If you use DotNetZip for both
creating and reading the zip file, and you use UTF-8, there will be no
loss of information in the filenames. For example, using a self-extractor
created by this library will allow you to unpack files correctly with no
loss of information in the filenames.
</para>
<para>
If you do not set this flag, it will remain false. If this flag is false,
your <c>ZipFile</c> will encode all filenames and comments using the
IBM437 codepage. This can cause "loss of information" on some filenames,
but the resulting zipfile will be more interoperable with other
utilities. As an example of the loss of information, diacritics can be
lost. The o-tilde character will be down-coded to plain o. The c with a
cedilla (Unicode 0xE7) used in Portugese will be downcoded to a c.
Likewise, the O-stroke character (Unicode 248), used in Danish and
Norwegian, will be down-coded to plain o. Chinese characters cannot be
represented in codepage IBM437; when using the default encoding, Chinese
characters in filenames will be represented as ?. These are all examples
of "information loss".
</para>
<para>
The loss of information associated to the use of the IBM437 encoding is
inconvenient, and can also lead to runtime errors. For example, using
IBM437, any sequence of 4 Chinese characters will be encoded as ????. If
your application creates a <c>ZipFile</c>, then adds two files, each with
names of four Chinese characters each, this will result in a duplicate
filename exception. In the case where you add a single file with a name
containing four Chinese characters, calling Extract() on the entry that
has question marks in the filename will result in an exception, because
the question mark is not legal for use within filenames on Windows. These
are just a few examples of the problems associated to loss of information.
</para>
<para>
This flag is independent of the encoding of the content within the entries
in the zip file. Think of the zip file as a container - it supports an
encoding. Within the container are other "containers" - the file entries
themselves. The encoding within those entries is independent of the
encoding of the zip archive container for those entries.
</para>
<para>
Rather than specify the encoding in a binary fashion using this flag, an
application can specify an arbitrary encoding via the <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/> property. Setting the encoding
explicitly when creating zip archives will result in non-compliant zip
files that, curiously, are fairly interoperable. The challenge is, the
PKWare specification does not provide for a way to specify that an entry
in a zip archive uses a code page that is neither IBM437 nor UTF-8.
Therefore if you set the encoding explicitly when creating a zip archive,
you must take care upon reading the zip archive to use the same code page.
If you get it wrong, the behavior is undefined and may result in incorrect
filenames, exceptions, stomach upset, hair loss, and acne.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>
</member>
<member name="P:Ionic.Zip.ZipFile.UseZip64WhenSaving">
<summary>
Specify whether to use ZIP64 extensions when saving a zip archive.
</summary>
<remarks>
<para>
When creating a zip file, the default value for the property is <see cref="F:Ionic.Zip.Zip64Option.Never"/>. <see cref="F:Ionic.Zip.Zip64Option.AsNecessary"/> is
safest, in the sense that you will not get an Exception if a pre-ZIP64
limit is exceeded.
</para>
<para>
You may set the property at any time before calling Save().
</para>
<para>
When reading a zip file via the <c>Zipfile.Read()</c> method, DotNetZip
will properly read ZIP64-endowed zip archives, regardless of the value of
this property. DotNetZip will always read ZIP64 archives. This property
governs only whether DotNetZip will write them. Therefore, when updating
archives, be careful about setting this property after reading an archive
that may use ZIP64 extensions.
</para>
<para>
An interesting question is, if you have set this property to
<c>AsNecessary</c>, and then successfully saved, does the resulting
archive use ZIP64 extensions or not? To learn this, check the <see cref="P:Ionic.Zip.ZipFile.OutputUsedZip64"/> property, after calling <c>Save()</c>.
</para>
<para>
Have you thought about
<see href="http://cheeso.members.winisp.net/DotNetZipDonate.aspx">donating</see>?
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.RequiresZip64"/>
</member>
<member name="P:Ionic.Zip.ZipFile.RequiresZip64">
<summary>
Indicates whether the archive requires ZIP64 extensions.
</summary>
<remarks>
<para>
This property is <c>null</c> (or <c>Nothing</c> in VB) if the archive has
not been saved, and there are fewer than 65334 <c>ZipEntry</c> items
contained in the archive.
</para>
<para>
The <c>Value</c> is true if any of the following four conditions holds:
the uncompressed size of any entry is larger than 0xFFFFFFFF; the
compressed size of any entry is larger than 0xFFFFFFFF; the relative
offset of any entry within the zip archive is larger than 0xFFFFFFFF; or
there are more than 65534 entries in the archive. (0xFFFFFFFF =
4,294,967,295). The result may not be known until a <c>Save()</c> is attempted
on the zip archive. The Value of this <see cref="T:System.Nullable"/>
property may be set only AFTER one of the Save() methods has been called.
</para>
<para>
If none of the four conditions holds, and the archive has been saved, then
the <c>Value</c> is false.
</para>
<para>
A <c>Value</c> of false does not indicate that the zip archive, as saved,
does not use ZIP64. It merely indicates that ZIP64 is not required. An
archive may use ZIP64 even when not required if the <see cref="P:Ionic.Zip.ZipFile.UseZip64WhenSaving"/> property is set to <see cref="F:Ionic.Zip.Zip64Option.Always"/>, or if the <see cref="P:Ionic.Zip.ZipFile.UseZip64WhenSaving"/> property is set to <see cref="F:Ionic.Zip.Zip64Option.AsNecessary"/> and the output stream was not
seekable. Use the <see cref="P:Ionic.Zip.ZipFile.OutputUsedZip64"/> property to determine if
the most recent <c>Save()</c> method resulted in an archive that utilized
the ZIP64 extensions.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.UseZip64WhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipFile.OutputUsedZip64"/>
</member>
<member name="P:Ionic.Zip.ZipFile.OutputUsedZip64">
<summary>
Indicates whether the most recent <c>Save()</c> operation used ZIP64 extensions.
</summary>
<remarks>
<para>
The use of ZIP64 extensions within an archive is not always necessary, and
for interoperability concerns, it may be desired to NOT use ZIP64 if
possible. The <see cref="P:Ionic.Zip.ZipFile.UseZip64WhenSaving"/> property can be
set to use ZIP64 extensions only when necessary. In those cases,
Sometimes applications want to know whether a Save() actually used ZIP64
extensions. Applications can query this read-only property to learn
whether ZIP64 has been used in a just-saved <c>ZipFile</c>.
</para>
<para>
The value is <c>null</c> (or <c>Nothing</c> in VB) if the archive has not
been saved.
</para>
<para>
Non-null values (<c>HasValue</c> is true) indicate whether ZIP64
extensions were used during the most recent <c>Save()</c> operation. The
ZIP64 extensions may have been used as required by any particular entry
because of its uncompressed or compressed size, or because the archive is
larger than 4294967295 bytes, or because there are more than 65534 entries
in the archive, or because the <c>UseZip64WhenSaving</c> property was set
to <see cref="F:Ionic.Zip.Zip64Option.Always"/>, or because the
<c>UseZip64WhenSaving</c> property was set to <see cref="F:Ionic.Zip.Zip64Option.AsNecessary"/> and the output stream was not seekable.
The value of this property does not indicate the reason the ZIP64
extensions were used.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.UseZip64WhenSaving"/>
<seealso cref="P:Ionic.Zip.ZipFile.RequiresZip64"/>
</member>
<member name="P:Ionic.Zip.ZipFile.InputUsesZip64">
<summary>
Indicates whether the most recent <c>Read()</c> operation read a zip file that uses
ZIP64 extensions.
</summary>
<remarks>
This property will return null (Nothing in VB) if you've added an entry after reading
the zip file.
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding">
<summary>
The text encoding to use when writing new entries to the <c>ZipFile</c>,
for those entries that cannot be encoded with the default (IBM437)
encoding; or, the text encoding that was used when reading the entries
from the <c>ZipFile</c>.
</summary>
<remarks>
<para>
In <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">its
zip specification</see>, PKWare describes two options for encoding
filenames and comments: using IBM437 or UTF-8. But, some archiving tools
or libraries do not follow the specification, and instead encode
characters using the system default code page. For example, WinRAR when
run on a machine in Shanghai may encode filenames with the Big-5 Chinese
(950) code page. This behavior is contrary to the Zip specification, but
it occurs anyway.
</para>
<para>
When using DotNetZip to write zip archives that will be read by one of
these other archivers, set this property to specify the code page to use
when encoding the <see cref="P:Ionic.Zip.ZipEntry.FileName"/> and <see cref="P:Ionic.Zip.ZipEntry.Comment"/> for each <c>ZipEntry</c> in the zip file, for
values that cannot be encoded with the default codepage for zip files,
IBM437. This is why this property is "provisional". In all cases, IBM437
is used where possible, in other words, where no loss of data would
result. It is possible, therefore, to have a given entry with a
<c>Comment</c> encoded in IBM437 and a <c>FileName</c> encoded with the
specified "provisional" codepage.
</para>
<para>
Be aware that a zip file created after you've explicitly set the <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/> property to a value other than
IBM437 may not be compliant to the PKWare specification, and may not be
readable by compliant archivers. On the other hand, many (most?)
archivers are non-compliant and can read zip files created in arbitrary
code pages. The trick is to use or specify the proper codepage when
reading the zip.
</para>
<para>
When creating a zip archive using this library, it is possible to change
the value of <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/> between each
entry you add, and between adding entries and the call to
<c>Save()</c>. Don't do this. It will likely result in a zipfile that is
not readable. For best interoperability, either leave <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/> alone, or specify it only once,
before adding any entries to the <c>ZipFile</c> instance. There is one
exception to this recommendation, described later.
</para>
<para>
When using an arbitrary, non-UTF8 code page for encoding, there is no
standard way for the creator application - whether DotNetZip, WinZip,
WinRar, or something else - to formally specify in the zip file which
codepage has been used for the entries. As a result, readers of zip files
are not able to inspect the zip file and determine the codepage that was
used for the entries contained within it. It is left to the application
or user to determine the necessary codepage when reading zip files encoded
this way. In other words, if you explicitly specify the codepage when you
create the zipfile, you must explicitly specify the same codepage when
reading the zipfile.
</para>
<para>
The way you specify the code page to use when reading a zip file varies
depending on the tool or library you use to read the zip. In DotNetZip,
you use a ZipFile.Read() method that accepts an encoding parameter. It
isn't possible with Windows Explorer, as far as I know, to specify an
explicit codepage to use when reading a zip. If you use an incorrect
codepage when reading a zipfile, you will get entries with filenames that
are incorrect, and the incorrect filenames may even contain characters
that are not legal for use within filenames in Windows. Extracting entries
with illegal characters in the filenames will lead to exceptions. It's too
bad, but this is just the way things are with code pages in zip
files. Caveat Emptor.
</para>
<para>
Example: Suppose you create a zipfile that contains entries with
filenames that have Danish characters. If you use <see cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/> equal to "iso-8859-1" (cp 28591),
the filenames will be correctly encoded in the zip. But, to read that
zipfile correctly, you have to specify the same codepage at the time you
read it. If try to read that zip file with Windows Explorer or another
application that is not flexible with respect to the codepage used to
decode filenames in zipfiles, you will get a filename like "Inf°.txt".
</para>
<para>
When using DotNetZip to read a zip archive, and the zip archive uses an
arbitrary code page, you must specify the encoding to use before or when
the <c>Zipfile</c> is READ. This means you must use a <c>ZipFile.Read()</c>
method that allows you to specify a System.Text.Encoding parameter. Setting
the ProvisionalAlternateEncoding property after your application has read in
the zip archive will not affect the entry names of entries that have already
been read in.
</para>
<para>
And now, the exception to the rule described above. One strategy for
specifying the code page for a given zip file is to describe the code page
in a human-readable form in the Zip comment. For example, the comment may
read "Entries in this archive are encoded in the Big5 code page". For
maximum interoperability, the zip comment in this case should be encoded
in the default, IBM437 code page. In this case, the zip comment is
encoded using a different page than the filenames. To do this, Specify
<c>ProvisionalAlternateEncoding</c> to your desired region-specific code
page, once before adding any entries, and then reset
<c>ProvisionalAlternateEncoding</c> to IBM437 before setting the <see cref="P:Ionic.Zip.ZipFile.Comment"/> property and calling Save().
</para>
</remarks>
<example>
This example shows how to read a zip file using the Big-5 Chinese code page
(950), and extract each entry in the zip file. For this code to work as
desired, the <c>Zipfile</c> must have been created using the big5 code page
(CP950). This is typical, for example, when using WinRar on a machine with
CP950 set as the default code page. In that case, the names of entries
within the Zip archive will be stored in that code page, and reading the zip
archive must be done using that code page. If the application did not use
the correct code page in <c>ZipFile.Read()</c>, then names of entries within the
zip archive would not be correctly retrieved.
<code>
using (var zip = ZipFile.Read(zipFileName, System.Text.Encoding.GetEncoding("big5")))
{
// retrieve and extract an entry using a name encoded with CP950
zip[MyDesiredEntry].Extract("unpack");
}
</code>
<code lang="VB">
Using zip As ZipFile = ZipFile.Read(ZipToExtract, System.Text.Encoding.GetEncoding("big5"))
' retrieve and extract an entry using a name encoded with CP950
zip(MyDesiredEntry).Extract("unpack")
End Using
</code>
</example>
<seealso cref="P:Ionic.Zip.ZipFile.DefaultEncoding">DefaultEncoding</seealso>
</member>
<member name="P:Ionic.Zip.ZipFile.AlternateEncoding">
<summary>
A Text Encoding to use when encoding the filenames and comments for
all the ZipEntry items, during a ZipFile.Save() operation.
</summary>
<remarks>
<para>
Whether the encoding specified here is used during the save depends
on <see cref="P:Ionic.Zip.ZipFile.AlternateEncodingUsage"/>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.AlternateEncodingUsage">
<summary>
A flag that tells if and when this instance should apply
AlternateEncoding to encode the filenames and comments associated to
of ZipEntry objects contained within this instance.
</summary>
</member>
<member name="P:Ionic.Zip.ZipFile.DefaultEncoding">
<summary>
The default text encoding used in zip archives. It is numeric 437, also
known as IBM437.
</summary>
<seealso cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>
</member>
<member name="P:Ionic.Zip.ZipFile.StatusMessageTextWriter">
<summary>
Gets or sets the <c>TextWriter</c> to which status messages are delivered
for the instance.
</summary>
<remarks>
If the TextWriter is set to a non-null value, then verbose output is sent
to the <c>TextWriter</c> during <c>Add</c><c>, Read</c><c>, Save</c> and
<c>Extract</c> operations. Typically, console applications might use
<c>Console.Out</c> and graphical or headless applications might use a
<c>System.IO.StringWriter</c>. The output of this is suitable for viewing
by humans.
</remarks>
<example>
<para>
In this example, a console application instantiates a <c>ZipFile</c>, then
sets the <c>StatusMessageTextWriter</c> to <c>Console.Out</c>. At that
point, all verbose status messages for that <c>ZipFile</c> are sent to the
console.
</para>
<code lang="C#">
using (ZipFile zip= ZipFile.Read(FilePath))
{
zip.StatusMessageTextWriter= System.Console.Out;
// messages are sent to the console during extraction
zip.ExtractAll();
}
</code>
<code lang="VB">
Using zip As ZipFile = ZipFile.Read(FilePath)
zip.StatusMessageTextWriter= System.Console.Out
'Status Messages will be sent to the console during extraction
zip.ExtractAll()
End Using
</code>
<para>
In this example, a Windows Forms application instantiates a
<c>ZipFile</c>, then sets the <c>StatusMessageTextWriter</c> to a
<c>StringWriter</c>. At that point, all verbose status messages for that
<c>ZipFile</c> are sent to the <c>StringWriter</c>.
</para>
<code lang="C#">
var sw = new System.IO.StringWriter();
using (ZipFile zip= ZipFile.Read(FilePath))
{
zip.StatusMessageTextWriter= sw;
zip.ExtractAll();
}
Console.WriteLine("{0}", sw.ToString());
</code>
<code lang="VB">
Dim sw as New System.IO.StringWriter
Using zip As ZipFile = ZipFile.Read(FilePath)
zip.StatusMessageTextWriter= sw
zip.ExtractAll()
End Using
'Status Messages are now available in sw
</code>
</example>
</member>
<member name="P:Ionic.Zip.ZipFile.TempFileFolder">
<summary>
Gets or sets the name for the folder to store the temporary file
this library writes when saving a zip archive.
</summary>
<remarks>
<para>
This library will create a temporary file when saving a Zip archive to a
file. This file is written when calling one of the <c>Save()</c> methods
that does not save to a stream, or one of the <c>SaveSelfExtractor()</c>
methods.
</para>
<para>
By default, the library will create the temporary file in the directory
specified for the file itself, via the <see cref="P:Ionic.Zip.ZipFile.Name"/> property or via
the <see cref="M:Ionic.Zip.ZipFile.Save(System.String)"/> method.
</para>
<para>
Setting this property allows applications to override this default
behavior, so that the library will create the temporary file in the
specified folder. For example, to have the library create the temporary
file in the current working directory, regardless where the <c>ZipFile</c>
is saved, specfy ".". To revert to the default behavior, set this
property to <c>null</c> (<c>Nothing</c> in VB).
</para>
<para>
When setting the property to a non-null value, the folder specified must
exist; if it does not an exception is thrown. The application should have
write and delete permissions on the folder. The permissions are not
explicitly checked ahead of time; if the application does not have the
appropriate rights, an exception will be thrown at the time <c>Save()</c>
is called.
</para>
<para>
There is no temporary file created when reading a zip archive. When
saving to a Stream, there is no temporary file created. For example, if
the application is an ASP.NET application and calls <c>Save()</c>
specifying the <c>Response.OutputStream</c> as the output stream, there is
no temporary file created.
</para>
</remarks>
<exception cref="T:System.IO.FileNotFoundException">
Thrown when setting the property if the directory does not exist.
</exception>
</member>
<member name="P:Ionic.Zip.ZipFile.Password">
<summary>
Sets the password to be used on the <c>ZipFile</c> instance.
</summary>
<remarks>
<para>
When writing a zip archive, this password is applied to the entries, not
to the zip archive itself. It applies to any <c>ZipEntry</c> subsequently
added to the <c>ZipFile</c>, using one of the <c>AddFile</c>,
<c>AddDirectory</c>, <c>AddEntry</c>, or <c>AddItem</c> methods, etc.
When reading a zip archive, this property applies to any entry
subsequently extracted from the <c>ZipFile</c> using one of the Extract
methods on the <c>ZipFile</c> class.
</para>
<para>
When writing a zip archive, keep this in mind: though the password is set
on the ZipFile object, according to the Zip spec, the "directory" of the
archive - in other words the list of entries or files contained in the archive - is
not encrypted with the password, or protected in any way. If you set the
Password property, the password actually applies to individual entries
that are added to the archive, subsequent to the setting of this property.
The list of filenames in the archive that is eventually created will
appear in clear text, but the contents of the individual files are
encrypted. This is how Zip encryption works.
</para>
<para>
One simple way around this limitation is to simply double-wrap sensitive
filenames: Store the files in a zip file, and then store that zip file
within a second, "outer" zip file. If you apply a password to the outer
zip file, then readers will be able to see that the outer zip file
contains an inner zip file. But readers will not be able to read the
directory or file list of the inner zip file.
</para>
<para>
If you set the password on the <c>ZipFile</c>, and then add a set of files
to the archive, then each entry is encrypted with that password. You may
also want to change the password between adding different entries. If you
set the password, add an entry, then set the password to <c>null</c>
(<c>Nothing</c> in VB), and add another entry, the first entry is
encrypted and the second is not. If you call <c>AddFile()</c>, then set
the <c>Password</c> property, then call <c>ZipFile.Save</c>, the file
added will not be password-protected, and no warning will be generated.
</para>
<para>
When setting the Password, you may also want to explicitly set the <see cref="P:Ionic.Zip.ZipFile.Encryption"/> property, to specify how to encrypt the entries added
to the ZipFile. If you set the Password to a non-null value and do not
set <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, then PKZip 2.0 ("Weak") encryption is used.
This encryption is relatively weak but is very interoperable. If you set
the password to a <c>null</c> value (<c>Nothing</c> in VB), Encryption is
reset to None.
</para>
<para>
All of the preceding applies to writing zip archives, in other words when
you use one of the Save methods. To use this property when reading or an
existing ZipFile, do the following: set the Password property on the
<c>ZipFile</c>, then call one of the Extract() overloads on the <see cref="T:Ionic.Zip.ZipEntry"/>. In this case, the entry is extracted using the
<c>Password</c> that is specified on the <c>ZipFile</c> instance. If you
have not set the <c>Password</c> property, then the password is
<c>null</c>, and the entry is extracted with no password.
</para>
<para>
If you set the Password property on the <c>ZipFile</c>, then call
<c>Extract()</c> an entry that has not been encrypted with a password, the
password is not used for that entry, and the <c>ZipEntry</c> is extracted
as normal. In other words, the password is used only if necessary.
</para>
<para>
The <see cref="T:Ionic.Zip.ZipEntry"/> class also has a <see cref="P:Ionic.Zip.ZipEntry.Password">Password</see> property. It takes precedence
over this property on the <c>ZipFile</c>. Typically, you would use the
per-entry Password when most entries in the zip archive use one password,
and a few entries use a different password. If all entries in the zip
file use the same password, then it is simpler to just set this property
on the <c>ZipFile</c> itself, whether creating a zip archive or extracting
a zip archive.
</para>
</remarks>
<example>
<para>
This example creates a zip file, using password protection for the
entries, and then extracts the entries from the zip file. When creating
the zip file, the Readme.txt file is not protected with a password, but
the other two are password-protected as they are saved. During extraction,
each file is extracted with the appropriate password.
</para>
<code>
// create a file with encryption
using (ZipFile zip = new ZipFile())
{
zip.AddFile("ReadMe.txt");
zip.Password= "!Secret1";
zip.AddFile("MapToTheSite-7440-N49th.png");
zip.AddFile("2008-Regional-Sales-Report.pdf");
zip.Save("EncryptedArchive.zip");
}
// extract entries that use encryption
using (ZipFile zip = ZipFile.Read("EncryptedArchive.zip"))
{
zip.Password= "!Secret1";
zip.ExtractAll("extractDir");
}
</code>
<code lang="VB">
Using zip As New ZipFile
zip.AddFile("ReadMe.txt")
zip.Password = "123456!"
zip.AddFile("MapToTheSite-7440-N49th.png")
zip.Password= "!Secret1";
zip.AddFile("2008-Regional-Sales-Report.pdf")
zip.Save("EncryptedArchive.zip")
End Using
' extract entries that use encryption
Using (zip as ZipFile = ZipFile.Read("EncryptedArchive.zip"))
zip.Password= "!Secret1"
zip.ExtractAll("extractDir")
End Using
</code>
</example>
<seealso cref="P:Ionic.Zip.ZipFile.Encryption">ZipFile.Encryption</seealso>
<seealso cref="P:Ionic.Zip.ZipEntry.Password">ZipEntry.Password</seealso>
</member>
<member name="P:Ionic.Zip.ZipFile.ExtractExistingFile">
<summary>
The action the library should take when extracting a file that already
exists.
</summary>
<remarks>
<para>
This property affects the behavior of the Extract methods (one of the
<c>Extract()</c> or <c>ExtractWithPassword()</c> overloads), when
extraction would would overwrite an existing filesystem file. If you do
not set this property, the library throws an exception when extracting an
entry would overwrite an existing file.
</para>
<para>
This property has no effect when extracting to a stream, or when the file
to be extracted does not already exist.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipEntry.ExtractExistingFile"/>
</member>
<member name="P:Ionic.Zip.ZipFile.ZipErrorAction">
<summary>
The action the library should take when an error is encountered while
opening or reading files as they are saved into a zip archive.
</summary>
<remarks>
<para>
Errors can occur as a file is being saved to the zip archive. For
example, the File.Open may fail, or a File.Read may fail, because of
lock conflicts or other reasons.
</para>
<para>
The first problem might occur after having called AddDirectory() on a
directory that contains a Clipper .dbf file; the file is locked by
Clipper and cannot be opened for read by another process. An example of
the second problem might occur when trying to zip a .pst file that is in
use by Microsoft Outlook. Outlook locks a range on the file, which allows
other processes to open the file, but not read it in its entirety.
</para>
<para>
This property tells DotNetZip what you would like to do in the case of
these errors. The primary options are: <c>ZipErrorAction.Throw</c> to
throw an exception (this is the default behavior if you don't set this
property); <c>ZipErrorAction.Skip</c> to Skip the file for which there
was an error and continue saving; <c>ZipErrorAction.Retry</c> to Retry
the entry that caused the problem; or
<c>ZipErrorAction.InvokeErrorEvent</c> to invoke an event handler.
</para>
<para>
This property is implicitly set to <c>ZipErrorAction.InvokeErrorEvent</c>
if you add a handler to the <see cref="E:Ionic.Zip.ZipFile.ZipError"/> event. If you set
this property to something other than
<c>ZipErrorAction.InvokeErrorEvent</c>, then the <c>ZipError</c>
event is implicitly cleared. What it means is you can set one or the
other (or neither), depending on what you want, but you never need to set
both.
</para>
<para>
As with some other properties on the <c>ZipFile</c> class, like <see cref="P:Ionic.Zip.ZipFile.Password"/>, <see cref="P:Ionic.Zip.ZipFile.Encryption"/>, and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, setting this property on a <c>ZipFile</c>
instance will cause the specified <c>ZipErrorAction</c> to be used on all
<see cref="T:Ionic.Zip.ZipEntry"/> items that are subsequently added to the
<c>ZipFile</c> instance. If you set this property after you have added
items to the <c>ZipFile</c>, but before you have called <c>Save()</c>,
those items will not use the specified error handling action.
</para>
<para>
If you want to handle any errors that occur with any entry in the zip
file in the same way, then set this property once, before adding any
entries to the zip archive.
</para>
<para>
If you set this property to <c>ZipErrorAction.Skip</c> and you'd like to
learn which files may have been skipped after a <c>Save()</c>, you can
set the <see cref="P:Ionic.Zip.ZipFile.StatusMessageTextWriter"/> on the ZipFile before
calling <c>Save()</c>. A message will be emitted into that writer for
each skipped file, if any.
</para>
</remarks>
<example>
This example shows how to tell DotNetZip to skip any files for which an
error is generated during the Save().
<code lang="VB">
Public Sub SaveZipFile()
Dim SourceFolder As String = "fodder"
Dim DestFile As String = "eHandler.zip"
Dim sw as New StringWriter
Using zipArchive As ZipFile = New ZipFile
' Tell DotNetZip to skip any files for which it encounters an error
zipArchive.ZipErrorAction = ZipErrorAction.Skip
zipArchive.StatusMessageTextWriter = sw
zipArchive.AddDirectory(SourceFolder)
zipArchive.Save(DestFile)
End Using
' examine sw here to see any messages
End Sub
</code>
</example>
<seealso cref="P:Ionic.Zip.ZipEntry.ZipErrorAction"/>
<seealso cref="E:Ionic.Zip.ZipFile.ZipError"/>
</member>
<member name="P:Ionic.Zip.ZipFile.Encryption">
<summary>
The Encryption to use for entries added to the <c>ZipFile</c>.
</summary>
<remarks>
<para>
Set this when creating a zip archive, or when updating a zip archive. The
specified Encryption is applied to the entries subsequently added to the
<c>ZipFile</c> instance. Applications do not need to set the
<c>Encryption</c> property when reading or extracting a zip archive.
</para>
<para>
If you set this to something other than EncryptionAlgorithm.None, you
will also need to set the <see cref="P:Ionic.Zip.ZipFile.Password"/>.
</para>
<para>
As with some other properties on the <c>ZipFile</c> class, like <see cref="P:Ionic.Zip.ZipFile.Password"/> and <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/>, setting this
property on a <c>ZipFile</c> instance will cause the specified
<c>EncryptionAlgorithm</c> to be used on all <see cref="T:Ionic.Zip.ZipEntry"/> items
that are subsequently added to the <c>ZipFile</c> instance. In other
words, if you set this property after you have added items to the
<c>ZipFile</c>, but before you have called <c>Save()</c>, those items will
not be encrypted or protected with a password in the resulting zip
archive. To get a zip archive with encrypted entries, set this property,
along with the <see cref="P:Ionic.Zip.ZipFile.Password"/> property, before calling
<c>AddFile</c>, <c>AddItem</c>, or <c>AddDirectory</c> (etc.) on the
<c>ZipFile</c> instance.
</para>
<para>
If you read a <c>ZipFile</c>, you can modify the <c>Encryption</c> on an
encrypted entry, only by setting the <c>Encryption</c> property on the
<c>ZipEntry</c> itself. Setting the <c>Encryption</c> property on the
<c>ZipFile</c>, once it has been created via a call to
<c>ZipFile.Read()</c>, does not affect entries that were previously read.
</para>
<para>
For example, suppose you read a <c>ZipFile</c>, and there is an encrypted
entry. Setting the <c>Encryption</c> property on that <c>ZipFile</c> and
then calling <c>Save()</c> on the <c>ZipFile</c> does not update the
<c>Encryption</c> used for the entries in the archive. Neither is an
exception thrown. Instead, what happens during the <c>Save()</c> is that
all previously existing entries are copied through to the new zip archive,
with whatever encryption and password that was used when originally
creating the zip archive. Upon re-reading that archive, to extract
entries, applications should use the original password or passwords, if
any.
</para>
<para>
Suppose an application reads a <c>ZipFile</c>, and there is an encrypted
entry. Setting the <c>Encryption</c> property on that <c>ZipFile</c> and
then adding new entries (via <c>AddFile()</c>, <c>AddEntry()</c>, etc)
and then calling <c>Save()</c> on the <c>ZipFile</c> does not update the
<c>Encryption</c> on any of the entries that had previously been in the
<c>ZipFile</c>. The <c>Encryption</c> property applies only to the
newly-added entries.
</para>
</remarks>
<example>
<para>
This example creates a zip archive that uses encryption, and then extracts
entries from the archive. When creating the zip archive, the ReadMe.txt
file is zipped without using a password or encryption. The other files
use encryption.
</para>
<code>
// Create a zip archive with AES Encryption.
using (ZipFile zip = new ZipFile())
{
zip.AddFile("ReadMe.txt");
zip.Encryption= EncryptionAlgorithm.WinZipAes256;
zip.Password= "Top.Secret.No.Peeking!";
zip.AddFile("7440-N49th.png");
zip.AddFile("2008-Regional-Sales-Report.pdf");
zip.Save("EncryptedArchive.zip");
}
// Extract a zip archive that uses AES Encryption.
// You do not need to specify the algorithm during extraction.
using (ZipFile zip = ZipFile.Read("EncryptedArchive.zip"))
{
zip.Password= "Top.Secret.No.Peeking!";
zip.ExtractAll("extractDirectory");
}
</code>
<code lang="VB">
' Create a zip that uses Encryption.
Using zip As New ZipFile()
zip.Encryption= EncryptionAlgorithm.WinZipAes256
zip.Password= "Top.Secret.No.Peeking!"
zip.AddFile("ReadMe.txt")
zip.AddFile("7440-N49th.png")
zip.AddFile("2008-Regional-Sales-Report.pdf")
zip.Save("EncryptedArchive.zip")
End Using
' Extract a zip archive that uses AES Encryption.
' You do not need to specify the algorithm during extraction.
Using (zip as ZipFile = ZipFile.Read("EncryptedArchive.zip"))
zip.Password= "Top.Secret.No.Peeking!"
zip.ExtractAll("extractDirectory")
End Using
</code>
</example>
<seealso cref="P:Ionic.Zip.ZipFile.Password">ZipFile.Password</seealso>
<seealso cref="P:Ionic.Zip.ZipEntry.Encryption">ZipEntry.Encryption</seealso>
</member>
<member name="P:Ionic.Zip.ZipFile.SetCompression">
<summary>
A callback that allows the application to specify the compression level
to use for entries subsequently added to the zip archive.
</summary>
<remarks>
<para>
With this callback, the DotNetZip library allows the application to
determine whether compression will be used, at the time of the
<c>Save</c>. This may be useful if the application wants to favor
speed over size, and wants to defer the decision until the time of
<c>Save</c>.
</para>
<para>
Typically applications set the <see cref="P:Ionic.Zip.ZipFile.CompressionLevel"/> property on
the <c>ZipFile</c> or on each <c>ZipEntry</c> to determine the level of
compression used. This is done at the time the entry is added to the
<c>ZipFile</c>. Setting the property to
<c>Ionic.Zlib.CompressionLevel.None</c> means no compression will be used.
</para>
<para>
This callback allows the application to defer the decision on the
<c>CompressionLevel</c> to use, until the time of the call to
<c>ZipFile.Save()</c>. The callback is invoked once per <c>ZipEntry</c>,
at the time the data for the entry is being written out as part of a
<c>Save()</c> operation. The application can use whatever criteria it
likes in determining the level to return. For example, an application may
wish that no .mp3 files should be compressed, because they are already
compressed and the extra compression is not worth the CPU time incurred,
and so can return <c>None</c> for all .mp3 entries.
</para>
<para>
The library determines whether compression will be attempted for an entry
this way: If the entry is a zero length file, or a directory, no
compression is used. Otherwise, if this callback is set, it is invoked
and the <c>CompressionLevel</c> is set to the return value. If this
callback has not been set, then the previously set value for
<c>CompressionLevel</c> is used.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.MaxOutputSegmentSize">
<summary>
The maximum size of an output segment, when saving a split Zip file.
</summary>
<remarks>
<para>
Set this to a non-zero value before calling <see cref="M:Ionic.Zip.ZipFile.Save"/> or <see cref="M:Ionic.Zip.ZipFile.Save(System.String)"/> to specify that the ZipFile should be saved as a
split archive, also sometimes called a spanned archive. Some also
call them multi-file archives.
</para>
<para>
A split zip archive is saved in a set of discrete filesystem files,
rather than in a single file. This is handy when transmitting the
archive in email or some other mechanism that has a limit to the size of
each file. The first file in a split archive will be named
<c>basename.z01</c>, the second will be named <c>basename.z02</c>, and
so on. The final file is named <c>basename.zip</c>. According to the zip
specification from PKWare, the minimum value is 65536, for a 64k segment
size. The maximum number of segments allows in a split archive is 99.
</para>
<para>
The value of this property determines the maximum size of a split
segment when writing a split archive. For example, suppose you have a
<c>ZipFile</c> that would save to a single file of 200k. If you set the
<c>MaxOutputSegmentSize</c> to 65536 before calling <c>Save()</c>, you
will get four distinct output files. On the other hand if you set this
property to 256k, then you will get a single-file archive for that
<c>ZipFile</c>.
</para>
<para>
The size of each split output file will be as large as possible, up to
the maximum size set here. The zip specification requires that some data
fields in a zip archive may not span a split boundary, and an output
segment may be smaller than the maximum if necessary to avoid that
problem. Also, obviously the final segment of the archive may be smaller
than the maximum segment size. Segments will never be larger than the
value set with this property.
</para>
<para>
You can save a split Zip file only when saving to a regular filesystem
file. It's not possible to save a split zip file as a self-extracting
archive, nor is it possible to save a split zip file to a stream. When
saving to a SFX or to a Stream, this property is ignored.
</para>
<para>
About interoperability: Split or spanned zip files produced by DotNetZip
can be read by WinZip or PKZip, and vice-versa. Segmented zip files may
not be readable by other tools, if those other tools don't support zip
spanning or splitting. When in doubt, test. I don't believe Windows
Explorer can extract a split archive.
</para>
<para>
This property has no effect when reading a split archive. You can read
a split archive in the normal way with DotNetZip.
</para>
<para>
When saving a zip file, if you want a regular zip file rather than a
split zip file, don't set this property, or set it to Zero.
</para>
<para>
If you read a split archive, with <see cref="M:Ionic.Zip.ZipFile.Read(System.String)"/> and
then subsequently call <c>ZipFile.Save()</c>, unless you set this
property before calling <c>Save()</c>, you will get a normal,
single-file archive.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.NumberOfSegmentsForMostRecentSave"/>
</member>
<member name="P:Ionic.Zip.ZipFile.NumberOfSegmentsForMostRecentSave">
<summary>
Returns the number of segments used in the most recent Save() operation.
</summary>
<remarks>
<para>
This is normally zero, unless you have set the <see cref="P:Ionic.Zip.ZipFile.MaxOutputSegmentSize"/> property. If you have set <see cref="P:Ionic.Zip.ZipFile.MaxOutputSegmentSize"/>, and then you save a file, after the call to
Save() completes, you can read this value to learn the number of segments that
were created.
</para>
<para>
If you call Save("Archive.zip"), and it creates 5 segments, then you
will have filesystem files named Archive.z01, Archive.z02, Archive.z03,
Archive.z04, and Archive.zip, and the value of this property will be 5.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.MaxOutputSegmentSize"/>
</member>
<member name="P:Ionic.Zip.ZipFile.ParallelDeflateThreshold">
<summary>
The size threshold for an entry, above which a parallel deflate is used.
</summary>
<remarks>
<para>
DotNetZip will use multiple threads to compress any ZipEntry,
if the entry is larger than the given size. Zero means "always
use parallel deflate", while -1 means "never use parallel
deflate". The default value for this property is 512k. Aside
from the special values of 0 and 1, the minimum value is 65536.
</para>
<para>
If the entry size cannot be known before compression, as with a
read-forward stream, then Parallel deflate will never be
performed, unless the value of this property is zero.
</para>
<para>
A parallel deflate operations will speed up the compression of
large files, on computers with multiple CPUs or multiple CPU
cores. For files above 1mb, on a dual core or dual-cpu (2p)
machine, the time required to compress the file can be 70% of the
single-threaded deflate. For very large files on 4p machines the
compression can be done in 30% of the normal time. The downside
is that parallel deflate consumes extra memory during the deflate,
and the deflation is not as effective.
</para>
<para>
Parallel deflate tends to yield slightly less compression when
compared to as single-threaded deflate; this is because the original
data stream is split into multiple independent buffers, each of which
is compressed in parallel. But because they are treated
independently, there is no opportunity to share compression
dictionaries. For that reason, a deflated stream may be slightly
larger when compressed using parallel deflate, as compared to a
traditional single-threaded deflate. Sometimes the increase over the
normal deflate is as much as 5% of the total compressed size. For
larger files it can be as small as 0.1%.
</para>
<para>
Multi-threaded compression does not give as much an advantage when
using Encryption. This is primarily because encryption tends to slow
down the entire pipeline. Also, multi-threaded compression gives less
of an advantage when using lower compression levels, for example <see cref="F:Ionic.Zlib.CompressionLevel.BestSpeed"/>. You may have to
perform some tests to determine the best approach for your situation.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.ParallelDeflateMaxBufferPairs"/>
</member>
<member name="P:Ionic.Zip.ZipFile.ParallelDeflateMaxBufferPairs">
<summary>
The maximum number of buffer pairs to use when performing
parallel compression.
</summary>
<remarks>
<para>
This property sets an upper limit on the number of memory
buffer pairs to create when performing parallel
compression. The implementation of the parallel
compression stream allocates multiple buffers to
facilitate parallel compression. As each buffer fills up,
the stream uses <see cref="M:System.Threading.ThreadPool.QueueUserWorkItem(System.Threading.WaitCallback)">
ThreadPool.QueueUserWorkItem()</see> to compress those
buffers in a background threadpool thread. After a buffer
is compressed, it is re-ordered and written to the output
stream.
</para>
<para>
A higher number of buffer pairs enables a higher degree of
parallelism, which tends to increase the speed of compression on
multi-cpu computers. On the other hand, a higher number of buffer
pairs also implies a larger memory consumption, more active worker
threads, and a higher cpu utilization for any compression. This
property enables the application to limit its memory consumption and
CPU utilization behavior depending on requirements.
</para>
<para>
For each compression "task" that occurs in parallel, there are 2
buffers allocated: one for input and one for output. This property
sets a limit for the number of pairs. The total amount of storage
space allocated for buffering will then be (N*S*2), where N is the
number of buffer pairs, S is the size of each buffer (<see cref="P:Ionic.Zip.ZipFile.BufferSize"/>). By default, DotNetZip allocates 4 buffer
pairs per CPU core, so if your machine has 4 cores, and you retain
the default buffer size of 128k, then the
ParallelDeflateOutputStream will use 4 * 4 * 2 * 128kb of buffer
memory in total, or 4mb, in blocks of 128kb. If you then set this
property to 8, then the number will be 8 * 2 * 128kb of buffer
memory, or 2mb.
</para>
<para>
CPU utilization will also go up with additional buffers, because a
larger number of buffer pairs allows a larger number of background
threads to compress in parallel. If you find that parallel
compression is consuming too much memory or CPU, you can adjust this
value downward.
</para>
<para>
The default value is 16. Different values may deliver better or
worse results, depending on your priorities and the dynamic
performance characteristics of your storage and compute resources.
</para>
<para>
This property is not the number of buffer pairs to use; it is an
upper limit. An illustration: Suppose you have an application that
uses the default value of this property (which is 16), and it runs
on a machine with 2 CPU cores. In that case, DotNetZip will allocate
4 buffer pairs per CPU core, for a total of 8 pairs. The upper
limit specified by this property has no effect.
</para>
<para>
The application can set this value at any time
before calling <c>ZipFile.Save()</c>.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.ParallelDeflateThreshold"/>
</member>
<member name="P:Ionic.Zip.ZipFile.LibraryVersion">
<summary>
Returns the version number on the DotNetZip assembly.
</summary>
<remarks>
<para>
This property is exposed as a convenience. Callers could also get the
version value by retrieving GetName().Version on the
System.Reflection.Assembly object pointing to the DotNetZip
assembly. But sometimes it is not clear which assembly is being loaded.
This property makes it clear.
</para>
<para>
This static property is primarily useful for diagnostic purposes.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.ZipFile.Item(System.Int32)">
<summary>
This is an integer indexer into the Zip archive.
</summary>
<remarks>
<para>
This property is read-only.
</para>
<para>
Internally, the <c>ZipEntry</c> instances that belong to the
<c>ZipFile</c> are stored in a Dictionary. When you use this
indexer the first time, it creates a read-only
<c>List<ZipEntry></c> from the Dictionary.Values Collection.
If at any time you modify the set of entries in the <c>ZipFile</c>,
either by adding an entry, removing an entry, or renaming an
entry, a new List will be created, and the numeric indexes for the
remaining entries may be different.
</para>
<para>
This means you cannot rename any ZipEntry from
inside an enumeration of the zip file.
</para>
<param name="ix">
The index value.
</param>
</remarks>
<returns>
The <c>ZipEntry</c> within the Zip archive at the specified index. If the
entry does not exist in the archive, this indexer throws.
</returns>
</member>
<member name="P:Ionic.Zip.ZipFile.Item(System.String)">
<summary>
This is a name-based indexer into the Zip archive.
</summary>
<remarks>
<para>
This property is read-only.
</para>
<para>
The <see cref="P:Ionic.Zip.ZipFile.CaseSensitiveRetrieval"/> property on the <c>ZipFile</c>
determines whether retrieval via this indexer is done via case-sensitive
comparisons. By default, retrieval is not case sensitive. This makes
sense on Windows, in which filesystems are not case sensitive.
</para>
<para>
Regardless of case-sensitivity, it is not always the case that
<c>this[value].FileName == value</c>. In other words, the <c>FileName</c>
property of the <c>ZipEntry</c> retrieved with this indexer, may or may
not be equal to the index value.
</para>
<para>
This is because DotNetZip performs a normalization of filenames passed to
this indexer, before attempting to retrieve the item. That normalization
includes: removal of a volume letter and colon, swapping backward slashes
for forward slashes. So, <c>zip["dir1\\entry1.txt"].FileName ==
"dir1/entry.txt"</c>.
</para>
<para>
Directory entries in the zip file may be retrieved via this indexer only
with names that have a trailing slash. DotNetZip automatically appends a
trailing slash to the names of any directory entries added to a zip.
</para>
</remarks>
<example>
This example extracts only the entries in a zip file that are .txt files.
<code>
using (ZipFile zip = ZipFile.Read("PackedDocuments.zip"))
{
foreach (string s1 in zip.EntryFilenames)
{
if (s1.EndsWith(".txt"))
zip[s1].Extract("textfiles");
}
}
</code>
<code lang="VB">
Using zip As ZipFile = ZipFile.Read("PackedDocuments.zip")
Dim s1 As String
For Each s1 In zip.EntryFilenames
If s1.EndsWith(".txt") Then
zip(s1).Extract("textfiles")
End If
Next
End Using
</code>
</example>
<seealso cref="M:Ionic.Zip.ZipFile.RemoveEntry(System.String)"/>
<exception cref="T:System.ArgumentException">
Thrown if the caller attempts to assign a non-null value to the indexer.
</exception>
<param name="fileName">
The name of the file, including any directory path, to retrieve from the
zip. The filename match is not case-sensitive by default; you can use the
<see cref="P:Ionic.Zip.ZipFile.CaseSensitiveRetrieval"/> property to change this behavior. The
pathname can use forward-slashes or backward slashes.
</param>
<returns>
The <c>ZipEntry</c> within the Zip archive, given by the specified
filename. If the named entry does not exist in the archive, this indexer
returns <c>null</c> (<c>Nothing</c> in VB).
</returns>
</member>
<member name="P:Ionic.Zip.ZipFile.EntryFileNames">
<summary>
The list of filenames for the entries contained within the zip archive.
</summary>
<remarks>
According to the ZIP specification, the names of the entries use forward
slashes in pathnames. If you are scanning through the list, you may have
to swap forward slashes for backslashes.
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.Item(System.String)"/>
<example>
This example shows one way to test if a filename is already contained
within a zip archive.
<code>
String zipFileToRead= "PackedDocuments.zip";
string candidate = "DatedMaterial.xps";
using (ZipFile zip = new ZipFile(zipFileToRead))
{
if (zip.EntryFilenames.Contains(candidate))
Console.WriteLine("The file '{0}' exists in the zip archive '{1}'",
candidate,
zipFileName);
else
Console.WriteLine("The file, '{0}', does not exist in the zip archive '{1}'",
candidate,
zipFileName);
Console.WriteLine();
}
</code>
<code lang="VB">
Dim zipFileToRead As String = "PackedDocuments.zip"
Dim candidate As String = "DatedMaterial.xps"
Using zip As ZipFile.Read(ZipFileToRead)
If zip.EntryFilenames.Contains(candidate) Then
Console.WriteLine("The file '{0}' exists in the zip archive '{1}'", _
candidate, _
zipFileName)
Else
Console.WriteLine("The file, '{0}', does not exist in the zip archive '{1}'", _
candidate, _
zipFileName)
End If
Console.WriteLine
End Using
</code>
</example>
<returns>
The list of strings for the filenames contained within the Zip archive.
</returns>
</member>
<member name="P:Ionic.Zip.ZipFile.Entries">
<summary>
Returns the readonly collection of entries in the Zip archive.
</summary>
<remarks>
<para>
If there are no entries in the current <c>ZipFile</c>, the value returned is a
non-null zero-element collection. If there are entries in the zip file,
the elements are returned in no particular order.
</para>
<para>
This is the implied enumerator on the <c>ZipFile</c> class. If you use a
<c>ZipFile</c> instance in a context that expects an enumerator, you will
get this collection.
</para>
</remarks>
<seealso cref="P:Ionic.Zip.ZipFile.EntriesSorted"/>
</member>
<member name="P:Ionic.Zip.ZipFile.EntriesSorted">
<summary>
Returns a readonly collection of entries in the Zip archive, sorted by FileName.
</summary>
<remarks>
If there are no entries in the current <c>ZipFile</c>, the value returned
is a non-null zero-element collection. If there are entries in the zip
file, the elements are returned sorted by the name of the entry.
</remarks>
<example>
This example fills a Windows Forms ListView with the entries in a zip file.
<code lang="C#">
using (ZipFile zip = ZipFile.Read(zipFile))
{
foreach (ZipEntry entry in zip.EntriesSorted)
{
ListViewItem item = new ListViewItem(n.ToString());
n++;
string[] subitems = new string[] {
entry.FileName.Replace("/","\\"),
entry.LastModified.ToString("yyyy-MM-dd HH:mm:ss"),
entry.UncompressedSize.ToString(),
String.Format("{0,5:F0}%", entry.CompressionRatio),
entry.CompressedSize.ToString(),
(entry.UsesEncryption) ? "Y" : "N",
String.Format("{0:X8}", entry.Crc)};
foreach (String s in subitems)
{
ListViewItem.ListViewSubItem subitem = new ListViewItem.ListViewSubItem();
subitem.Text = s;
item.SubItems.Add(subitem);
}
this.listView1.Items.Add(item);
}
}
</code>
</example>
<seealso cref="P:Ionic.Zip.ZipFile.Entries"/>
</member>
<member name="P:Ionic.Zip.ZipFile.Count">
<summary>
Returns the number of entries in the Zip archive.
</summary>
</member>
<member name="E:Ionic.Zip.ZipFile.SaveProgress">
<summary>
An event handler invoked when a Save() starts, before and after each
entry has been written to the archive, when a Save() completes, and
during other Save events.
</summary>
<remarks>
<para>
Depending on the particular event, different properties on the <see cref="T:Ionic.Zip.SaveProgressEventArgs"/> parameter are set. The following
table summarizes the available EventTypes and the conditions under
which this event handler is invoked with a
<c>SaveProgressEventArgs</c> with the given EventType.
</para>
<list type="table">
<listheader>
<term>value of EntryType</term>
<description>Meaning and conditions</description>
</listheader>
<item>
<term>ZipProgressEventType.Saving_Started</term>
<description>Fired when ZipFile.Save() begins.
</description>
</item>
<item>
<term>ZipProgressEventType.Saving_BeforeSaveEntry</term>
<description>
Fired within ZipFile.Save(), just before writing data for each
particular entry.
</description>
</item>
<item>
<term>ZipProgressEventType.Saving_AfterSaveEntry</term>
<description>
Fired within ZipFile.Save(), just after having finished writing data
for each particular entry.
</description>
</item>
<item>
<term>ZipProgressEventType.Saving_Completed</term>
<description>Fired when ZipFile.Save() has completed.
</description>
</item>
<item>
<term>ZipProgressEventType.Saving_AfterSaveTempArchive</term>
<description>
Fired after the temporary file has been created. This happens only
when saving to a disk file. This event will not be invoked when
saving to a stream.
</description>
</item>
<item>
<term>ZipProgressEventType.Saving_BeforeRenameTempArchive</term>
<description>
Fired just before renaming the temporary file to the permanent
location. This happens only when saving to a disk file. This event
will not be invoked when saving to a stream.
</description>
</item>
<item>
<term>ZipProgressEventType.Saving_AfterRenameTempArchive</term>
<description>
Fired just after renaming the temporary file to the permanent
location. This happens only when saving to a disk file. This event
will not be invoked when saving to a stream.
</description>
</item>
<item>
<term>ZipProgressEventType.Saving_AfterCompileSelfExtractor</term>
<description>
Fired after a self-extracting archive has finished compiling. This
EventType is used only within SaveSelfExtractor().
</description>
</item>
<item>
<term>ZipProgressEventType.Saving_BytesRead</term>
<description>
Set during the save of a particular entry, to update progress of the
Save(). When this EventType is set, the BytesTransferred is the
number of bytes that have been read from the source stream. The
TotalBytesToTransfer is the number of bytes in the uncompressed
file.
</description>
</item>
</list>
</remarks>
<example>
This example uses an anonymous method to handle the
SaveProgress event, by updating a progress bar.
<code lang="C#">
progressBar1.Value = 0;
progressBar1.Max = listbox1.Items.Count;
using (ZipFile zip = new ZipFile())
{
// listbox1 contains a list of filenames
zip.AddFiles(listbox1.Items);
// do the progress bar:
zip.SaveProgress += (sender, e) => {
if (e.EventType == ZipProgressEventType.Saving_BeforeWriteEntry) {
progressBar1.PerformStep();
}
};
zip.Save(fs);
}
</code>
</example>
<example>
This example uses a named method as the
<c>SaveProgress</c> event handler, to update the user, in a
console-based application.
<code lang="C#">
static bool justHadByteUpdate= false;
public static void SaveProgress(object sender, SaveProgressEventArgs e)
{
if (e.EventType == ZipProgressEventType.Saving_Started)
Console.WriteLine("Saving: {0}", e.ArchiveName);
else if (e.EventType == ZipProgressEventType.Saving_Completed)
{
justHadByteUpdate= false;
Console.WriteLine();
Console.WriteLine("Done: {0}", e.ArchiveName);
}
else if (e.EventType == ZipProgressEventType.Saving_BeforeWriteEntry)
{
if (justHadByteUpdate)
Console.WriteLine();
Console.WriteLine(" Writing: {0} ({1}/{2})",
e.CurrentEntry.FileName, e.EntriesSaved, e.EntriesTotal);
justHadByteUpdate= false;
}
else if (e.EventType == ZipProgressEventType.Saving_EntryBytesRead)
{
if (justHadByteUpdate)
Console.SetCursorPosition(0, Console.CursorTop);
Console.Write(" {0}/{1} ({2:N0}%)", e.BytesTransferred, e.TotalBytesToTransfer,
e.BytesTransferred / (0.01 * e.TotalBytesToTransfer ));
justHadByteUpdate= true;
}
}
public static ZipUp(string targetZip, string directory)
{
using (var zip = new ZipFile()) {
zip.SaveProgress += SaveProgress;
zip.AddDirectory(directory);
zip.Save(targetZip);
}
}
</code>
<code lang="VB">
Public Sub ZipUp(ByVal targetZip As String, ByVal directory As String)
Using zip As ZipFile = New ZipFile
AddHandler zip.SaveProgress, AddressOf MySaveProgress
zip.AddDirectory(directory)
zip.Save(targetZip)
End Using
End Sub
Private Shared justHadByteUpdate As Boolean = False
Public Shared Sub MySaveProgress(ByVal sender As Object, ByVal e As SaveProgressEventArgs)
If (e.EventType Is ZipProgressEventType.Saving_Started) Then
Console.WriteLine("Saving: {0}", e.ArchiveName)
ElseIf (e.EventType Is ZipProgressEventType.Saving_Completed) Then
justHadByteUpdate = False
Console.WriteLine
Console.WriteLine("Done: {0}", e.ArchiveName)
ElseIf (e.EventType Is ZipProgressEventType.Saving_BeforeWriteEntry) Then
If justHadByteUpdate Then
Console.WriteLine
End If
Console.WriteLine(" Writing: {0} ({1}/{2})", e.CurrentEntry.FileName, e.EntriesSaved, e.EntriesTotal)
justHadByteUpdate = False
ElseIf (e.EventType Is ZipProgressEventType.Saving_EntryBytesRead) Then
If justHadByteUpdate Then
Console.SetCursorPosition(0, Console.CursorTop)
End If
Console.Write(" {0}/{1} ({2:N0}%)", e.BytesTransferred, _
e.TotalBytesToTransfer, _
(CDbl(e.BytesTransferred) / (0.01 * e.TotalBytesToTransfer)))
justHadByteUpdate = True
End If
End Sub
</code>
</example>
<example>
This is a more complete example of using the SaveProgress
events in a Windows Forms application, with a
Thread object.
<code lang="C#">
delegate void SaveEntryProgress(SaveProgressEventArgs e);
delegate void ButtonClick(object sender, EventArgs e);
public class WorkerOptions
{
public string ZipName;
public string Folder;
public string Encoding;
public string Comment;
public int ZipFlavor;
public Zip64Option Zip64;
}
private int _progress2MaxFactor;
private bool _saveCanceled;
private long _totalBytesBeforeCompress;
private long _totalBytesAfterCompress;
private Thread _workerThread;
private void btnZipup_Click(object sender, EventArgs e)
{
KickoffZipup();
}
private void btnCancel_Click(object sender, EventArgs e)
{
if (this.lblStatus.InvokeRequired)
{
this.lblStatus.Invoke(new ButtonClick(this.btnCancel_Click), new object[] { sender, e });
}
else
{
_saveCanceled = true;
lblStatus.Text = "Canceled...";
ResetState();
}
}
private void KickoffZipup()
{
_folderName = tbDirName.Text;
if (_folderName == null || _folderName == "") return;
if (this.tbZipName.Text == null || this.tbZipName.Text == "") return;
// check for existence of the zip file:
if (System.IO.File.Exists(this.tbZipName.Text))
{
var dlgResult = MessageBox.Show(String.Format("The file you have specified ({0}) already exists." +
" Do you want to overwrite this file?", this.tbZipName.Text),
"Confirmation is Required", MessageBoxButtons.YesNo, MessageBoxIcon.Question);
if (dlgResult != DialogResult.Yes) return;
System.IO.File.Delete(this.tbZipName.Text);
}
_saveCanceled = false;
_nFilesCompleted = 0;
_totalBytesAfterCompress = 0;
_totalBytesBeforeCompress = 0;
this.btnOk.Enabled = false;
this.btnOk.Text = "Zipping...";
this.btnCancel.Enabled = true;
lblStatus.Text = "Zipping...";
var options = new WorkerOptions
{
ZipName = this.tbZipName.Text,
Folder = _folderName,
Encoding = "ibm437"
};
if (this.comboBox1.SelectedIndex != 0)
{
options.Encoding = this.comboBox1.SelectedItem.ToString();
}
if (this.radioFlavorSfxCmd.Checked)
options.ZipFlavor = 2;
else if (this.radioFlavorSfxGui.Checked)
options.ZipFlavor = 1;
else options.ZipFlavor = 0;
if (this.radioZip64AsNecessary.Checked)
options.Zip64 = Zip64Option.AsNecessary;
else if (this.radioZip64Always.Checked)
options.Zip64 = Zip64Option.Always;
else options.Zip64 = Zip64Option.Never;
options.Comment = String.Format("Encoding:{0} || Flavor:{1} || ZIP64:{2}\r\nCreated at {3} || {4}\r\n",
options.Encoding,
FlavorToString(options.ZipFlavor),
options.Zip64.ToString(),
System.DateTime.Now.ToString("yyyy-MMM-dd HH:mm:ss"),
this.Text);
if (this.tbComment.Text != TB_COMMENT_NOTE)
options.Comment += this.tbComment.Text;
_workerThread = new Thread(this.DoSave);
_workerThread.Name = "Zip Saver thread";
_workerThread.Start(options);
this.Cursor = Cursors.WaitCursor;
}
private void DoSave(Object p)
{
WorkerOptions options = p as WorkerOptions;
try
{
using (var zip1 = new ZipFile())
{
zip1.ProvisionalAlternateEncoding = System.Text.Encoding.GetEncoding(options.Encoding);
zip1.Comment = options.Comment;
zip1.AddDirectory(options.Folder);
_entriesToZip = zip1.EntryFileNames.Count;
SetProgressBars();
zip1.SaveProgress += this.zip1_SaveProgress;
zip1.UseZip64WhenSaving = options.Zip64;
if (options.ZipFlavor == 1)
zip1.SaveSelfExtractor(options.ZipName, SelfExtractorFlavor.WinFormsApplication);
else if (options.ZipFlavor == 2)
zip1.SaveSelfExtractor(options.ZipName, SelfExtractorFlavor.ConsoleApplication);
else
zip1.Save(options.ZipName);
}
}
catch (System.Exception exc1)
{
MessageBox.Show(String.Format("Exception while zipping: {0}", exc1.Message));
btnCancel_Click(null, null);
}
}
void zip1_SaveProgress(object sender, SaveProgressEventArgs e)
{
switch (e.EventType)
{
case ZipProgressEventType.Saving_AfterWriteEntry:
StepArchiveProgress(e);
break;
case ZipProgressEventType.Saving_EntryBytesRead:
StepEntryProgress(e);
break;
case ZipProgressEventType.Saving_Completed:
SaveCompleted();
break;
case ZipProgressEventType.Saving_AfterSaveTempArchive:
// this event only occurs when saving an SFX file
TempArchiveSaved();
break;
}
if (_saveCanceled)
e.Cancel = true;
}
private void StepArchiveProgress(SaveProgressEventArgs e)
{
if (this.progressBar1.InvokeRequired)
{
this.progressBar1.Invoke(new SaveEntryProgress(this.StepArchiveProgress), new object[] { e });
}
else
{
if (!_saveCanceled)
{
_nFilesCompleted++;
this.progressBar1.PerformStep();
_totalBytesAfterCompress += e.CurrentEntry.CompressedSize;
_totalBytesBeforeCompress += e.CurrentEntry.UncompressedSize;
// reset the progress bar for the entry:
this.progressBar2.Value = this.progressBar2.Maximum = 1;
this.Update();
}
}
}
private void StepEntryProgress(SaveProgressEventArgs e)
{
if (this.progressBar2.InvokeRequired)
{
this.progressBar2.Invoke(new SaveEntryProgress(this.StepEntryProgress), new object[] { e });
}
else
{
if (!_saveCanceled)
{
if (this.progressBar2.Maximum == 1)
{
// reset
Int64 max = e.TotalBytesToTransfer;
_progress2MaxFactor = 0;
while (max > System.Int32.MaxValue)
{
max /= 2;
_progress2MaxFactor++;
}
this.progressBar2.Maximum = (int)max;
lblStatus.Text = String.Format("{0} of {1} files...({2})",
_nFilesCompleted + 1, _entriesToZip, e.CurrentEntry.FileName);
}
int xferred = e.BytesTransferred >> _progress2MaxFactor;
this.progressBar2.Value = (xferred >= this.progressBar2.Maximum)
? this.progressBar2.Maximum
: xferred;
this.Update();
}
}
}
private void SaveCompleted()
{
if (this.lblStatus.InvokeRequired)
{
this.lblStatus.Invoke(new MethodInvoker(this.SaveCompleted));
}
else
{
lblStatus.Text = String.Format("Done, Compressed {0} files, {1:N0}% of original.",
_nFilesCompleted, (100.00 * _totalBytesAfterCompress) / _totalBytesBeforeCompress);
ResetState();
}
}
private void ResetState()
{
this.btnCancel.Enabled = false;
this.btnOk.Enabled = true;
this.btnOk.Text = "Zip it!";
this.progressBar1.Value = 0;
this.progressBar2.Value = 0;
this.Cursor = Cursors.Default;
if (!_workerThread.IsAlive)
_workerThread.Join();
}
</code>
</example>
<seealso cref="E:Ionic.Zip.ZipFile.ReadProgress"/>
<seealso cref="E:Ionic.Zip.ZipFile.AddProgress"/>
<seealso cref="E:Ionic.Zip.ZipFile.ExtractProgress"/>
</member>
<member name="E:Ionic.Zip.ZipFile.ReadProgress">
<summary>
An event handler invoked before, during, and after the reading of a zip archive.
</summary>
<remarks>
<para>
Depending on the particular event being signaled, different properties on the
<see cref="T:Ionic.Zip.ReadProgressEventArgs"/> parameter are set. The following table
summarizes the available EventTypes and the conditions under which this
event handler is invoked with a <c>ReadProgressEventArgs</c> with the given EventType.
</para>
<list type="table">
<listheader>
<term>value of EntryType</term>
<description>Meaning and conditions</description>
</listheader>
<item>
<term>ZipProgressEventType.Reading_Started</term>
<description>Fired just as ZipFile.Read() begins. Meaningful properties: ArchiveName.
</description>
</item>
<item>
<term>ZipProgressEventType.Reading_Completed</term>
<description>Fired when ZipFile.Read() has completed. Meaningful properties: ArchiveName.
</description>
</item>
<item>
<term>ZipProgressEventType.Reading_ArchiveBytesRead</term>
<description>Fired while reading, updates the number of bytes read for the entire archive.
Meaningful properties: ArchiveName, CurrentEntry, BytesTransferred, TotalBytesToTransfer.
</description>
</item>
<item>
<term>ZipProgressEventType.Reading_BeforeReadEntry</term>
<description>Indicates an entry is about to be read from the archive.
Meaningful properties: ArchiveName, EntriesTotal.
</description>
</item>
<item>
<term>ZipProgressEventType.Reading_AfterReadEntry</term>
<description>Indicates an entry has just been read from the archive.
Meaningful properties: ArchiveName, EntriesTotal, CurrentEntry.
</description>
</item>
</list>
</remarks>
<seealso cref="E:Ionic.Zip.ZipFile.SaveProgress"/>
<seealso cref="E:Ionic.Zip.ZipFile.AddProgress"/>
<seealso cref="E:Ionic.Zip.ZipFile.ExtractProgress"/>
</member>
<member name="E:Ionic.Zip.ZipFile.ExtractProgress">
<summary>
An event handler invoked before, during, and after extraction of
entries in the zip archive.
</summary>
<remarks>
<para>
Depending on the particular event, different properties on the <see cref="T:Ionic.Zip.ExtractProgressEventArgs"/> parameter are set. The following
table summarizes the available EventTypes and the conditions under
which this event handler is invoked with a
<c>ExtractProgressEventArgs</c> with the given EventType.
</para>
<list type="table">
<listheader>
<term>value of EntryType</term>
<description>Meaning and conditions</description>
</listheader>
<item>
<term>ZipProgressEventType.Extracting_BeforeExtractAll</term>
<description>
Set when ExtractAll() begins. The ArchiveName, Overwrite, and
ExtractLocation properties are meaningful.</description>
</item>
<item>
<term>ZipProgressEventType.Extracting_AfterExtractAll</term>
<description>
Set when ExtractAll() has completed. The ArchiveName, Overwrite,
and ExtractLocation properties are meaningful.
</description>
</item>
<item>
<term>ZipProgressEventType.Extracting_BeforeExtractEntry</term>
<description>
Set when an Extract() on an entry in the ZipFile has begun.
Properties that are meaningful: ArchiveName, EntriesTotal,
CurrentEntry, Overwrite, ExtractLocation, EntriesExtracted.
</description>
</item>
<item>
<term>ZipProgressEventType.Extracting_AfterExtractEntry</term>
<description>
Set when an Extract() on an entry in the ZipFile has completed.
Properties that are meaningful: ArchiveName, EntriesTotal,
CurrentEntry, Overwrite, ExtractLocation, EntriesExtracted.
</description>
</item>
<item>
<term>ZipProgressEventType.Extracting_EntryBytesWritten</term>
<description>
Set within a call to Extract() on an entry in the ZipFile, as data
is extracted for the entry. Properties that are meaningful:
ArchiveName, CurrentEntry, BytesTransferred, TotalBytesToTransfer.
</description>
</item>
<item>
<term>ZipProgressEventType.Extracting_ExtractEntryWouldOverwrite</term>
<description>
Set within a call to Extract() on an entry in the ZipFile, when the
extraction would overwrite an existing file. This event type is used
only when <c>ExtractExistingFileAction</c> on the <c>ZipFile</c> or
<c>ZipEntry</c> is set to <c>InvokeExtractProgressEvent</c>.
</description>
</item>
</list>
</remarks>
<example>
<code>
private static bool justHadByteUpdate = false;
public static void ExtractProgress(object sender, ExtractProgressEventArgs e)
{
if(e.EventType == ZipProgressEventType.Extracting_EntryBytesWritten)
{
if (justHadByteUpdate)
Console.SetCursorPosition(0, Console.CursorTop);
Console.Write(" {0}/{1} ({2:N0}%)", e.BytesTransferred, e.TotalBytesToTransfer,
e.BytesTransferred / (0.01 * e.TotalBytesToTransfer ));
justHadByteUpdate = true;
}
else if(e.EventType == ZipProgressEventType.Extracting_BeforeExtractEntry)
{
if (justHadByteUpdate)
Console.WriteLine();
Console.WriteLine("Extracting: {0}", e.CurrentEntry.FileName);
justHadByteUpdate= false;
}
}
public static ExtractZip(string zipToExtract, string directory)
{
string TargetDirectory= "extract";
using (var zip = ZipFile.Read(zipToExtract)) {
zip.ExtractProgress += ExtractProgress;
foreach (var e in zip1)
{
e.Extract(TargetDirectory, true);
}
}
}
</code>
<code lang="VB">
Public Shared Sub Main(ByVal args As String())
Dim ZipToUnpack As String = "C1P3SML.zip"
Dim TargetDir As String = "ExtractTest_Extract"
Console.WriteLine("Extracting file {0} to {1}", ZipToUnpack, TargetDir)
Using zip1 As ZipFile = ZipFile.Read(ZipToUnpack)
AddHandler zip1.ExtractProgress, AddressOf MyExtractProgress
Dim e As ZipEntry
For Each e In zip1
e.Extract(TargetDir, True)
Next
End Using
End Sub
Private Shared justHadByteUpdate As Boolean = False
Public Shared Sub MyExtractProgress(ByVal sender As Object, ByVal e As ExtractProgressEventArgs)
If (e.EventType = ZipProgressEventType.Extracting_EntryBytesWritten) Then
If ExtractTest.justHadByteUpdate Then
Console.SetCursorPosition(0, Console.CursorTop)
End If
Console.Write(" {0}/{1} ({2:N0}%)", e.BytesTransferred, e.TotalBytesToTransfer, (CDbl(e.BytesTransferred) / (0.01 * e.TotalBytesToTransfer)))
ExtractTest.justHadByteUpdate = True
ElseIf (e.EventType = ZipProgressEventType.Extracting_BeforeExtractEntry) Then
If ExtractTest.justHadByteUpdate Then
Console.WriteLine
End If
Console.WriteLine("Extracting: {0}", e.CurrentEntry.FileName)
ExtractTest.justHadByteUpdate = False
End If
End Sub
</code>
</example>
<seealso cref="E:Ionic.Zip.ZipFile.SaveProgress"/>
<seealso cref="E:Ionic.Zip.ZipFile.ReadProgress"/>
<seealso cref="E:Ionic.Zip.ZipFile.AddProgress"/>
</member>
<member name="E:Ionic.Zip.ZipFile.AddProgress">
<summary>
An event handler invoked before, during, and after Adding entries to a zip archive.
</summary>
<remarks>
Adding a large number of entries to a zip file can take a long
time. For example, when calling <see cref="M:Ionic.Zip.ZipFile.AddDirectory(System.String)"/> on a
directory that contains 50,000 files, it could take 3 minutes or so.
This event handler allws an application to track the progress of the Add
operation, and to optionally cancel a lengthy Add operation.
</remarks>
<example>
<code lang="C#">
int _numEntriesToAdd= 0;
int _numEntriesAdded= 0;
void AddProgressHandler(object sender, AddProgressEventArgs e)
{
switch (e.EventType)
{
case ZipProgressEventType.Adding_Started:
Console.WriteLine("Adding files to the zip...");
break;
case ZipProgressEventType.Adding_AfterAddEntry:
_numEntriesAdded++;
Console.WriteLine(String.Format("Adding file {0}/{1} :: {2}",
_numEntriesAdded, _numEntriesToAdd, e.CurrentEntry.FileName));
break;
case ZipProgressEventType.Adding_Completed:
Console.WriteLine("Added all files");
break;
}
}
void CreateTheZip()
{
using (ZipFile zip = new ZipFile())
{
zip.AddProgress += AddProgressHandler;
zip.AddDirectory(System.IO.Path.GetFileName(DirToZip));
zip.Save(ZipFileToCreate);
}
}
</code>
<code lang="VB">
Private Sub AddProgressHandler(ByVal sender As Object, ByVal e As AddProgressEventArgs)
Select Case e.EventType
Case ZipProgressEventType.Adding_Started
Console.WriteLine("Adding files to the zip...")
Exit Select
Case ZipProgressEventType.Adding_AfterAddEntry
Console.WriteLine(String.Format("Adding file {0}", e.CurrentEntry.FileName))
Exit Select
Case ZipProgressEventType.Adding_Completed
Console.WriteLine("Added all files")
Exit Select
End Select
End Sub
Sub CreateTheZip()
Using zip as ZipFile = New ZipFile
AddHandler zip.AddProgress, AddressOf AddProgressHandler
zip.AddDirectory(System.IO.Path.GetFileName(DirToZip))
zip.Save(ZipFileToCreate);
End Using
End Sub
</code>
</example>
<seealso cref="E:Ionic.Zip.ZipFile.SaveProgress"/>
<seealso cref="E:Ionic.Zip.ZipFile.ReadProgress"/>
<seealso cref="E:Ionic.Zip.ZipFile.ExtractProgress"/>
</member>
<member name="E:Ionic.Zip.ZipFile.ZipError">
<summary>
An event that is raised when an error occurs during open or read of files
while saving a zip archive.
</summary>
<remarks>
<para>
Errors can occur as a file is being saved to the zip archive. For
example, the File.Open may fail, or a File.Read may fail, because of
lock conflicts or other reasons. If you add a handler to this event,
you can handle such errors in your own code. If you don't add a
handler, the library will throw an exception if it encounters an I/O
error during a call to <c>Save()</c>.
</para>
<para>
Setting a handler implicitly sets <see cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/> to
<c>ZipErrorAction.InvokeErrorEvent</c>.
</para>
<para>
The handler you add applies to all <see cref="T:Ionic.Zip.ZipEntry"/> items that are
subsequently added to the <c>ZipFile</c> instance. If you set this
property after you have added items to the <c>ZipFile</c>, but before you
have called <c>Save()</c>, errors that occur while saving those items
will not cause the error handler to be invoked.
</para>
<para>
If you want to handle any errors that occur with any entry in the zip
file using the same error handler, then add your error handler once,
before adding any entries to the zip archive.
</para>
<para>
In the error handler method, you need to set the <see cref="P:Ionic.Zip.ZipEntry.ZipErrorAction"/> property on the
<c>ZipErrorEventArgs.CurrentEntry</c>. This communicates back to
DotNetZip what you would like to do with this particular error. Within
an error handler, if you set the <c>ZipEntry.ZipErrorAction</c> property
on the <c>ZipEntry</c> to <c>ZipErrorAction.InvokeErrorEvent</c> or if
you don't set it at all, the library will throw the exception. (It is the
same as if you had set the <c>ZipEntry.ZipErrorAction</c> property on the
<c>ZipEntry</c> to <c>ZipErrorAction.Throw</c>.) If you set the
<c>ZipErrorEventArgs.Cancel</c> to true, the entire <c>Save()</c> will be
canceled.
</para>
<para>
In the case that you use <c>ZipErrorAction.Skip</c>, implying that
you want to skip the entry for which there's been an error, DotNetZip
tries to seek backwards in the output stream, and truncate all bytes
written on behalf of that particular entry. This works only if the
output stream is seekable. It will not work, for example, when using
ASPNET's Response.OutputStream.
</para>
</remarks>
<example>
This example shows how to use an event handler to handle
errors during save of the zip file.
<code lang="C#">
public static void MyZipError(object sender, ZipErrorEventArgs e)
{
Console.WriteLine("Error saving {0}...", e.FileName);
Console.WriteLine(" Exception: {0}", e.exception);
ZipEntry entry = e.CurrentEntry;
string response = null;
// Ask the user whether he wants to skip this error or not
do
{
Console.Write("Retry, Skip, Throw, or Cancel ? (R/S/T/C) ");
response = Console.ReadLine();
Console.WriteLine();
} while (response != null &&
response[0]!='S' && response[0]!='s' &&
response[0]!='R' && response[0]!='r' &&
response[0]!='T' && response[0]!='t' &&
response[0]!='C' && response[0]!='c');
e.Cancel = (response[0]=='C' || response[0]=='c');
if (response[0]=='S' || response[0]=='s')
entry.ZipErrorAction = ZipErrorAction.Skip;
else if (response[0]=='R' || response[0]=='r')
entry.ZipErrorAction = ZipErrorAction.Retry;
else if (response[0]=='T' || response[0]=='t')
entry.ZipErrorAction = ZipErrorAction.Throw;
}
public void SaveTheFile()
{
string directoryToZip = "fodder";
string directoryInArchive = "files";
string zipFileToCreate = "Archive.zip";
using (var zip = new ZipFile())
{
// set the event handler before adding any entries
zip.ZipError += MyZipError;
zip.AddDirectory(directoryToZip, directoryInArchive);
zip.Save(zipFileToCreate);
}
}
</code>
<code lang="VB">
Private Sub MyZipError(ByVal sender As Object, ByVal e As Ionic.Zip.ZipErrorEventArgs)
' At this point, the application could prompt the user for an action to take.
' But in this case, this application will simply automatically skip the file, in case of error.
Console.WriteLine("Zip Error, entry {0}", e.CurrentEntry.FileName)
Console.WriteLine(" Exception: {0}", e.exception)
' set the desired ZipErrorAction on the CurrentEntry to communicate that to DotNetZip
e.CurrentEntry.ZipErrorAction = Zip.ZipErrorAction.Skip
End Sub
Public Sub SaveTheFile()
Dim directoryToZip As String = "fodder"
Dim directoryInArchive As String = "files"
Dim zipFileToCreate as String = "Archive.zip"
Using zipArchive As ZipFile = New ZipFile
' set the event handler before adding any entries
AddHandler zipArchive.ZipError, AddressOf MyZipError
zipArchive.AddDirectory(directoryToZip, directoryInArchive)
zipArchive.Save(zipFileToCreate)
End Using
End Sub
</code>
</example>
<seealso cref="P:Ionic.Zip.ZipFile.ZipErrorAction"/>
</member>
<member name="T:Ionic.Zip.Zip64Option">
<summary>
Options for using ZIP64 extensions when saving zip archives.
</summary>
<remarks>
<para>
Designed many years ago, the <see href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">original zip
specification from PKWARE</see> allowed for 32-bit quantities for the
compressed and uncompressed sizes of zip entries, as well as a 32-bit quantity
for specifying the length of the zip archive itself, and a maximum of 65535
entries. These limits are now regularly exceeded in many backup and archival
scenarios. Recently, PKWare added extensions to the original zip spec, called
"ZIP64 extensions", to raise those limitations. This property governs whether
DotNetZip will use those extensions when writing zip archives. The use of
these extensions is optional and explicit in DotNetZip because, despite the
status of ZIP64 as a bona fide standard, many other zip tools and libraries do
not support ZIP64, and therefore a zip file with ZIP64 extensions may be
unreadable by some of those other tools.
</para>
<para>
Set this property to <see cref="F:Ionic.Zip.Zip64Option.Always"/> to always use ZIP64
extensions when saving, regardless of whether your zip archive needs it.
Suppose you add 5 files, each under 100k, to a ZipFile. If you specify Always
for this flag, you will get a ZIP64 archive, though the archive does not need
to use ZIP64 because none of the original zip limits had been exceeded.
</para>
<para>
Set this property to <see cref="F:Ionic.Zip.Zip64Option.Never"/> to tell the DotNetZip
library to never use ZIP64 extensions. This is useful for maximum
compatibility and interoperability, at the expense of the capability of
handling large files or large archives. NB: Windows Explorer in Windows XP
and Windows Vista cannot currently extract files from a zip64 archive, so if
you want to guarantee that a zip archive produced by this library will work in
Windows Explorer, use <c>Never</c>. If you set this property to <see cref="F:Ionic.Zip.Zip64Option.Never"/>, and your application creates a zip that would
exceed one of the Zip limits, the library will throw an exception while saving
the zip file.
</para>
<para>
Set this property to <see cref="F:Ionic.Zip.Zip64Option.AsNecessary"/> to tell the
DotNetZip library to use the ZIP64 extensions when required by the
entry. After the file is compressed, the original and compressed sizes are
checked, and if they exceed the limits described above, then zip64 can be
used. That is the general idea, but there is an additional wrinkle when saving
to a non-seekable device, like the ASP.NET <c>Response.OutputStream</c>, or
<c>Console.Out</c>. When using non-seekable streams for output, the entry
header - which indicates whether zip64 is in use - is emitted before it is
known if zip64 is necessary. It is only after all entries have been saved
that it can be known if ZIP64 will be required. On seekable output streams,
after saving all entries, the library can seek backward and re-emit the zip
file header to be consistent with the actual ZIP64 requirement. But using a
non-seekable output stream, the library cannot seek backward, so the header
can never be changed. In other words, the archive's use of ZIP64 extensions is
not alterable after the header is emitted. Therefore, when saving to
non-seekable streams, using <see cref="F:Ionic.Zip.Zip64Option.AsNecessary"/> is the same
as using <see cref="F:Ionic.Zip.Zip64Option.Always"/>: it will always produce a zip
archive that uses ZIP64 extensions.
</para>
</remarks>
</member>
<member name="F:Ionic.Zip.Zip64Option.Default">
<summary>
The default behavior, which is "Never".
(For COM clients, this is a 0 (zero).)
</summary>
</member>
<member name="F:Ionic.Zip.Zip64Option.Never">
<summary>
Do not use ZIP64 extensions when writing zip archives.
(For COM clients, this is a 0 (zero).)
</summary>
</member>
<member name="F:Ionic.Zip.Zip64Option.AsNecessary">
<summary>
Use ZIP64 extensions when writing zip archives, as necessary.
For example, when a single entry exceeds 0xFFFFFFFF in size, or when the archive as a whole
exceeds 0xFFFFFFFF in size, or when there are more than 65535 entries in an archive.
(For COM clients, this is a 1.)
</summary>
</member>
<member name="F:Ionic.Zip.Zip64Option.Always">
<summary>
Always use ZIP64 extensions when writing zip archives, even when unnecessary.
(For COM clients, this is a 2.)
</summary>
</member>
<member name="T:Ionic.Zip.ZipOption">
<summary>
An enum representing the values on a three-way toggle switch
for various options in the library. This might be used to
specify whether to employ a particular text encoding, or to use
ZIP64 extensions, or some other option.
</summary>
</member>
<member name="F:Ionic.Zip.ZipOption.Default">
<summary>
The default behavior. This is the same as "Never".
(For COM clients, this is a 0 (zero).)
</summary>
</member>
<member name="F:Ionic.Zip.ZipOption.Never">
<summary>
Never use the associated option.
(For COM clients, this is a 0 (zero).)
</summary>
</member>
<member name="F:Ionic.Zip.ZipOption.AsNecessary">
<summary>
Use the associated behavior "as necessary."
(For COM clients, this is a 1.)
</summary>
</member>
<member name="F:Ionic.Zip.ZipOption.Always">
<summary>
Use the associated behavior Always, whether necessary or not.
(For COM clients, this is a 2.)
</summary>
</member>
<member name="T:Ionic.Zip.ReadOptions">
<summary>
A class for collecting the various options that can be used when
Reading zip files for extraction or update.
</summary>
<remarks>
<para>
When reading a zip file, there are several options an
application can set, to modify how the file is read, or what
the library does while reading. This class collects those
options into one container.
</para>
<para>
Pass an instance of the <c>ReadOptions</c> class into the
<c>ZipFile.Read()</c> method.
</para>
<seealso cref="M:Ionic.Zip.ZipFile.Read(System.String,Ionic.Zip.ReadOptions)"/>.
<seealso cref="M:Ionic.Zip.ZipFile.Read(System.IO.Stream,Ionic.Zip.ReadOptions)"/>.
</remarks>
</member>
<member name="P:Ionic.Zip.ReadOptions.ReadProgress">
<summary>
An event handler for Read operations. When opening large zip
archives, you may want to display a progress bar or other
indicator of status progress while reading. This parameter
allows you to specify a ReadProgress Event Handler directly.
When you call <c>Read()</c>, the progress event is invoked as
necessary.
</summary>
</member>
<member name="P:Ionic.Zip.ReadOptions.StatusMessageWriter">
<summary>
The <c>System.IO.TextWriter</c> to use for writing verbose status messages
during operations on the zip archive. A console application may wish to
pass <c>System.Console.Out</c> to get messages on the Console. A graphical
or headless application may wish to capture the messages in a different
<c>TextWriter</c>, such as a <c>System.IO.StringWriter</c>.
</summary>
</member>
<member name="P:Ionic.Zip.ReadOptions.Encoding">
<summary>
The <c>System.Text.Encoding</c> to use when reading in the zip archive. Be
careful specifying the encoding. If the value you use here is not the same
as the Encoding used when the zip archive was created (possibly by a
different archiver) you will get unexpected results and possibly exceptions.
</summary>
<seealso cref="P:Ionic.Zip.ZipFile.ProvisionalAlternateEncoding"/>
</member>
<member name="T:Ionic.Zip.SelfExtractorFlavor">
<summary>
An enum that provides the different self-extractor flavors
</summary>
</member>
<member name="F:Ionic.Zip.SelfExtractorFlavor.ConsoleApplication">
<summary>
A self-extracting zip archive that runs from the console or
command line.
</summary>
</member>
<member name="F:Ionic.Zip.SelfExtractorFlavor.WinFormsApplication">
<summary>
A self-extracting zip archive that presents a graphical user
interface when it is executed.
</summary>
</member>
<member name="T:Ionic.Zip.SelfExtractorSaveOptions">
<summary>
The options for generating a self-extracting archive.
</summary>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.Flavor">
<summary>
The type of SFX to create.
</summary>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.PostExtractCommandLine">
<summary>
The command to run after extraction.
</summary>
<remarks>
<para>
This is optional. Leave it empty (<c>null</c> in C# or <c>Nothing</c> in
VB) to run no command after extraction.
</para>
<para>
If it is non-empty, the SFX will execute the command specified in this
string on the user's machine, and using the extract directory as the
working directory for the process, after unpacking the archive. The
program to execute can include a path, if you like. If you want to execute
a program that accepts arguments, specify the program name, followed by a
space, and then the arguments for the program, each separated by a space,
just as you would on a normal command line. Example: <c>program.exe arg1
arg2</c>. The string prior to the first space will be taken as the
program name, and the string following the first space specifies the
arguments to the program.
</para>
<para>
If you want to execute a program that has a space in the name or path of
the file, surround the program name in double-quotes. The first character
of the command line should be a double-quote character, and there must be
a matching double-quote following the end of the program file name. Any
optional arguments to the program follow that, separated by
spaces. Example: <c>"c:\project files\program name.exe" arg1 arg2</c>.
</para>
<para>
If the flavor of the SFX is <c>SelfExtractorFlavor.ConsoleApplication</c>,
then the SFX starts a new process, using this string as the post-extract
command line. The SFX waits for the process to exit. The exit code of
the post-extract command line is returned as the exit code of the
command-line self-extractor exe. A non-zero exit code is typically used to
indicated a failure by the program. In the case of an SFX, a non-zero exit
code may indicate a failure during extraction, OR, it may indicate a
failure of the run-after-extract program if specified, OR, it may indicate
the run-after-extract program could not be fuond. There is no way to
distinguish these conditions from the calling shell, aside from parsing
the output of the SFX. If you have Quiet set to <c>true</c>, you may not
see error messages, if a problem occurs.
</para>
<para>
If the flavor of the SFX is
<c>SelfExtractorFlavor.WinFormsApplication</c>, then the SFX starts a new
process, using this string as the post-extract command line, and using the
extract directory as the working directory for the process. The SFX does
not wait for the command to complete, and does not check the exit code of
the program. If the run-after-extract program cannot be fuond, a message
box is displayed indicating that fact.
</para>
<para>
You can specify environment variables within this string, with a format like
<c>%NAME%</c>. The value of these variables will be expanded at the time
the SFX is run. Example: <c>%WINDIR%\system32\xcopy.exe</c> may expand at
runtime to <c>c:\Windows\System32\xcopy.exe</c>.
</para>
<para>
By combining this with the <c>RemoveUnpackedFilesAfterExecute</c>
flag, you can create an SFX that extracts itself, runs a file that
was extracted, then deletes all the files that were extracted. If
you want it to run "invisibly" then set <c>Flavor</c> to
<c>SelfExtractorFlavor.ConsoleApplication</c>, and set <c>Quiet</c>
to true. The user running such an EXE will see a console window
appear, then disappear quickly. You may also want to specify the
default extract location, with <c>DefaultExtractDirectory</c>.
</para>
<para>
If you set <c>Flavor</c> to
<c>SelfExtractorFlavor.WinFormsApplication</c>, and set <c>Quiet</c> to
true, then a GUI with progressbars is displayed, but it is
"non-interactive" - it accepts no input from the user. Instead the SFX
just automatically unpacks and exits.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.DefaultExtractDirectory">
<summary>
The default extract directory the user will see when
running the self-extracting archive.
</summary>
<remarks>
<para>
Passing null (or Nothing in VB) here will cause the Self Extractor to use
the the user's personal directory (<see cref="F:System.Environment.SpecialFolder.Personal"/>) for the default extract
location.
</para>
<para>
This is only a default location. The actual extract location will be
settable on the command line when the SFX is executed.
</para>
<para>
You can specify environment variables within this string,
with <c>%NAME%</c>. The value of these variables will be
expanded at the time the SFX is run. Example:
<c>%USERPROFILE%\Documents\unpack</c> may expand at runtime to
<c>c:\users\melvin\Documents\unpack</c>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.IconFile">
<summary>
The name of an .ico file in the filesystem to use for the application icon
for the generated SFX.
</summary>
<remarks>
<para>
Normally, DotNetZip will embed an "zipped folder" icon into the generated
SFX. If you prefer to use a different icon, you can specify it here. It
should be a .ico file. This file is passed as the <c>/win32icon</c>
option to the csc.exe compiler when constructing the SFX file.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.Quiet">
<summary>
Whether the ConsoleApplication SFX will be quiet during extraction.
</summary>
<remarks>
<para>
This option affects the way the generated SFX runs. By default it is
false. When you set it to true,...
</para>
<list type="table">
<listheader>
<term>Flavor</term>
<description>Behavior</description>
</listheader>
<item>
<term><c>ConsoleApplication</c></term>
<description><para>no messages will be emitted during successful
operation.</para> <para> Double-clicking the SFX in Windows
Explorer or as an attachment in an email will cause a console
window to appear briefly, before it disappears. If you run the
ConsoleApplication SFX from the cmd.exe prompt, it runs as a
normal console app; by default, because it is quiet, it displays
no messages to the console. If you pass the -v+ command line
argument to the Console SFX when you run it, you will get verbose
messages to the console. </para>
</description>
</item>
<item>
<term><c>WinFormsApplication</c></term>
<description>the SFX extracts automatically when the application
is launched, with no additional user input.
</description>
</item>
</list>
<para>
When you set it to false,...
</para>
<list type="table">
<listheader>
<term>Flavor</term>
<description>Behavior</description>
</listheader>
<item>
<term><c>ConsoleApplication</c></term>
<description><para>the extractor will emit a
message to the console for each entry extracted.</para>
<para>
When double-clicking to launch the SFX, the console window will
remain, and the SFX will emit a message for each file as it
extracts. The messages fly by quickly, they won't be easily
readable, unless the extracted files are fairly large.
</para>
</description>
</item>
<item>
<term><c>WinFormsApplication</c></term>
<description>the SFX presents a forms UI and allows the user to select
options before extracting.
</description>
</item>
</list>
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.ExtractExistingFile">
<summary>
Specify what the self-extractor will do when extracting an entry
would overwrite an existing file.
</summary>
<remarks>
<para>
The default behavvior is to Throw.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.RemoveUnpackedFilesAfterExecute">
<summary>
Whether to remove the files that have been unpacked, after executing the
PostExtractCommandLine.
</summary>
<remarks>
<para>
If true, and if there is a <see cref="P:Ionic.Zip.SelfExtractorSaveOptions.PostExtractCommandLine">
PostExtractCommandLine</see>, and if the command runs successfully,
then the files that the SFX unpacked will be removed, afterwards. If
the command does not complete successfully (non-zero return code),
that is interpreted as a failure, and the extracted files will not be
removed.
</para>
<para>
Setting this flag, and setting <c>Flavor</c> to
<c>SelfExtractorFlavor.ConsoleApplication</c>, and setting <c>Quiet</c> to
true, results in an SFX that extracts itself, runs a file that was
extracted, then deletes all the files that were extracted, with no
intervention by the user. You may also want to specify the default
extract location, with <c>DefaultExtractDirectory</c>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.FileVersion">
<summary>
The file version number to embed into the generated EXE. It will show up, for
example, during a mouseover in Windows Explorer.
</summary>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.ProductVersion">
<summary>
The product version to embed into the generated EXE. It will show up, for
example, during a mouseover in Windows Explorer.
</summary>
<remarks>
You can use any arbitrary string, but a human-readable version number is
recommended. For example "v1.2 alpha" or "v4.2 RC2". If you specify nothing,
then there is no product version embedded into the EXE.
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.Copyright">
<summary>
The copyright notice, if any, to embed into the generated EXE.
</summary>
<remarks>
It will show up, for example, while viewing properties of the file in
Windows Explorer. You can use any arbitrary string, but typically you
want something like "Copyright © Dino Chiesa 2011".
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.Description">
<summary>
The description to embed into the generated EXE.
</summary>
<remarks>
Use any arbitrary string. This text will be displayed during a
mouseover in Windows Explorer. If you specify nothing, then the string
"DotNetZip SFX Archive" is embedded into the EXE as the description.
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.ProductName">
<summary>
The product name to embed into the generated EXE.
</summary>
<remarks>
Use any arbitrary string. This text will be displayed
while viewing properties of the EXE file in
Windows Explorer.
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.SfxExeWindowTitle">
<summary>
The title to display in the Window of a GUI SFX, while it extracts.
</summary>
<remarks>
<para>
By default the title show in the GUI window of a self-extractor
is "DotNetZip Self-extractor (http://DotNetZip.codeplex.com/)".
You can change that by setting this property before saving the SFX.
</para>
<para>
This property has an effect only when producing a Self-extractor
of flavor <c>SelfExtractorFlavor.WinFormsApplication</c>.
</para>
</remarks>
</member>
<member name="P:Ionic.Zip.SelfExtractorSaveOptions.AdditionalCompilerSwitches">
<summary>
Additional options for the csc.exe compiler, when producing the SFX
EXE.
</summary>
<exclude/>
</member>
<member name="M:Ionic.BZip2.BitWriter.Reset">
<summary>
Reset the BitWriter.
</summary>
<remarks>
<para>
This is useful when the BitWriter writes into a MemoryStream, and
is used by a BZip2Compressor, which itself is re-used for multiple
distinct data blocks.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BitWriter.WriteBits(System.Int32,System.UInt32)">
<summary>
Write some number of bits from the given value, into the output.
</summary>
<remarks>
<para>
The nbits value should be a max of 25, for safety. For performance
reasons, this method does not check!
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BitWriter.WriteByte(System.Byte)">
<summary>
Write a full 8-bit byte into the output.
</summary>
</member>
<member name="M:Ionic.BZip2.BitWriter.WriteInt(System.UInt32)">
<summary>
Write four 8-bit bytes into the output.
</summary>
</member>
<member name="M:Ionic.BZip2.BitWriter.Flush">
<summary>
Write all available byte-aligned bytes.
</summary>
<remarks>
<para>
This method writes no new output, but flushes any accumulated
bits. At completion, the accumulator may contain up to 7
bits.
</para>
<para>
This is necessary when re-assembling output from N independent
compressors, one for each of N blocks. The output of any
particular compressor will in general have some fragment of a byte
remaining. This fragment needs to be accumulated into the
parent BZip2OutputStream.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BitWriter.FinishAndPad">
<summary>
Writes all available bytes, and emits padding for the final byte as
necessary. This must be the last method invoked on an instance of
BitWriter.
</summary>
</member>
<member name="P:Ionic.BZip2.BitWriter.RemainingBits">
<summary>
Delivers the remaining bits, left-aligned, in a byte.
</summary>
<remarks>
<para>
This is valid only if NumRemainingBits is less than 8;
in other words it is valid only after a call to Flush().
</para>
</remarks>
</member>
<member name="F:Ionic.BZip2.BZip2Compressor.increments">
Knuth's increments seem to work better than Incerpi-Sedgewick here.
Possibly because the number of elems to sort is usually small, typically
<= 20.
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.#ctor(Ionic.BZip2.BitWriter)">
<summary>
BZip2Compressor writes its compressed data out via a BitWriter. This
is necessary because BZip2 does byte shredding.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.Fill(System.Byte[],System.Int32,System.Int32)">
<summary>
Accept new bytes into the compressor data buffer
</summary>
<remarks>
<para>
This method does the first-level (cheap) run-length encoding, and
stores the encoded data into the rle block.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.write0(System.Byte)">
<summary>
Process one input byte into the block.
</summary>
<remarks>
<para>
To "process" the byte means to do the run-length encoding.
There are 3 possible return values:
0 - the byte was not written, in other words, not
encoded into the block. This happens when the
byte b would require the start of a new run, and
the block has no more room for new runs.
1 - the byte was written, and the block is not full.
2 - the byte was written, and the block is full.
</para>
</remarks>
<returns>0 if the byte was not written, non-zero if written.</returns>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.AddRunToOutputBlock(System.Boolean)">
<summary>
Append one run to the output block.
</summary>
<remarks>
<para>
This compressor does run-length-encoding before BWT and etc. This
method simply appends a run to the output block. The append always
succeeds. The return value indicates whether the block is full:
false (not full) implies that at least one additional run could be
processed.
</para>
</remarks>
<returns>true if the block is now full; otherwise false.</returns>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.CompressAndWrite">
<summary>
Compress the data that has been placed (Run-length-encoded) into the
block. The compressed data goes into the CompressedBytes array.
</summary>
<remarks>
<para>
Side effects: 1. fills the CompressedBytes array. 2. sets the
AvailableBytesOut property.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.mainSimpleSort(Ionic.BZip2.BZip2Compressor.CompressionState,System.Int32,System.Int32,System.Int32)">
This is the most hammered method of this class.
<p>
This is the version using unrolled loops.
</p>
</member>
<member name="M:Ionic.BZip2.BZip2Compressor.mainQSort3(Ionic.BZip2.BZip2Compressor.CompressionState,System.Int32,System.Int32,System.Int32)">
Method "mainQSort3", file "blocksort.c", BZip2 1.0.2
</member>
<member name="P:Ionic.BZip2.BZip2Compressor.UncompressedBytes">
<summary>
The number of uncompressed bytes being held in the buffer.
</summary>
<remarks>
<para>
I am thinking this may be useful in a Stream that uses this
compressor class. In the Close() method on the stream it could
check this value to see if anything has been written at all. You
may think the stream could easily track the number of bytes it
wrote, which would eliminate the need for this. But, there is the
case where the stream writes a complete block, and it is full, and
then writes no more. In that case the stream may want to check.
</para>
</remarks>
</member>
<member name="F:Ionic.BZip2.BZip2Compressor.CompressionState.quadrant">
Array instance identical to sfmap, both are used only
temporarily and independently, so we do not need to allocate
additional memory.
</member>
<member name="T:Ionic.BZip2.BZip2InputStream">
<summary>
A read-only decorator stream that performs BZip2 decompression on Read.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.#ctor(System.IO.Stream)">
<summary>
Create a BZip2InputStream, wrapping it around the given input Stream.
</summary>
<remarks>
<para>
The input stream will be closed when the BZip2InputStream is closed.
</para>
</remarks>
<param name='input'>The stream from which to read compressed data</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Create a BZip2InputStream with the given stream, and
specifying whether to leave the wrapped stream open when
the BZip2InputStream is closed.
</summary>
<param name='input'>The stream from which to read compressed data</param>
<param name='leaveOpen'>
Whether to leave the input stream open, when the BZip2InputStream closes.
</param>
<example>
This example reads a bzip2-compressed file, decompresses it,
and writes the decompressed data into a newly created file.
<code>
var fname = "logfile.log.bz2";
using (var fs = File.OpenRead(fname))
{
using (var decompressor = new Ionic.BZip2.BZip2InputStream(fs))
{
var outFname = fname + ".decompressed";
using (var output = File.Create(outFname))
{
byte[] buffer = new byte[2048];
int n;
while ((n = decompressor.Read(buffer, 0, buffer.Length)) > 0)
{
output.Write(buffer, 0, n);
}
}
}
}
</code>
</example>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read data from the stream.
</summary>
<remarks>
<para>
To decompress a BZip2 data stream, create a <c>BZip2InputStream</c>,
providing a stream that reads compressed data. Then call Read() on
that <c>BZip2InputStream</c>, and the data read will be decompressed
as you read.
</para>
<para>
A <c>BZip2InputStream</c> can be used only for <c>Read()</c>, not for <c>Write()</c>.
</para>
</remarks>
<param name="buffer">The buffer into which the read data should be placed.</param>
<param name="offset">the offset within that data array to put the first byte read.</param>
<param name="count">the number of bytes to read.</param>
<returns>the number of bytes actually read</returns>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.ReadByte">
<summary>
Read a single byte from the stream.
</summary>
<returns>the byte read from the stream, or -1 if EOF</returns>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="offset">this is irrelevant, since it will always throw!</param>
<param name="origin">this is irrelevant, since it will always throw!</param>
<returns>irrelevant!</returns>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.SetLength(System.Int64)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="value">this is irrelevant, since it will always throw!</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="buffer">this parameter is never used</param>
<param name="offset">this parameter is never used</param>
<param name="count">this parameter is never used</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Dispose(System.Boolean)">
<summary>
Dispose the stream.
</summary>
<param name="disposing">
indicates whether the Dispose method was invoked by user code.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.Close">
<summary>
Close the stream.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.GetBits(System.Int32)">
<summary>
Read n bits from input, right justifying the result.
</summary>
<remarks>
<para>
For example, if you read 1 bit, the result is either 0
or 1.
</para>
</remarks>
<param name ="n">
The number of bits to read, always between 1 and 32.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.hbCreateDecodeTables(System.Int32[],System.Int32[],System.Int32[],System.Char[],System.Int32,System.Int32,System.Int32)">
Called by createHuffmanDecodingTables() exclusively.
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.createHuffmanDecodingTables(System.Int32,System.Int32)">
Called by recvDecodingTables() exclusively.
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.CanRead">
<summary>
Indicates whether the stream can be read.
</summary>
<remarks>
The return value depends on whether the captive stream supports reading.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.CanWrite">
<summary>
Indicates whether the stream can be written.
</summary>
<remarks>
The return value depends on whether the captive stream supports writing.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.Length">
<summary>
Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
</member>
<member name="P:Ionic.BZip2.BZip2InputStream.Position">
<summary>
The position of the stream pointer.
</summary>
<remarks>
Setting this property always throws a <see cref="T:System.NotImplementedException"/>. Reading will return the
total number of uncompressed bytes read in.
</remarks>
</member>
<member name="T:Ionic.BZip2.BZip2InputStream.CState">
<summary>
Compressor State
</summary>
</member>
<member name="F:Ionic.BZip2.BZip2InputStream.DecompressionState.unzftab">
Freq table collected to save a pass over the data during
decompression.
</member>
<member name="M:Ionic.BZip2.BZip2InputStream.DecompressionState.initTT(System.Int32)">
Initializes the tt array.
This method is called when the required length of the array is known.
I don't initialize it at construction time to avoid unneccessary
memory allocation when compressing small files.
</member>
<member name="T:Ionic.BZip2.BZip2OutputStream">
<summary>
A write-only decorator stream that compresses data as it is
written using the BZip2 algorithm.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream)">
<summary>
Constructs a new <c>BZip2OutputStream</c>, that sends its
compressed output to the given output stream.
</summary>
<param name='output'>
The destination stream, to which compressed output will be sent.
</param>
<example>
This example reads a file, then compresses it with bzip2 file,
and writes the compressed data into a newly created file.
<code>
var fname = "logfile.log";
using (var fs = File.OpenRead(fname))
{
var outFname = fname + ".bz2";
using (var output = File.Create(outFname))
{
using (var compressor = new Ionic.BZip2.BZip2OutputStream(output))
{
byte[] buffer = new byte[2048];
int n;
while ((n = fs.Read(buffer, 0, buffer.Length)) > 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
</example>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Int32)">
<summary>
Constructs a new <c>BZip2OutputStream</c> with specified blocksize.
</summary>
<param name = "output">the destination stream.</param>
<param name = "blockSize">
The blockSize in units of 100000 bytes.
The valid range is 1..9.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Constructs a new <c>BZip2OutputStream</c>.
</summary>
<param name = "output">the destination stream.</param>
<param name = "leaveOpen">
whether to leave the captive stream open upon closing this stream.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Int32,System.Boolean)">
<summary>
Constructs a new <c>BZip2OutputStream</c> with specified blocksize,
and explicitly specifies whether to leave the wrapped stream open.
</summary>
<param name = "output">the destination stream.</param>
<param name = "blockSize">
The blockSize in units of 100000 bytes.
The valid range is 1..9.
</param>
<param name = "leaveOpen">
whether to leave the captive stream open upon closing this stream.
</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Close">
<summary>
Close the stream.
</summary>
<remarks>
<para>
This may or may not close the underlying stream. Check the
constructors that accept a bool value.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write data to the stream.
</summary>
<remarks>
<para>
Use the <c>BZip2OutputStream</c> to compress data while writing:
create a <c>BZip2OutputStream</c> with a writable output stream.
Then call <c>Write()</c> on that <c>BZip2OutputStream</c>, providing
uncompressed data as input. The data sent to the output stream will
be the compressed form of the input data.
</para>
<para>
A <c>BZip2OutputStream</c> can be used only for <c>Write()</c> not for <c>Read()</c>.
</para>
</remarks>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="offset">this is irrelevant, since it will always throw!</param>
<param name="origin">this is irrelevant, since it will always throw!</param>
<returns>irrelevant!</returns>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.SetLength(System.Int64)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="value">this is irrelevant, since it will always throw!</param>
</member>
<member name="M:Ionic.BZip2.BZip2OutputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="buffer">this parameter is never used</param>
<param name="offset">this parameter is never used</param>
<param name="count">this parameter is never used</param>
<returns>never returns anything; always throws</returns>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.BlockSize">
<summary>
The blocksize parameter specified at construction time.
</summary>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.CanRead">
<summary>
Indicates whether the stream can be read.
</summary>
<remarks>
The return value is always false.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.CanWrite">
<summary>
Indicates whether the stream can be written.
</summary>
<remarks>
The return value should always be true, unless and until the
object is disposed and closed.
</remarks>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.Length">
<summary>
Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
</member>
<member name="P:Ionic.BZip2.BZip2OutputStream.Position">
<summary>
The position of the stream pointer.
</summary>
<remarks>
Setting this property always throws a <see cref="T:System.NotImplementedException"/>. Reading will return the
total number of uncompressed bytes written through.
</remarks>
</member>
<member name="T:Ionic.BZip2.ParallelBZip2OutputStream">
<summary>
A write-only decorator stream that compresses data as it is
written using the BZip2 algorithm. This stream compresses by
block using multiple threads.
</summary>
<para>
This class performs BZIP2 compression through writing. For
more information on the BZIP2 algorithm, see
<see href="http://en.wikipedia.org/wiki/BZIP2"/>.
</para>
<para>
This class is similar to <see cref="T:Ionic.BZip2.BZip2OutputStream"/>,
except that this implementation uses an approach that employs multiple
worker threads to perform the compression. On a multi-cpu or multi-core
computer, the performance of this class can be significantly higher than
the single-threaded BZip2OutputStream, particularly for larger streams.
How large? Anything over 10mb is a good candidate for parallel
compression.
</para>
<para>
The tradeoff is that this class uses more memory and more CPU than the
vanilla <c>BZip2OutputStream</c>. Also, for small files, the
<c>ParallelBZip2OutputStream</c> can be much slower than the vanilla
<c>BZip2OutputStream</c>, because of the overhead associated to using the
thread pool.
</para>
<seealso cref="T:Ionic.BZip2.BZip2OutputStream"/>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.#ctor(System.IO.Stream)">
<summary>
Constructs a new <c>ParallelBZip2OutputStream</c>, that sends its
compressed output to the given output stream.
</summary>
<param name='output'>
The destination stream, to which compressed output will be sent.
</param>
<example>
This example reads a file, then compresses it with bzip2 file,
and writes the compressed data into a newly created file.
<code>
var fname = "logfile.log";
using (var fs = File.OpenRead(fname))
{
var outFname = fname + ".bz2";
using (var output = File.Create(outFname))
{
using (var compressor = new Ionic.BZip2.ParallelBZip2OutputStream(output))
{
byte[] buffer = new byte[2048];
int n;
while ((n = fs.Read(buffer, 0, buffer.Length)) > 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
</example>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.#ctor(System.IO.Stream,System.Int32)">
<summary>
Constructs a new <c>ParallelBZip2OutputStream</c> with specified blocksize.
</summary>
<param name = "output">the destination stream.</param>
<param name = "blockSize">
The blockSize in units of 100000 bytes.
The valid range is 1..9.
</param>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Constructs a new <c>ParallelBZip2OutputStream</c>.
</summary>
<param name = "output">the destination stream.</param>
<param name = "leaveOpen">
whether to leave the captive stream open upon closing this stream.
</param>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.#ctor(System.IO.Stream,System.Int32,System.Boolean)">
<summary>
Constructs a new <c>ParallelBZip2OutputStream</c> with specified blocksize,
and explicitly specifies whether to leave the wrapped stream open.
</summary>
<param name = "output">the destination stream.</param>
<param name = "blockSize">
The blockSize in units of 100000 bytes.
The valid range is 1..9.
</param>
<param name = "leaveOpen">
whether to leave the captive stream open upon closing this stream.
</param>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.Close">
<summary>
Close the stream.
</summary>
<remarks>
<para>
This may or may not close the underlying stream. Check the
constructors that accept a bool value.
</para>
</remarks>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write data to the stream.
</summary>
<remarks>
<para>
Use the <c>ParallelBZip2OutputStream</c> to compress data while
writing: create a <c>ParallelBZip2OutputStream</c> with a writable
output stream. Then call <c>Write()</c> on that
<c>ParallelBZip2OutputStream</c>, providing uncompressed data as
input. The data sent to the output stream will be the compressed
form of the input data.
</para>
<para>
A <c>ParallelBZip2OutputStream</c> can be used only for
<c>Write()</c> not for <c>Read()</c>.
</para>
</remarks>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="offset">this is irrelevant, since it will always throw!</param>
<param name="origin">this is irrelevant, since it will always throw!</param>
<returns>irrelevant!</returns>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.SetLength(System.Int64)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="value">this is irrelevant, since it will always throw!</param>
</member>
<member name="M:Ionic.BZip2.ParallelBZip2OutputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="buffer">this parameter is never used</param>
<param name="offset">this parameter is never used</param>
<param name="count">this parameter is never used</param>
<returns>never returns anything; always throws</returns>
</member>
<member name="P:Ionic.BZip2.ParallelBZip2OutputStream.MaxWorkers">
<summary>
The maximum number of concurrent compression worker threads to use.
</summary>
<remarks>
<para>
This property sets an upper limit on the number of concurrent worker
threads to employ for compression. The implementation of this stream
employs multiple threads from the .NET thread pool, via <see cref="M:System.Threading.ThreadPool.QueueUserWorkItem(System.Threading.WaitCallback)">
ThreadPool.QueueUserWorkItem()</see>, to compress the incoming data by
block. As each block of data is compressed, this stream re-orders the
compressed blocks and writes them to the output stream.
</para>
<para>
A higher number of workers enables a higher degree of
parallelism, which tends to increase the speed of compression on
multi-cpu computers. On the other hand, a higher number of buffer
pairs also implies a larger memory consumption, more active worker
threads, and a higher cpu utilization for any compression. This
property enables the application to limit its memory consumption and
CPU utilization behavior depending on requirements.
</para>
<para>
By default, DotNetZip allocates 4 workers per CPU core, subject to the
upper limit specified in this property. For example, suppose the
application sets this property to 16. Then, on a machine with 2
cores, DotNetZip will use 8 workers; that number does not exceed the
upper limit specified by this property, so the actual number of
workers used will be 4 * 2 = 8. On a machine with 4 cores, DotNetZip
will use 16 workers; again, the limit does not apply. On a machine
with 8 cores, DotNetZip will use 16 workers, because of the limit.
</para>
<para>
For each compression "worker thread" that occurs in parallel, there is
up to 2mb of memory allocated, for buffering and processing. The
actual number depends on the <see cref="P:Ionic.BZip2.ParallelBZip2OutputStream.BlockSize"/> property.
</para>
<para>
CPU utilization will also go up with additional workers, because a
larger number of buffer pairs allows a larger number of background
threads to compress in parallel. If you find that parallel
compression is consuming too much memory or CPU, you can adjust this
value downward.
</para>
<para>
The default value is 16. Different values may deliver better or
worse results, depending on your priorities and the dynamic
performance characteristics of your storage and compute resources.
</para>
<para>
The application can set this value at any time, but it is effective
only before the first call to Write(), which is when the buffers are
allocated.
</para>
</remarks>
</member>
<member name="P:Ionic.BZip2.ParallelBZip2OutputStream.BlockSize">
<summary>
The blocksize parameter specified at construction time.
</summary>
</member>
<member name="P:Ionic.BZip2.ParallelBZip2OutputStream.CanRead">
<summary>
Indicates whether the stream can be read.
</summary>
<remarks>
The return value is always false.
</remarks>
</member>
<member name="P:Ionic.BZip2.ParallelBZip2OutputStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.BZip2.ParallelBZip2OutputStream.CanWrite">
<summary>
Indicates whether the stream can be written.
</summary>
<remarks>
The return value depends on whether the captive stream supports writing.
</remarks>
</member>
<member name="P:Ionic.BZip2.ParallelBZip2OutputStream.Length">
<summary>
Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
</member>
<member name="P:Ionic.BZip2.ParallelBZip2OutputStream.Position">
<summary>
The position of the stream pointer.
</summary>
<remarks>
Setting this property always throws a <see cref="T:System.NotImplementedException"/>. Reading will return the
total number of uncompressed bytes written through.
</remarks>
</member>
<member name="P:Ionic.BZip2.ParallelBZip2OutputStream.BytesWrittenOut">
<summary>
The total number of bytes written out by the stream.
</summary>
<remarks>
This value is meaningful only after a call to Close().
</remarks>
</member>
<member name="M:Ionic.BZip2.Rand.Rnums(System.Int32)">
<summary>
Returns the "random" number at a specific index.
</summary>
<param name='i'>the index</param>
<returns>the random number</returns>
</member>
<member name="T:Ionic.Zlib.DeflateStream">
<summary>
A class for compressing and decompressing streams using the Deflate algorithm.
</summary>
<remarks>
<para>
The DeflateStream is a <see href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</see> on a <see cref="T:System.IO.Stream"/>. It adds DEFLATE compression or decompression to any
stream.
</para>
<para>
Using this stream, applications can compress or decompress data via stream
<c>Read</c> and <c>Write</c> operations. Either compresssion or decompression
can occur through either reading or writing. The compression format used is
DEFLATE, which is documented in <see href="http://www.ietf.org/rfc/rfc1951.txt">IETF RFC 1951</see>, "DEFLATE
Compressed Data Format Specification version 1.3.".
</para>
<para>
This class is similar to <see cref="T:Ionic.Zlib.ZlibStream"/>, except that
<c>ZlibStream</c> adds the <see href="http://www.ietf.org/rfc/rfc1950.txt">RFC
1950 - ZLIB</see> framing bytes to a compressed stream when compressing, or
expects the RFC1950 framing bytes when decompressing. The <c>DeflateStream</c>
does not.
</para>
</remarks>
<seealso cref="T:Ionic.Zlib.ZlibStream"/>
<seealso cref="T:Ionic.Zlib.GZipStream"/>
</member>
<member name="M:Ionic.Zlib.DeflateStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode)">
<summary>
Create a DeflateStream using the specified CompressionMode.
</summary>
<remarks>
When mode is <c>CompressionMode.Compress</c>, the DeflateStream will use
the default compression level. The "captive" stream will be closed when
the DeflateStream is closed.
</remarks>
<example>
This example uses a DeflateStream to compress data from a file, and writes
the compressed data to another file.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(fileToCompress + ".deflated"))
{
using (Stream compressor = new DeflateStream(raw, CompressionMode.Compress))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(fileToCompress & ".deflated")
Using compressor As Stream = New DeflateStream(raw, CompressionMode.Compress)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the DeflateStream will compress or decompress.</param>
</member>
<member name="M:Ionic.Zlib.DeflateStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,Ionic.Zlib.CompressionLevel)">
<summary>
Create a DeflateStream using the specified CompressionMode and the specified CompressionLevel.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Decompress</c>, the level parameter is
ignored. The "captive" stream will be closed when the DeflateStream is
closed.
</para>
</remarks>
<example>
This example uses a DeflateStream to compress data from a file, and writes
the compressed data to another file.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(fileToCompress + ".deflated"))
{
using (Stream compressor = new DeflateStream(raw,
CompressionMode.Compress,
CompressionLevel.BestCompression))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n= -1;
while (n != 0)
{
if (n > 0)
compressor.Write(buffer, 0, n);
n= input.Read(buffer, 0, buffer.Length);
}
}
}
}
</code>
<code lang="VB">
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(fileToCompress & ".deflated")
Using compressor As Stream = New DeflateStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream to be read or written while deflating or inflating.</param>
<param name="mode">Indicates whether the <c>DeflateStream</c> will compress or decompress.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
</member>
<member name="M:Ionic.Zlib.DeflateStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,System.Boolean)">
<summary>
Create a <c>DeflateStream</c> using the specified
<c>CompressionMode</c>, and explicitly specify whether the
stream should be left open after Deflation or Inflation.
</summary>
<remarks>
<para>
This constructor allows the application to request that the captive stream
remain open after the deflation or inflation occurs. By default, after
<c>Close()</c> is called on the stream, the captive stream is also
closed. In some cases this is not desired, for example if the stream is a
memory stream that will be re-read after compression. Specify true for
the <paramref name="leaveOpen"/> parameter to leave the stream open.
</para>
<para>
The <c>DeflateStream</c> will use the default compression level.
</para>
<para>
See the other overloads of this constructor for example code.
</para>
</remarks>
<param name="stream">
The stream which will be read or written. This is called the
"captive" stream in other places in this documentation.
</param>
<param name="mode">
Indicates whether the <c>DeflateStream</c> will compress or decompress.
</param>
<param name="leaveOpen">true if the application would like the stream to
remain open after inflation/deflation.</param>
</member>
<member name="M:Ionic.Zlib.DeflateStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,Ionic.Zlib.CompressionLevel,System.Boolean)">
<summary>
Create a <c>DeflateStream</c> using the specified <c>CompressionMode</c>
and the specified <c>CompressionLevel</c>, and explicitly specify whether
the stream should be left open after Deflation or Inflation.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Decompress</c>, the level parameter is ignored.
</para>
<para>
This constructor allows the application to request that the captive stream
remain open after the deflation or inflation occurs. By default, after
<c>Close()</c> is called on the stream, the captive stream is also
closed. In some cases this is not desired, for example if the stream is a
<see cref="T:System.IO.MemoryStream"/> that will be re-read after
compression. Specify true for the <paramref name="leaveOpen"/> parameter
to leave the stream open.
</para>
</remarks>
<example>
This example shows how to use a <c>DeflateStream</c> to compress data from
a file, and store the compressed data into another file.
<code>
using (var output = System.IO.File.Create(fileToCompress + ".deflated"))
{
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (Stream compressor = new DeflateStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, true))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n= -1;
while (n != 0)
{
if (n > 0)
compressor.Write(buffer, 0, n);
n= input.Read(buffer, 0, buffer.Length);
}
}
}
// can write additional data to the output stream here
}
</code>
<code lang="VB">
Using output As FileStream = File.Create(fileToCompress & ".deflated")
Using input As Stream = File.OpenRead(fileToCompress)
Using compressor As Stream = New DeflateStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, True)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
' can write additional data to the output stream here.
End Using
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the DeflateStream will compress or decompress.</param>
<param name="leaveOpen">true if the application would like the stream to remain open after inflation/deflation.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
</member>
<member name="M:Ionic.Zlib.DeflateStream.Dispose(System.Boolean)">
<summary>
Dispose the stream.
</summary>
<remarks>
<para>
This may or may not result in a <c>Close()</c> call on the captive
stream. See the constructors that have a <c>leaveOpen</c> parameter
for more information.
</para>
<para>
Application code won't call this code directly. This method may be
invoked in two distinct scenarios. If disposing == true, the method
has been called directly or indirectly by a user's code, for example
via the public Dispose() method. In this case, both managed and
unmanaged resources can be referenced and disposed. If disposing ==
false, the method has been called by the runtime from inside the
object finalizer and this method should not reference other objects;
in that case only unmanaged resources must be referenced or
disposed.
</para>
</remarks>
<param name="disposing">
true if the Dispose method was invoked by user code.
</param>
</member>
<member name="M:Ionic.Zlib.DeflateStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.Zlib.DeflateStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read data from the stream.
</summary>
<remarks>
<para>
If you wish to use the <c>DeflateStream</c> to compress data while
reading, you can create a <c>DeflateStream</c> with
<c>CompressionMode.Compress</c>, providing an uncompressed data stream.
Then call Read() on that <c>DeflateStream</c>, and the data read will be
compressed as you read. If you wish to use the <c>DeflateStream</c> to
decompress data while reading, you can create a <c>DeflateStream</c> with
<c>CompressionMode.Decompress</c>, providing a readable compressed data
stream. Then call Read() on that <c>DeflateStream</c>, and the data read
will be decompressed as you read.
</para>
<para>
A <c>DeflateStream</c> can be used for <c>Read()</c> or <c>Write()</c>, but not both.
</para>
</remarks>
<param name="buffer">The buffer into which the read data should be placed.</param>
<param name="offset">the offset within that data array to put the first byte read.</param>
<param name="count">the number of bytes to read.</param>
<returns>the number of bytes actually read</returns>
</member>
<member name="M:Ionic.Zlib.DeflateStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="offset">this is irrelevant, since it will always throw!</param>
<param name="origin">this is irrelevant, since it will always throw!</param>
<returns>irrelevant!</returns>
</member>
<member name="M:Ionic.Zlib.DeflateStream.SetLength(System.Int64)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="value">this is irrelevant, since it will always throw!</param>
</member>
<member name="M:Ionic.Zlib.DeflateStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write data to the stream.
</summary>
<remarks>
<para>
If you wish to use the <c>DeflateStream</c> to compress data while
writing, you can create a <c>DeflateStream</c> with
<c>CompressionMode.Compress</c>, and a writable output stream. Then call
<c>Write()</c> on that <c>DeflateStream</c>, providing uncompressed data
as input. The data sent to the output stream will be the compressed form
of the data written. If you wish to use the <c>DeflateStream</c> to
decompress data while writing, you can create a <c>DeflateStream</c> with
<c>CompressionMode.Decompress</c>, and a writable output stream. Then
call <c>Write()</c> on that stream, providing previously compressed
data. The data sent to the output stream will be the decompressed form of
the data written.
</para>
<para>
A <c>DeflateStream</c> can be used for <c>Read()</c> or <c>Write()</c>,
but not both.
</para>
</remarks>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="M:Ionic.Zlib.DeflateStream.CompressString(System.String)">
<summary>
Compress a string into a byte array using DEFLATE (RFC 1951).
</summary>
<remarks>
Uncompress it with <see cref="M:Ionic.Zlib.DeflateStream.UncompressString(System.Byte[])"/>.
</remarks>
<seealso cref="M:Ionic.Zlib.DeflateStream.UncompressString(System.Byte[])">DeflateStream.UncompressString(byte[])</seealso>
<seealso cref="M:Ionic.Zlib.DeflateStream.CompressBuffer(System.Byte[])">DeflateStream.CompressBuffer(byte[])</seealso>
<seealso cref="M:Ionic.Zlib.GZipStream.CompressString(System.String)">GZipStream.CompressString(string)</seealso>
<seealso cref="M:Ionic.Zlib.ZlibStream.CompressString(System.String)">ZlibStream.CompressString(string)</seealso>
<param name="s">
A string to compress. The string will first be encoded
using UTF8, then compressed.
</param>
<returns>The string in compressed form</returns>
</member>
<member name="M:Ionic.Zlib.DeflateStream.CompressBuffer(System.Byte[])">
<summary>
Compress a byte array into a new byte array using DEFLATE.
</summary>
<remarks>
Uncompress it with <see cref="M:Ionic.Zlib.DeflateStream.UncompressBuffer(System.Byte[])"/>.
</remarks>
<seealso cref="M:Ionic.Zlib.DeflateStream.CompressString(System.String)">DeflateStream.CompressString(string)</seealso>
<seealso cref="M:Ionic.Zlib.DeflateStream.UncompressBuffer(System.Byte[])">DeflateStream.UncompressBuffer(byte[])</seealso>
<seealso cref="M:Ionic.Zlib.GZipStream.CompressBuffer(System.Byte[])">GZipStream.CompressBuffer(byte[])</seealso>
<seealso cref="M:Ionic.Zlib.ZlibStream.CompressBuffer(System.Byte[])">ZlibStream.CompressBuffer(byte[])</seealso>
<param name="b">
A buffer to compress.
</param>
<returns>The data in compressed form</returns>
</member>
<member name="M:Ionic.Zlib.DeflateStream.UncompressString(System.Byte[])">
<summary>
Uncompress a DEFLATE'd byte array into a single string.
</summary>
<seealso cref="M:Ionic.Zlib.DeflateStream.CompressString(System.String)">DeflateStream.CompressString(String)</seealso>
<seealso cref="M:Ionic.Zlib.DeflateStream.UncompressBuffer(System.Byte[])">DeflateStream.UncompressBuffer(byte[])</seealso>
<seealso cref="M:Ionic.Zlib.GZipStream.UncompressString(System.Byte[])">GZipStream.UncompressString(byte[])</seealso>
<seealso cref="M:Ionic.Zlib.ZlibStream.UncompressString(System.Byte[])">ZlibStream.UncompressString(byte[])</seealso>
<param name="compressed">
A buffer containing DEFLATE-compressed data.
</param>
<returns>The uncompressed string</returns>
</member>
<member name="M:Ionic.Zlib.DeflateStream.UncompressBuffer(System.Byte[])">
<summary>
Uncompress a DEFLATE'd byte array into a byte array.
</summary>
<seealso cref="M:Ionic.Zlib.DeflateStream.CompressBuffer(System.Byte[])">DeflateStream.CompressBuffer(byte[])</seealso>
<seealso cref="M:Ionic.Zlib.DeflateStream.UncompressString(System.Byte[])">DeflateStream.UncompressString(byte[])</seealso>
<seealso cref="M:Ionic.Zlib.GZipStream.UncompressBuffer(System.Byte[])">GZipStream.UncompressBuffer(byte[])</seealso>
<seealso cref="M:Ionic.Zlib.ZlibStream.UncompressBuffer(System.Byte[])">ZlibStream.UncompressBuffer(byte[])</seealso>
<param name="compressed">
A buffer containing data that has been compressed with DEFLATE.
</param>
<returns>The data in uncompressed form</returns>
</member>
<member name="P:Ionic.Zlib.DeflateStream.FlushMode">
<summary>
This property sets the flush behavior on the stream.
</summary>
<remarks> See the ZLIB documentation for the meaning of the flush behavior.
</remarks>
</member>
<member name="P:Ionic.Zlib.DeflateStream.BufferSize">
<summary>
The size of the working buffer for the compression codec.
</summary>
<remarks>
<para>
The working buffer is used for all stream operations. The default size is
1024 bytes. The minimum size is 128 bytes. You may get better performance
with a larger buffer. Then again, you might not. You would have to test
it.
</para>
<para>
Set this before the first call to <c>Read()</c> or <c>Write()</c> on the
stream. If you try to set it afterwards, it will throw.
</para>
</remarks>
</member>
<member name="P:Ionic.Zlib.DeflateStream.Strategy">
<summary>
The ZLIB strategy to be used during compression.
</summary>
<remarks>
By tweaking this parameter, you may be able to optimize the compression for
data with particular characteristics.
</remarks>
</member>
<member name="P:Ionic.Zlib.DeflateStream.TotalIn">
<summary> Returns the total number of bytes input so far.</summary>
</member>
<member name="P:Ionic.Zlib.DeflateStream.TotalOut">
<summary> Returns the total number of bytes output so far.</summary>
</member>
<member name="P:Ionic.Zlib.DeflateStream.CanRead">
<summary>
Indicates whether the stream can be read.
</summary>
<remarks>
The return value depends on whether the captive stream supports reading.
</remarks>
</member>
<member name="P:Ionic.Zlib.DeflateStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.Zlib.DeflateStream.CanWrite">
<summary>
Indicates whether the stream can be written.
</summary>
<remarks>
The return value depends on whether the captive stream supports writing.
</remarks>
</member>
<member name="P:Ionic.Zlib.DeflateStream.Length">
<summary>
Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
</member>
<member name="P:Ionic.Zlib.DeflateStream.Position">
<summary>
The position of the stream pointer.
</summary>
<remarks>
Setting this property always throws a <see cref="T:System.NotImplementedException"/>. Reading will return the total bytes
written out, if used in writing, or the total bytes read in, if used in
reading. The count may refer to compressed bytes or uncompressed bytes,
depending on how you've used the stream.
</remarks>
</member>
<member name="T:Ionic.Zlib.GZipStream">
<summary>
A class for compressing and decompressing GZIP streams.
</summary>
<remarks>
<para>
The <c>GZipStream</c> is a <see href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</see> on a
<see cref="T:System.IO.Stream"/>. It adds GZIP compression or decompression to any
stream.
</para>
<para>
Like the <c>System.IO.Compression.GZipStream</c> in the .NET Base Class Library, the
<c>Ionic.Zlib.GZipStream</c> can compress while writing, or decompress while
reading, but not vice versa. The compression method used is GZIP, which is
documented in <see href="http://www.ietf.org/rfc/rfc1952.txt">IETF RFC
1952</see>, "GZIP file format specification version 4.3".</para>
<para>
A <c>GZipStream</c> can be used to decompress data (through <c>Read()</c>) or
to compress data (through <c>Write()</c>), but not both.
</para>
<para>
If you wish to use the <c>GZipStream</c> to compress data, you must wrap it
around a write-able stream. As you call <c>Write()</c> on the <c>GZipStream</c>, the
data will be compressed into the GZIP format. If you want to decompress data,
you must wrap the <c>GZipStream</c> around a readable stream that contains an
IETF RFC 1952-compliant stream. The data will be decompressed as you call
<c>Read()</c> on the <c>GZipStream</c>.
</para>
<para>
Though the GZIP format allows data from multiple files to be concatenated
together, this stream handles only a single segment of GZIP format, typically
representing a single file.
</para>
<para>
This class is similar to <see cref="T:Ionic.Zlib.ZlibStream"/> and <see cref="T:Ionic.Zlib.DeflateStream"/>.
<c>ZlibStream</c> handles RFC1950-compliant streams. <see cref="T:Ionic.Zlib.DeflateStream"/>
handles RFC1951-compliant streams. This class handles RFC1952-compliant streams.
</para>
</remarks>
<seealso cref="T:Ionic.Zlib.DeflateStream"/>
<seealso cref="T:Ionic.Zlib.ZlibStream"/>
</member>
<member name="F:Ionic.Zlib.GZipStream.LastModified">
<summary>
The last modified time for the GZIP stream.
</summary>
<remarks>
GZIP allows the storage of a last modified time with each GZIP entry.
When compressing data, you can set this before the first call to
<c>Write()</c>. When decompressing, you can retrieve this value any time
after the first call to <c>Read()</c>.
</remarks>
</member>
<member name="M:Ionic.Zlib.GZipStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode)">
<summary>
Create a <c>GZipStream</c> using the specified <c>CompressionMode</c>.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Compress</c>, the <c>GZipStream</c> will use the
default compression level.
</para>
<para>
As noted in the class documentation, the <c>CompressionMode</c> (Compress
or Decompress) also establishes the "direction" of the stream. A
<c>GZipStream</c> with <c>CompressionMode.Compress</c> works only through
<c>Write()</c>. A <c>GZipStream</c> with
<c>CompressionMode.Decompress</c> works only through <c>Read()</c>.
</para>
</remarks>
<example>
This example shows how to use a GZipStream to compress data.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(outputFile))
{
using (Stream compressor = new GZipStream(raw, CompressionMode.Compress))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Dim outputFile As String = (fileToCompress & ".compressed")
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(outputFile)
Using compressor As Stream = New GZipStream(raw, CompressionMode.Compress)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<example>
This example shows how to use a GZipStream to uncompress a file.
<code>
private void GunZipFile(string filename)
{
if (!filename.EndsWith(".gz))
throw new ArgumentException("filename");
var DecompressedFile = filename.Substring(0,filename.Length-3);
byte[] working = new byte[WORKING_BUFFER_SIZE];
int n= 1;
using (System.IO.Stream input = System.IO.File.OpenRead(filename))
{
using (Stream decompressor= new Ionic.Zlib.GZipStream(input, CompressionMode.Decompress, true))
{
using (var output = System.IO.File.Create(DecompressedFile))
{
while (n !=0)
{
n= decompressor.Read(working, 0, working.Length);
if (n > 0)
{
output.Write(working, 0, n);
}
}
}
}
}
}
</code>
<code lang="VB">
Private Sub GunZipFile(ByVal filename as String)
If Not (filename.EndsWith(".gz)) Then
Throw New ArgumentException("filename")
End If
Dim DecompressedFile as String = filename.Substring(0,filename.Length-3)
Dim working(WORKING_BUFFER_SIZE) as Byte
Dim n As Integer = 1
Using input As Stream = File.OpenRead(filename)
Using decompressor As Stream = new Ionic.Zlib.GZipStream(input, CompressionMode.Decompress, True)
Using output As Stream = File.Create(UncompressedFile)
Do
n= decompressor.Read(working, 0, working.Length)
If n > 0 Then
output.Write(working, 0, n)
End IF
Loop While (n > 0)
End Using
End Using
End Using
End Sub
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the GZipStream will compress or decompress.</param>
</member>
<member name="M:Ionic.Zlib.GZipStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,Ionic.Zlib.CompressionLevel)">
<summary>
Create a <c>GZipStream</c> using the specified <c>CompressionMode</c> and
the specified <c>CompressionLevel</c>.
</summary>
<remarks>
<para>
The <c>CompressionMode</c> (Compress or Decompress) also establishes the
"direction" of the stream. A <c>GZipStream</c> with
<c>CompressionMode.Compress</c> works only through <c>Write()</c>. A
<c>GZipStream</c> with <c>CompressionMode.Decompress</c> works only
through <c>Read()</c>.
</para>
</remarks>
<example>
This example shows how to use a <c>GZipStream</c> to compress a file into a .gz file.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(fileToCompress + ".gz"))
{
using (Stream compressor = new GZipStream(raw,
CompressionMode.Compress,
CompressionLevel.BestCompression))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(fileToCompress & ".gz")
Using compressor As Stream = New GZipStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream to be read or written while deflating or inflating.</param>
<param name="mode">Indicates whether the <c>GZipStream</c> will compress or decompress.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
</member>
<member name="M:Ionic.Zlib.GZipStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,System.Boolean)">
<summary>
Create a <c>GZipStream</c> using the specified <c>CompressionMode</c>, and
explicitly specify whether the stream should be left open after Deflation
or Inflation.
</summary>
<remarks>
<para>
This constructor allows the application to request that the captive stream
remain open after the deflation or inflation occurs. By default, after
<c>Close()</c> is called on the stream, the captive stream is also
closed. In some cases this is not desired, for example if the stream is a
memory stream that will be re-read after compressed data has been written
to it. Specify true for the <paramref name="leaveOpen"/> parameter to leave
the stream open.
</para>
<para>
The <see cref="T:Ionic.Zlib.CompressionMode"/> (Compress or Decompress) also
establishes the "direction" of the stream. A <c>GZipStream</c> with
<c>CompressionMode.Compress</c> works only through <c>Write()</c>. A <c>GZipStream</c>
with <c>CompressionMode.Decompress</c> works only through <c>Read()</c>.
</para>
<para>
The <c>GZipStream</c> will use the default compression level. If you want
to specify the compression level, see <see cref="M:Ionic.Zlib.GZipStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,Ionic.Zlib.CompressionLevel,System.Boolean)"/>.
</para>
<para>
See the other overloads of this constructor for example code.
</para>
</remarks>
<param name="stream">
The stream which will be read or written. This is called the "captive"
stream in other places in this documentation.
</param>
<param name="mode">Indicates whether the GZipStream will compress or decompress.
</param>
<param name="leaveOpen">
true if the application would like the base stream to remain open after
inflation/deflation.
</param>
</member>
<member name="M:Ionic.Zlib.GZipStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,Ionic.Zlib.CompressionLevel,System.Boolean)">
<summary>
Create a <c>GZipStream</c> using the specified <c>CompressionMode</c> and the
specified <c>CompressionLevel</c>, and explicitly specify whether the
stream should be left open after Deflation or Inflation.
</summary>
<remarks>
<para>
This constructor allows the application to request that the captive stream
remain open after the deflation or inflation occurs. By default, after
<c>Close()</c> is called on the stream, the captive stream is also
closed. In some cases this is not desired, for example if the stream is a
memory stream that will be re-read after compressed data has been written
to it. Specify true for the <paramref name="leaveOpen"/> parameter to
leave the stream open.
</para>
<para>
As noted in the class documentation, the <c>CompressionMode</c> (Compress
or Decompress) also establishes the "direction" of the stream. A
<c>GZipStream</c> with <c>CompressionMode.Compress</c> works only through
<c>Write()</c>. A <c>GZipStream</c> with <c>CompressionMode.Decompress</c> works only
through <c>Read()</c>.
</para>
</remarks>
<example>
This example shows how to use a <c>GZipStream</c> to compress data.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(outputFile))
{
using (Stream compressor = new GZipStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression, true))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Dim outputFile As String = (fileToCompress & ".compressed")
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(outputFile)
Using compressor As Stream = New GZipStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression, True)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the GZipStream will compress or decompress.</param>
<param name="leaveOpen">true if the application would like the stream to remain open after inflation/deflation.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
</member>
<member name="M:Ionic.Zlib.GZipStream.Dispose(System.Boolean)">
<summary>
Dispose the stream.
</summary>
<remarks>
<para>
This may or may not result in a <c>Close()</c> call on the captive
stream. See the constructors that have a <c>leaveOpen</c> parameter
for more information.
</para>
<para>
This method may be invoked in two distinct scenarios. If disposing
== true, the method has been called directly or indirectly by a
user's code, for example via the public Dispose() method. In this
case, both managed and unmanaged resources can be referenced and
disposed. If disposing == false, the method has been called by the
runtime from inside the object finalizer and this method should not
reference other objects; in that case only unmanaged resources must
be referenced or disposed.
</para>
</remarks>
<param name="disposing">
indicates whether the Dispose method was invoked by user code.
</param>
</member>
<member name="M:Ionic.Zlib.GZipStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.Zlib.GZipStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read and decompress data from the source stream.
</summary>
<remarks>
With a <c>GZipStream</c>, decompression is done through reading.
</remarks>
<example>
<code>
byte[] working = new byte[WORKING_BUFFER_SIZE];
using (System.IO.Stream input = System.IO.File.OpenRead(_CompressedFile))
{
using (Stream decompressor= new Ionic.Zlib.GZipStream(input, CompressionMode.Decompress, true))
{
using (var output = System.IO.File.Create(_DecompressedFile))
{
int n;
while ((n= decompressor.Read(working, 0, working.Length)) !=0)
{
output.Write(working, 0, n);
}
}
}
}
</code>
</example>
<param name="buffer">The buffer into which the decompressed data should be placed.</param>
<param name="offset">the offset within that data array to put the first byte read.</param>
<param name="count">the number of bytes to read.</param>
<returns>the number of bytes actually read</returns>
</member>
<member name="M:Ionic.Zlib.GZipStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="offset">irrelevant; it will always throw!</param>
<param name="origin">irrelevant; it will always throw!</param>
<returns>irrelevant!</returns>
</member>
<member name="M:Ionic.Zlib.GZipStream.SetLength(System.Int64)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="value">irrelevant; this method will always throw!</param>
</member>
<member name="M:Ionic.Zlib.GZipStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write data to the stream.
</summary>
<remarks>
<para>
If you wish to use the <c>GZipStream</c> to compress data while writing,
you can create a <c>GZipStream</c> with <c>CompressionMode.Compress</c>, and a
writable output stream. Then call <c>Write()</c> on that <c>GZipStream</c>,
providing uncompressed data as input. The data sent to the output stream
will be the compressed form of the data written.
</para>
<para>
A <c>GZipStream</c> can be used for <c>Read()</c> or <c>Write()</c>, but not
both. Writing implies compression. Reading implies decompression.
</para>
</remarks>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="M:Ionic.Zlib.GZipStream.CompressString(System.String)">
<summary>
Compress a string into a byte array using GZip.
</summary>
<remarks>
Uncompress it with <see cref="M:Ionic.Zlib.GZipStream.UncompressString(System.Byte[])"/>.
</remarks>
<seealso cref="M:Ionic.Zlib.GZipStream.UncompressString(System.Byte[])"/>
<seealso cref="M:Ionic.Zlib.GZipStream.CompressBuffer(System.Byte[])"/>
<param name="s">
A string to compress. The string will first be encoded
using UTF8, then compressed.
</param>
<returns>The string in compressed form</returns>
</member>
<member name="M:Ionic.Zlib.GZipStream.CompressBuffer(System.Byte[])">
<summary>
Compress a byte array into a new byte array using GZip.
</summary>
<remarks>
Uncompress it with <see cref="M:Ionic.Zlib.GZipStream.UncompressBuffer(System.Byte[])"/>.
</remarks>
<seealso cref="M:Ionic.Zlib.GZipStream.CompressString(System.String)"/>
<seealso cref="M:Ionic.Zlib.GZipStream.UncompressBuffer(System.Byte[])"/>
<param name="b">
A buffer to compress.
</param>
<returns>The data in compressed form</returns>
</member>
<member name="M:Ionic.Zlib.GZipStream.UncompressString(System.Byte[])">
<summary>
Uncompress a GZip'ed byte array into a single string.
</summary>
<seealso cref="M:Ionic.Zlib.GZipStream.CompressString(System.String)"/>
<seealso cref="M:Ionic.Zlib.GZipStream.UncompressBuffer(System.Byte[])"/>
<param name="compressed">
A buffer containing GZIP-compressed data.
</param>
<returns>The uncompressed string</returns>
</member>
<member name="M:Ionic.Zlib.GZipStream.UncompressBuffer(System.Byte[])">
<summary>
Uncompress a GZip'ed byte array into a byte array.
</summary>
<seealso cref="M:Ionic.Zlib.GZipStream.CompressBuffer(System.Byte[])"/>
<seealso cref="M:Ionic.Zlib.GZipStream.UncompressString(System.Byte[])"/>
<param name="compressed">
A buffer containing data that has been compressed with GZip.
</param>
<returns>The data in uncompressed form</returns>
</member>
<member name="P:Ionic.Zlib.GZipStream.Comment">
<summary>
The comment on the GZIP stream.
</summary>
<remarks>
<para>
The GZIP format allows for each file to optionally have an associated
comment stored with the file. The comment is encoded with the ISO-8859-1
code page. To include a comment in a GZIP stream you create, set this
property before calling <c>Write()</c> for the first time on the
<c>GZipStream</c>.
</para>
<para>
When using <c>GZipStream</c> to decompress, you can retrieve this property
after the first call to <c>Read()</c>. If no comment has been set in the
GZIP bytestream, the Comment property will return <c>null</c>
(<c>Nothing</c> in VB).
</para>
</remarks>
</member>
<member name="P:Ionic.Zlib.GZipStream.FileName">
<summary>
The FileName for the GZIP stream.
</summary>
<remarks>
<para>
The GZIP format optionally allows each file to have an associated
filename. When compressing data (through <c>Write()</c>), set this
FileName before calling <c>Write()</c> the first time on the <c>GZipStream</c>.
The actual filename is encoded into the GZIP bytestream with the
ISO-8859-1 code page, according to RFC 1952. It is the application's
responsibility to insure that the FileName can be encoded and decoded
correctly with this code page.
</para>
<para>
When decompressing (through <c>Read()</c>), you can retrieve this value
any time after the first <c>Read()</c>. In the case where there was no filename
encoded into the GZIP bytestream, the property will return <c>null</c> (<c>Nothing</c>
in VB).
</para>
</remarks>
</member>
<member name="P:Ionic.Zlib.GZipStream.Crc32">
<summary>
The CRC on the GZIP stream.
</summary>
<remarks>
This is used for internal error checking. You probably don't need to look at this property.
</remarks>
</member>
<member name="P:Ionic.Zlib.GZipStream.FlushMode">
<summary>
This property sets the flush behavior on the stream.
</summary>
</member>
<member name="P:Ionic.Zlib.GZipStream.BufferSize">
<summary>
The size of the working buffer for the compression codec.
</summary>
<remarks>
<para>
The working buffer is used for all stream operations. The default size is
1024 bytes. The minimum size is 128 bytes. You may get better performance
with a larger buffer. Then again, you might not. You would have to test
it.
</para>
<para>
Set this before the first call to <c>Read()</c> or <c>Write()</c> on the
stream. If you try to set it afterwards, it will throw.
</para>
</remarks>
</member>
<member name="P:Ionic.Zlib.GZipStream.TotalIn">
<summary> Returns the total number of bytes input so far.</summary>
</member>
<member name="P:Ionic.Zlib.GZipStream.TotalOut">
<summary> Returns the total number of bytes output so far.</summary>
</member>
<member name="P:Ionic.Zlib.GZipStream.CanRead">
<summary>
Indicates whether the stream can be read.
</summary>
<remarks>
The return value depends on whether the captive stream supports reading.
</remarks>
</member>
<member name="P:Ionic.Zlib.GZipStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.Zlib.GZipStream.CanWrite">
<summary>
Indicates whether the stream can be written.
</summary>
<remarks>
The return value depends on whether the captive stream supports writing.
</remarks>
</member>
<member name="P:Ionic.Zlib.GZipStream.Length">
<summary>
Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
</member>
<member name="P:Ionic.Zlib.GZipStream.Position">
<summary>
The position of the stream pointer.
</summary>
<remarks>
Setting this property always throws a <see cref="T:System.NotImplementedException"/>. Reading will return the total bytes
written out, if used in writing, or the total bytes read in, if used in
reading. The count may refer to compressed bytes or uncompressed bytes,
depending on how you've used the stream.
</remarks>
</member>
<member name="T:Ionic.Zlib.ParallelDeflateOutputStream">
<summary>
A class for compressing streams using the
Deflate algorithm with multiple threads.
</summary>
<remarks>
<para>
This class performs DEFLATE compression through writing. For
more information on the Deflate algorithm, see IETF RFC 1951,
"DEFLATE Compressed Data Format Specification version 1.3."
</para>
<para>
This class is similar to <see cref="T:Ionic.Zlib.DeflateStream"/>, except
that this class is for compression only, and this implementation uses an
approach that employs multiple worker threads to perform the DEFLATE. On
a multi-cpu or multi-core computer, the performance of this class can be
significantly higher than the single-threaded DeflateStream, particularly
for larger streams. How large? Anything over 10mb is a good candidate
for parallel compression.
</para>
<para>
The tradeoff is that this class uses more memory and more CPU than the
vanilla DeflateStream, and also is less efficient as a compressor. For
large files the size of the compressed data stream can be less than 1%
larger than the size of a compressed data stream from the vanialla
DeflateStream. For smaller files the difference can be larger. The
difference will also be larger if you set the BufferSize to be lower than
the default value. Your mileage may vary. Finally, for small files, the
ParallelDeflateOutputStream can be much slower than the vanilla
DeflateStream, because of the overhead associated to using the thread
pool.
</para>
</remarks>
<seealso cref="T:Ionic.Zlib.DeflateStream"/>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.#ctor(System.IO.Stream)">
<summary>
Create a ParallelDeflateOutputStream.
</summary>
<remarks>
<para>
This stream compresses data written into it via the DEFLATE
algorithm (see RFC 1951), and writes out the compressed byte stream.
</para>
<para>
The instance will use the default compression level, the default
buffer sizes and the default number of threads and buffers per
thread.
</para>
<para>
This class is similar to <see cref="T:Ionic.Zlib.DeflateStream"/>,
except that this implementation uses an approach that employs
multiple worker threads to perform the DEFLATE. On a multi-cpu or
multi-core computer, the performance of this class can be
significantly higher than the single-threaded DeflateStream,
particularly for larger streams. How large? Anything over 10mb is
a good candidate for parallel compression.
</para>
</remarks>
<example>
This example shows how to use a ParallelDeflateOutputStream to compress
data. It reads a file, compresses it, and writes the compressed data to
a second, output file.
<code>
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n= -1;
String outputFile = fileToCompress + ".compressed";
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(outputFile))
{
using (Stream compressor = new ParallelDeflateOutputStream(raw))
{
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Dim outputFile As String = (fileToCompress & ".compressed")
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(outputFile)
Using compressor As Stream = New ParallelDeflateOutputStream(raw)
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream to which compressed data will be written.</param>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionLevel)">
<summary>
Create a ParallelDeflateOutputStream using the specified CompressionLevel.
</summary>
<remarks>
See the <see cref="M:Ionic.Zlib.ParallelDeflateOutputStream.#ctor(System.IO.Stream)"/>
constructor for example code.
</remarks>
<param name="stream">The stream to which compressed data will be written.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Create a ParallelDeflateOutputStream and specify whether to leave the captive stream open
when the ParallelDeflateOutputStream is closed.
</summary>
<remarks>
See the <see cref="M:Ionic.Zlib.ParallelDeflateOutputStream.#ctor(System.IO.Stream)"/>
constructor for example code.
</remarks>
<param name="stream">The stream to which compressed data will be written.</param>
<param name="leaveOpen">
true if the application would like the stream to remain open after inflation/deflation.
</param>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionLevel,System.Boolean)">
<summary>
Create a ParallelDeflateOutputStream and specify whether to leave the captive stream open
when the ParallelDeflateOutputStream is closed.
</summary>
<remarks>
See the <see cref="M:Ionic.Zlib.ParallelDeflateOutputStream.#ctor(System.IO.Stream)"/>
constructor for example code.
</remarks>
<param name="stream">The stream to which compressed data will be written.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
<param name="leaveOpen">
true if the application would like the stream to remain open after inflation/deflation.
</param>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionLevel,Ionic.Zlib.CompressionStrategy,System.Boolean)">
<summary>
Create a ParallelDeflateOutputStream using the specified
CompressionLevel and CompressionStrategy, and specifying whether to
leave the captive stream open when the ParallelDeflateOutputStream is
closed.
</summary>
<remarks>
See the <see cref="M:Ionic.Zlib.ParallelDeflateOutputStream.#ctor(System.IO.Stream)"/>
constructor for example code.
</remarks>
<param name="stream">The stream to which compressed data will be written.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
<param name="strategy">
By tweaking this parameter, you may be able to optimize the compression for
data with particular characteristics.
</param>
<param name="leaveOpen">
true if the application would like the stream to remain open after inflation/deflation.
</param>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write data to the stream.
</summary>
<remarks>
<para>
To use the ParallelDeflateOutputStream to compress data, create a
ParallelDeflateOutputStream with CompressionMode.Compress, passing a
writable output stream. Then call Write() on that
ParallelDeflateOutputStream, providing uncompressed data as input. The
data sent to the output stream will be the compressed form of the data
written.
</para>
<para>
To decompress data, use the <see cref="T:Ionic.Zlib.DeflateStream"/> class.
</para>
</remarks>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.Close">
<summary>
Close the stream.
</summary>
<remarks>
You must call Close on the stream to guarantee that all of the data written in has
been compressed, and the compressed data has been written out.
</remarks>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.Dispose">
<summary>Dispose the object</summary>
<remarks>
<para>
Because ParallelDeflateOutputStream is IDisposable, the
application must call this method when finished using the instance.
</para>
<para>
This method is generally called implicitly upon exit from
a <c>using</c> scope in C# (<c>Using</c> in VB).
</para>
</remarks>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.Dispose(System.Boolean)">
<summary>The Dispose method</summary>
<param name="disposing">
indicates whether the Dispose method was invoked by user code.
</param>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.Reset(System.IO.Stream)">
<summary>
Resets the stream for use with another stream.
</summary>
<remarks>
Because the ParallelDeflateOutputStream is expensive to create, it
has been designed so that it can be recycled and re-used. You have
to call Close() on the stream first, then you can call Reset() on
it, to use it again on another stream.
</remarks>
<param name="stream">
The new output stream for this era.
</param>
<example>
<code>
ParallelDeflateOutputStream deflater = null;
foreach (var inputFile in listOfFiles)
{
string outputFile = inputFile + ".compressed";
using (System.IO.Stream input = System.IO.File.OpenRead(inputFile))
{
using (var outStream = System.IO.File.Create(outputFile))
{
if (deflater == null)
deflater = new ParallelDeflateOutputStream(outStream,
CompressionLevel.Best,
CompressionStrategy.Default,
true);
deflater.Reset(outStream);
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
deflater.Write(buffer, 0, n);
}
}
}
}
</code>
</example>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
This method always throws a NotSupportedException.
</summary>
<param name="buffer">
The buffer into which data would be read, IF THIS METHOD
ACTUALLY DID ANYTHING.
</param>
<param name="offset">
The offset within that data array at which to insert the
data that is read, IF THIS METHOD ACTUALLY DID
ANYTHING.
</param>
<param name="count">
The number of bytes to write, IF THIS METHOD ACTUALLY DID
ANYTHING.
</param>
<returns>nothing.</returns>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
This method always throws a NotSupportedException.
</summary>
<param name="offset">
The offset to seek to....
IF THIS METHOD ACTUALLY DID ANYTHING.
</param>
<param name="origin">
The reference specifying how to apply the offset.... IF
THIS METHOD ACTUALLY DID ANYTHING.
</param>
<returns>nothing. It always throws.</returns>
</member>
<member name="M:Ionic.Zlib.ParallelDeflateOutputStream.SetLength(System.Int64)">
<summary>
This method always throws a NotSupportedException.
</summary>
<param name="value">
The new value for the stream length.... IF
THIS METHOD ACTUALLY DID ANYTHING.
</param>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.Strategy">
<summary>
The ZLIB strategy to be used during compression.
</summary>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.MaxBufferPairs">
<summary>
The maximum number of buffer pairs to use.
</summary>
<remarks>
<para>
This property sets an upper limit on the number of memory buffer
pairs to create. The implementation of this stream allocates
multiple buffers to facilitate parallel compression. As each buffer
fills up, this stream uses <see cref="M:System.Threading.ThreadPool.QueueUserWorkItem(System.Threading.WaitCallback)">
ThreadPool.QueueUserWorkItem()</see>
to compress those buffers in a background threadpool thread. After a
buffer is compressed, it is re-ordered and written to the output
stream.
</para>
<para>
A higher number of buffer pairs enables a higher degree of
parallelism, which tends to increase the speed of compression on
multi-cpu computers. On the other hand, a higher number of buffer
pairs also implies a larger memory consumption, more active worker
threads, and a higher cpu utilization for any compression. This
property enables the application to limit its memory consumption and
CPU utilization behavior depending on requirements.
</para>
<para>
For each compression "task" that occurs in parallel, there are 2
buffers allocated: one for input and one for output. This property
sets a limit for the number of pairs. The total amount of storage
space allocated for buffering will then be (N*S*2), where N is the
number of buffer pairs, S is the size of each buffer (<see cref="P:Ionic.Zlib.ParallelDeflateOutputStream.BufferSize"/>). By default, DotNetZip allocates 4 buffer
pairs per CPU core, so if your machine has 4 cores, and you retain
the default buffer size of 128k, then the
ParallelDeflateOutputStream will use 4 * 4 * 2 * 128kb of buffer
memory in total, or 4mb, in blocks of 128kb. If you then set this
property to 8, then the number will be 8 * 2 * 128kb of buffer
memory, or 2mb.
</para>
<para>
CPU utilization will also go up with additional buffers, because a
larger number of buffer pairs allows a larger number of background
threads to compress in parallel. If you find that parallel
compression is consuming too much memory or CPU, you can adjust this
value downward.
</para>
<para>
The default value is 16. Different values may deliver better or
worse results, depending on your priorities and the dynamic
performance characteristics of your storage and compute resources.
</para>
<para>
This property is not the number of buffer pairs to use; it is an
upper limit. An illustration: Suppose you have an application that
uses the default value of this property (which is 16), and it runs
on a machine with 2 CPU cores. In that case, DotNetZip will allocate
4 buffer pairs per CPU core, for a total of 8 pairs. The upper
limit specified by this property has no effect.
</para>
<para>
The application can set this value at any time, but it is effective
only before the first call to Write(), which is when the buffers are
allocated.
</para>
</remarks>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.BufferSize">
<summary>
The size of the buffers used by the compressor threads.
</summary>
<remarks>
<para>
The default buffer size is 128k. The application can set this value
at any time, but it is effective only before the first Write().
</para>
<para>
Larger buffer sizes implies larger memory consumption but allows
more efficient compression. Using smaller buffer sizes consumes less
memory but may result in less effective compression. For example,
using the default buffer size of 128k, the compression delivered is
within 1% of the compression delivered by the single-threaded <see cref="T:Ionic.Zlib.DeflateStream"/>. On the other hand, using a
BufferSize of 8k can result in a compressed data stream that is 5%
larger than that delivered by the single-threaded
<c>DeflateStream</c>. Excessively small buffer sizes can also cause
the speed of the ParallelDeflateOutputStream to drop, because of
larger thread scheduling overhead dealing with many many small
buffers.
</para>
<para>
The total amount of storage space allocated for buffering will be
(N*S*2), where N is the number of buffer pairs, and S is the size of
each buffer (this property). There are 2 buffers used by the
compressor, one for input and one for output. By default, DotNetZip
allocates 4 buffer pairs per CPU core, so if your machine has 4
cores, then the number of buffer pairs used will be 16. If you
accept the default value of this property, 128k, then the
ParallelDeflateOutputStream will use 16 * 2 * 128kb of buffer memory
in total, or 4mb, in blocks of 128kb. If you set this property to
64kb, then the number will be 16 * 2 * 64kb of buffer memory, or
2mb.
</para>
</remarks>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.Crc32">
<summary>
The CRC32 for the data that was written out, prior to compression.
</summary>
<remarks>
This value is meaningful only after a call to Close().
</remarks>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.BytesProcessed">
<summary>
The total number of uncompressed bytes processed by the ParallelDeflateOutputStream.
</summary>
<remarks>
This value is meaningful only after a call to Close().
</remarks>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.CanRead">
<summary>
Indicates whether the stream supports Read operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.CanWrite">
<summary>
Indicates whether the stream supports Write operations.
</summary>
<remarks>
Returns true if the provided stream is writable.
</remarks>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.Length">
<summary>
Reading this property always throws a NotSupportedException.
</summary>
</member>
<member name="P:Ionic.Zlib.ParallelDeflateOutputStream.Position">
<summary>
Returns the current position of the output stream.
</summary>
<remarks>
<para>
Because the output gets written by a background thread,
the value may change asynchronously. Setting this
property always throws a NotSupportedException.
</para>
</remarks>
</member>
<member name="M:Ionic.Zlib.Tree.DistanceCode(System.Int32)">
<summary>
Map from a distance to a distance code.
</summary>
<remarks>
No side effects. _dist_code[256] and _dist_code[257] are never used.
</remarks>
</member>
<member name="T:Ionic.Zlib.FlushType">
<summary>
Describes how to flush the current deflate operation.
</summary>
<remarks>
The different FlushType values are useful when using a Deflate in a streaming application.
</remarks>
</member>
<member name="F:Ionic.Zlib.FlushType.None">
<summary>No flush at all.</summary>
</member>
<member name="F:Ionic.Zlib.FlushType.Partial">
<summary>Closes the current block, but doesn't flush it to
the output. Used internally only in hypothetical
scenarios. This was supposed to be removed by Zlib, but it is
still in use in some edge cases.
</summary>
</member>
<member name="F:Ionic.Zlib.FlushType.Sync">
<summary>
Use this during compression to specify that all pending output should be
flushed to the output buffer and the output should be aligned on a byte
boundary. You might use this in a streaming communication scenario, so that
the decompressor can get all input data available so far. When using this
with a ZlibCodec, <c>AvailableBytesIn</c> will be zero after the call if
enough output space has been provided before the call. Flushing will
degrade compression and so it should be used only when necessary.
</summary>
</member>
<member name="F:Ionic.Zlib.FlushType.Full">
<summary>
Use this during compression to specify that all output should be flushed, as
with <c>FlushType.Sync</c>, but also, the compression state should be reset
so that decompression can restart from this point if previous compressed
data has been damaged or if random access is desired. Using
<c>FlushType.Full</c> too often can significantly degrade the compression.
</summary>
</member>
<member name="F:Ionic.Zlib.FlushType.Finish">
<summary>Signals the end of the compression/decompression stream.</summary>
</member>
<member name="T:Ionic.Zlib.CompressionLevel">
<summary>
The compression level to be used when using a DeflateStream or ZlibStream with CompressionMode.Compress.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.None">
<summary>
None means that the data will be simply stored, with no change at all.
If you are producing ZIPs for use on Mac OSX, be aware that archives produced with CompressionLevel.None
cannot be opened with the default zip reader. Use a different CompressionLevel.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level0">
<summary>
Same as None.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.BestSpeed">
<summary>
The fastest but least effective compression.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level1">
<summary>
A synonym for BestSpeed.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level2">
<summary>
A little slower, but better, than level 1.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level3">
<summary>
A little slower, but better, than level 2.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level4">
<summary>
A little slower, but better, than level 3.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level5">
<summary>
A little slower than level 4, but with better compression.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Default">
<summary>
The default compression level, with a good balance of speed and compression efficiency.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level6">
<summary>
A synonym for Default.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level7">
<summary>
Pretty good compression!
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level8">
<summary>
Better compression than Level7!
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.BestCompression">
<summary>
The "best" compression, where best means greatest reduction in size of the input data stream.
This is also the slowest compression.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionLevel.Level9">
<summary>
A synonym for BestCompression.
</summary>
</member>
<member name="T:Ionic.Zlib.CompressionStrategy">
<summary>
Describes options for how the compression algorithm is executed. Different strategies
work better on different sorts of data. The strategy parameter can affect the compression
ratio and the speed of compression but not the correctness of the compresssion.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionStrategy.Default">
<summary>
The default strategy is probably the best for normal data.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionStrategy.Filtered">
<summary>
The <c>Filtered</c> strategy is intended to be used most effectively with data produced by a
filter or predictor. By this definition, filtered data consists mostly of small
values with a somewhat random distribution. In this case, the compression algorithm
is tuned to compress them better. The effect of <c>Filtered</c> is to force more Huffman
coding and less string matching; it is a half-step between <c>Default</c> and <c>HuffmanOnly</c>.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionStrategy.HuffmanOnly">
<summary>
Using <c>HuffmanOnly</c> will force the compressor to do Huffman encoding only, with no
string matching.
</summary>
</member>
<member name="T:Ionic.Zlib.CompressionMode">
<summary>
An enum to specify the direction of transcoding - whether to compress or decompress.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionMode.Compress">
<summary>
Used to specify that the stream should compress the data.
</summary>
</member>
<member name="F:Ionic.Zlib.CompressionMode.Decompress">
<summary>
Used to specify that the stream should decompress the data.
</summary>
</member>
<member name="T:Ionic.Zlib.ZlibException">
<summary>
A general purpose exception class for exceptions in the Zlib library.
</summary>
</member>
<member name="M:Ionic.Zlib.ZlibException.#ctor">
<summary>
The ZlibException class captures exception information generated
by the Zlib library.
</summary>
</member>
<member name="M:Ionic.Zlib.ZlibException.#ctor(System.String)">
<summary>
This ctor collects a message attached to the exception.
</summary>
<param name="s">the message for the exception.</param>
</member>
<member name="M:Ionic.Zlib.SharedUtils.URShift(System.Int32,System.Int32)">
<summary>
Performs an unsigned bitwise right shift with the specified number
</summary>
<param name="number">Number to operate on</param>
<param name="bits">Ammount of bits to shift</param>
<returns>The resulting number from the shift operation</returns>
</member>
<member name="M:Ionic.Zlib.SharedUtils.ReadInput(System.IO.TextReader,System.Byte[],System.Int32,System.Int32)">
<summary>
Reads a number of characters from the current source TextReader and writes
the data to the target array at the specified index.
</summary>
<param name="sourceTextReader">The source TextReader to read from</param>
<param name="target">Contains the array of characteres read from the source TextReader.</param>
<param name="start">The starting index of the target array.</param>
<param name="count">The maximum number of characters to read from the source TextReader.</param>
<returns>
The number of characters read. The number will be less than or equal to
count depending on the data available in the source TextReader. Returns -1
if the end of the stream is reached.
</returns>
</member>
<member name="T:Ionic.Zlib.Adler">
<summary>
Computes an Adler-32 checksum.
</summary>
<remarks>
The Adler checksum is similar to a CRC checksum, but faster to compute, though less
reliable. It is used in producing RFC1950 compressed streams. The Adler checksum
is a required part of the "ZLIB" standard. Applications will almost never need to
use this class directly.
</remarks>
<exclude/>
</member>
<member name="M:Ionic.Zlib.Adler.Adler32(System.UInt32,System.Byte[],System.Int32,System.Int32)">
<summary>
Calculates the Adler32 checksum.
</summary>
<remarks>
<para>
This is used within ZLIB. You probably don't need to use this directly.
</para>
</remarks>
<example>
To compute an Adler32 checksum on a byte array:
<code>
var adler = Adler.Adler32(0, null, 0, 0);
adler = Adler.Adler32(adler, buffer, index, length);
</code>
</example>
</member>
<member name="T:Ionic.Zlib.ZlibCodec">
<summary>
Encoder and Decoder for ZLIB and DEFLATE (IETF RFC1950 and RFC1951).
</summary>
<remarks>
This class compresses and decompresses data according to the Deflate algorithm
and optionally, the ZLIB format, as documented in <see
href="http://www.ietf.org/rfc/rfc1950.txt">RFC 1950 - ZLIB</see> and <see
href="http://www.ietf.org/rfc/rfc1951.txt">RFC 1951 - DEFLATE</see>.
</remarks>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.InputBuffer">
<summary>
The buffer from which data is taken.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.NextIn">
<summary>
An index into the InputBuffer array, indicating where to start reading.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.AvailableBytesIn">
<summary>
The number of bytes available in the InputBuffer, starting at NextIn.
</summary>
<remarks>
Generally you should set this to InputBuffer.Length before the first Inflate() or Deflate() call.
The class will update this number as calls to Inflate/Deflate are made.
</remarks>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.TotalBytesIn">
<summary>
Total number of bytes read so far, through all calls to Inflate()/Deflate().
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.OutputBuffer">
<summary>
Buffer to store output data.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.NextOut">
<summary>
An index into the OutputBuffer array, indicating where to start writing.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.AvailableBytesOut">
<summary>
The number of bytes available in the OutputBuffer, starting at NextOut.
</summary>
<remarks>
Generally you should set this to OutputBuffer.Length before the first Inflate() or Deflate() call.
The class will update this number as calls to Inflate/Deflate are made.
</remarks>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.TotalBytesOut">
<summary>
Total number of bytes written to the output so far, through all calls to Inflate()/Deflate().
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.Message">
<summary>
used for diagnostics, when something goes wrong!
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.CompressLevel">
<summary>
The compression level to use in this codec. Useful only in compression mode.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.WindowBits">
<summary>
The number of Window Bits to use.
</summary>
<remarks>
This gauges the size of the sliding window, and hence the
compression effectiveness as well as memory consumption. It's best to just leave this
setting alone if you don't know what it is. The maximum value is 15 bits, which implies
a 32k window.
</remarks>
</member>
<member name="F:Ionic.Zlib.ZlibCodec.Strategy">
<summary>
The compression strategy to use.
</summary>
<remarks>
This is only effective in compression. The theory offered by ZLIB is that different
strategies could potentially produce significant differences in compression behavior
for different data sets. Unfortunately I don't have any good recommendations for how
to set it differently. When I tested changing the strategy I got minimally different
compression performance. It's best to leave this property alone if you don't have a
good feel for it. Or, you may want to produce a test harness that runs through the
different strategy options and evaluates them on different file types. If you do that,
let me know your results.
</remarks>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.#ctor">
<summary>
Create a ZlibCodec.
</summary>
<remarks>
If you use this default constructor, you will later have to explicitly call
InitializeInflate() or InitializeDeflate() before using the ZlibCodec to compress
or decompress.
</remarks>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.#ctor(Ionic.Zlib.CompressionMode)">
<summary>
Create a ZlibCodec that either compresses or decompresses.
</summary>
<param name="mode">
Indicates whether the codec should compress (deflate) or decompress (inflate).
</param>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.InitializeInflate">
<summary>
Initialize the inflation state.
</summary>
<remarks>
It is not necessary to call this before using the ZlibCodec to inflate data;
It is implicitly called when you call the constructor.
</remarks>
<returns>Z_OK if everything goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.InitializeInflate(System.Boolean)">
<summary>
Initialize the inflation state with an explicit flag to
govern the handling of RFC1950 header bytes.
</summary>
<remarks>
By default, the ZLIB header defined in <see
href="http://www.ietf.org/rfc/rfc1950.txt">RFC 1950</see> is expected. If
you want to read a zlib stream you should specify true for
expectRfc1950Header. If you have a deflate stream, you will want to specify
false. It is only necessary to invoke this initializer explicitly if you
want to specify false.
</remarks>
<param name="expectRfc1950Header">whether to expect an RFC1950 header byte
pair when reading the stream of data to be inflated.</param>
<returns>Z_OK if everything goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.InitializeInflate(System.Int32)">
<summary>
Initialize the ZlibCodec for inflation, with the specified number of window bits.
</summary>
<param name="windowBits">The number of window bits to use. If you need to ask what that is,
then you shouldn't be calling this initializer.</param>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.InitializeInflate(System.Int32,System.Boolean)">
<summary>
Initialize the inflation state with an explicit flag to govern the handling of
RFC1950 header bytes.
</summary>
<remarks>
If you want to read a zlib stream you should specify true for
expectRfc1950Header. In this case, the library will expect to find a ZLIB
header, as defined in <see href="http://www.ietf.org/rfc/rfc1950.txt">RFC
1950</see>, in the compressed stream. If you will be reading a DEFLATE or
GZIP stream, which does not have such a header, you will want to specify
false.
</remarks>
<param name="expectRfc1950Header">whether to expect an RFC1950 header byte pair when reading
the stream of data to be inflated.</param>
<param name="windowBits">The number of window bits to use. If you need to ask what that is,
then you shouldn't be calling this initializer.</param>
<returns>Z_OK if everything goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.Inflate(Ionic.Zlib.FlushType)">
<summary>
Inflate the data in the InputBuffer, placing the result in the OutputBuffer.
</summary>
<remarks>
You must have set InputBuffer and OutputBuffer, NextIn and NextOut, and AvailableBytesIn and
AvailableBytesOut before calling this method.
</remarks>
<example>
<code>
private void InflateBuffer()
{
int bufferSize = 1024;
byte[] buffer = new byte[bufferSize];
ZlibCodec decompressor = new ZlibCodec();
Console.WriteLine("\n============================================");
Console.WriteLine("Size of Buffer to Inflate: {0} bytes.", CompressedBytes.Length);
MemoryStream ms = new MemoryStream(DecompressedBytes);
int rc = decompressor.InitializeInflate();
decompressor.InputBuffer = CompressedBytes;
decompressor.NextIn = 0;
decompressor.AvailableBytesIn = CompressedBytes.Length;
decompressor.OutputBuffer = buffer;
// pass 1: inflate
do
{
decompressor.NextOut = 0;
decompressor.AvailableBytesOut = buffer.Length;
rc = decompressor.Inflate(FlushType.None);
if (rc != ZlibConstants.Z_OK && rc != ZlibConstants.Z_STREAM_END)
throw new Exception("inflating: " + decompressor.Message);
ms.Write(decompressor.OutputBuffer, 0, buffer.Length - decompressor.AvailableBytesOut);
}
while (decompressor.AvailableBytesIn > 0 || decompressor.AvailableBytesOut == 0);
// pass 2: finish and flush
do
{
decompressor.NextOut = 0;
decompressor.AvailableBytesOut = buffer.Length;
rc = decompressor.Inflate(FlushType.Finish);
if (rc != ZlibConstants.Z_STREAM_END && rc != ZlibConstants.Z_OK)
throw new Exception("inflating: " + decompressor.Message);
if (buffer.Length - decompressor.AvailableBytesOut > 0)
ms.Write(buffer, 0, buffer.Length - decompressor.AvailableBytesOut);
}
while (decompressor.AvailableBytesIn > 0 || decompressor.AvailableBytesOut == 0);
decompressor.EndInflate();
}
</code>
</example>
<param name="flush">The flush to use when inflating.</param>
<returns>Z_OK if everything goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.EndInflate">
<summary>
Ends an inflation session.
</summary>
<remarks>
Call this after successively calling Inflate(). This will cause all buffers to be flushed.
After calling this you cannot call Inflate() without a intervening call to one of the
InitializeInflate() overloads.
</remarks>
<returns>Z_OK if everything goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.SyncInflate">
<summary>
I don't know what this does!
</summary>
<returns>Z_OK if everything goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.InitializeDeflate">
<summary>
Initialize the ZlibCodec for deflation operation.
</summary>
<remarks>
The codec will use the MAX window bits and the default level of compression.
</remarks>
<example>
<code>
int bufferSize = 40000;
byte[] CompressedBytes = new byte[bufferSize];
byte[] DecompressedBytes = new byte[bufferSize];
ZlibCodec compressor = new ZlibCodec();
compressor.InitializeDeflate(CompressionLevel.Default);
compressor.InputBuffer = System.Text.ASCIIEncoding.ASCII.GetBytes(TextToCompress);
compressor.NextIn = 0;
compressor.AvailableBytesIn = compressor.InputBuffer.Length;
compressor.OutputBuffer = CompressedBytes;
compressor.NextOut = 0;
compressor.AvailableBytesOut = CompressedBytes.Length;
while (compressor.TotalBytesIn != TextToCompress.Length && compressor.TotalBytesOut < bufferSize)
{
compressor.Deflate(FlushType.None);
}
while (true)
{
int rc= compressor.Deflate(FlushType.Finish);
if (rc == ZlibConstants.Z_STREAM_END) break;
}
compressor.EndDeflate();
</code>
</example>
<returns>Z_OK if all goes well. You generally don't need to check the return code.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.InitializeDeflate(Ionic.Zlib.CompressionLevel)">
<summary>
Initialize the ZlibCodec for deflation operation, using the specified CompressionLevel.
</summary>
<remarks>
The codec will use the maximum window bits (15) and the specified
CompressionLevel. It will emit a ZLIB stream as it compresses.
</remarks>
<param name="level">The compression level for the codec.</param>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.InitializeDeflate(Ionic.Zlib.CompressionLevel,System.Boolean)">
<summary>
Initialize the ZlibCodec for deflation operation, using the specified CompressionLevel,
and the explicit flag governing whether to emit an RFC1950 header byte pair.
</summary>
<remarks>
The codec will use the maximum window bits (15) and the specified CompressionLevel.
If you want to generate a zlib stream, you should specify true for
wantRfc1950Header. In this case, the library will emit a ZLIB
header, as defined in <see href="http://www.ietf.org/rfc/rfc1950.txt">RFC
1950</see>, in the compressed stream.
</remarks>
<param name="level">The compression level for the codec.</param>
<param name="wantRfc1950Header">whether to emit an initial RFC1950 byte pair in the compressed stream.</param>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.InitializeDeflate(Ionic.Zlib.CompressionLevel,System.Int32)">
<summary>
Initialize the ZlibCodec for deflation operation, using the specified CompressionLevel,
and the specified number of window bits.
</summary>
<remarks>
The codec will use the specified number of window bits and the specified CompressionLevel.
</remarks>
<param name="level">The compression level for the codec.</param>
<param name="bits">the number of window bits to use. If you don't know what this means, don't use this method.</param>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.InitializeDeflate(Ionic.Zlib.CompressionLevel,System.Int32,System.Boolean)">
<summary>
Initialize the ZlibCodec for deflation operation, using the specified
CompressionLevel, the specified number of window bits, and the explicit flag
governing whether to emit an RFC1950 header byte pair.
</summary>
<param name="level">The compression level for the codec.</param>
<param name="wantRfc1950Header">whether to emit an initial RFC1950 byte pair in the compressed stream.</param>
<param name="bits">the number of window bits to use. If you don't know what this means, don't use this method.</param>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.Deflate(Ionic.Zlib.FlushType)">
<summary>
Deflate one batch of data.
</summary>
<remarks>
You must have set InputBuffer and OutputBuffer before calling this method.
</remarks>
<example>
<code>
private void DeflateBuffer(CompressionLevel level)
{
int bufferSize = 1024;
byte[] buffer = new byte[bufferSize];
ZlibCodec compressor = new ZlibCodec();
Console.WriteLine("\n============================================");
Console.WriteLine("Size of Buffer to Deflate: {0} bytes.", UncompressedBytes.Length);
MemoryStream ms = new MemoryStream();
int rc = compressor.InitializeDeflate(level);
compressor.InputBuffer = UncompressedBytes;
compressor.NextIn = 0;
compressor.AvailableBytesIn = UncompressedBytes.Length;
compressor.OutputBuffer = buffer;
// pass 1: deflate
do
{
compressor.NextOut = 0;
compressor.AvailableBytesOut = buffer.Length;
rc = compressor.Deflate(FlushType.None);
if (rc != ZlibConstants.Z_OK && rc != ZlibConstants.Z_STREAM_END)
throw new Exception("deflating: " + compressor.Message);
ms.Write(compressor.OutputBuffer, 0, buffer.Length - compressor.AvailableBytesOut);
}
while (compressor.AvailableBytesIn > 0 || compressor.AvailableBytesOut == 0);
// pass 2: finish and flush
do
{
compressor.NextOut = 0;
compressor.AvailableBytesOut = buffer.Length;
rc = compressor.Deflate(FlushType.Finish);
if (rc != ZlibConstants.Z_STREAM_END && rc != ZlibConstants.Z_OK)
throw new Exception("deflating: " + compressor.Message);
if (buffer.Length - compressor.AvailableBytesOut > 0)
ms.Write(buffer, 0, buffer.Length - compressor.AvailableBytesOut);
}
while (compressor.AvailableBytesIn > 0 || compressor.AvailableBytesOut == 0);
compressor.EndDeflate();
ms.Seek(0, SeekOrigin.Begin);
CompressedBytes = new byte[compressor.TotalBytesOut];
ms.Read(CompressedBytes, 0, CompressedBytes.Length);
}
</code>
</example>
<param name="flush">whether to flush all data as you deflate. Generally you will want to
use Z_NO_FLUSH here, in a series of calls to Deflate(), and then call EndDeflate() to
flush everything.
</param>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.EndDeflate">
<summary>
End a deflation session.
</summary>
<remarks>
Call this after making a series of one or more calls to Deflate(). All buffers are flushed.
</remarks>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.ResetDeflate">
<summary>
Reset a codec for another deflation session.
</summary>
<remarks>
Call this to reset the deflation state. For example if a thread is deflating
non-consecutive blocks, you can call Reset() after the Deflate(Sync) of the first
block and before the next Deflate(None) of the second block.
</remarks>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.SetDeflateParams(Ionic.Zlib.CompressionLevel,Ionic.Zlib.CompressionStrategy)">
<summary>
Set the CompressionStrategy and CompressionLevel for a deflation session.
</summary>
<param name="level">the level of compression to use.</param>
<param name="strategy">the strategy to use for compression.</param>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibCodec.SetDictionary(System.Byte[])">
<summary>
Set the dictionary to be used for either Inflation or Deflation.
</summary>
<param name="dictionary">The dictionary bytes to use.</param>
<returns>Z_OK if all goes well.</returns>
</member>
<member name="P:Ionic.Zlib.ZlibCodec.Adler32">
<summary>
The Adler32 checksum on the data transferred through the codec so far. You probably don't need to look at this.
</summary>
</member>
<member name="T:Ionic.Zlib.ZlibConstants">
<summary>
A bunch of constants used in the Zlib interface.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.WindowBitsMax">
<summary>
The maximum number of window bits for the Deflate algorithm.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.WindowBitsDefault">
<summary>
The default number of window bits for the Deflate algorithm.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.Z_OK">
<summary>
indicates everything is A-OK
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.Z_STREAM_END">
<summary>
Indicates that the last operation reached the end of the stream.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.Z_NEED_DICT">
<summary>
The operation ended in need of a dictionary.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.Z_STREAM_ERROR">
<summary>
There was an error with the stream - not enough data, not open and readable, etc.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.Z_DATA_ERROR">
<summary>
There was an error with the data - not enough data, bad data, etc.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.Z_BUF_ERROR">
<summary>
There was an error with the working buffer.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.WorkingBufferSizeDefault">
<summary>
The size of the working buffer used in the ZlibCodec class. Defaults to 8192 bytes.
</summary>
</member>
<member name="F:Ionic.Zlib.ZlibConstants.WorkingBufferSizeMin">
<summary>
The minimum size of the working buffer used in the ZlibCodec class. Currently it is 128 bytes.
</summary>
</member>
<member name="T:Ionic.Zlib.ZlibStream">
<summary>
Represents a Zlib stream for compression or decompression.
</summary>
<remarks>
<para>
The ZlibStream is a <see href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</see> on a <see cref="T:System.IO.Stream"/>. It adds ZLIB compression or decompression to any
stream.
</para>
<para> Using this stream, applications can compress or decompress data via
stream <c>Read()</c> and <c>Write()</c> operations. Either compresssion or
decompression can occur through either reading or writing. The compression
format used is ZLIB, which is documented in <see href="http://www.ietf.org/rfc/rfc1950.txt">IETF RFC 1950</see>, "ZLIB Compressed
Data Format Specification version 3.3". This implementation of ZLIB always uses
DEFLATE as the compression method. (see <see href="http://www.ietf.org/rfc/rfc1951.txt">IETF RFC 1951</see>, "DEFLATE
Compressed Data Format Specification version 1.3.") </para>
<para>
The ZLIB format allows for varying compression methods, window sizes, and dictionaries.
This implementation always uses the DEFLATE compression method, a preset dictionary,
and 15 window bits by default.
</para>
<para>
This class is similar to <see cref="T:Ionic.Zlib.DeflateStream"/>, except that it adds the
RFC1950 header and trailer bytes to a compressed stream when compressing, or expects
the RFC1950 header and trailer bytes when decompressing. It is also similar to the
<see cref="T:Ionic.Zlib.GZipStream"/>.
</para>
</remarks>
<seealso cref="T:Ionic.Zlib.DeflateStream"/>
<seealso cref="T:Ionic.Zlib.GZipStream"/>
</member>
<member name="M:Ionic.Zlib.ZlibStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode)">
<summary>
Create a <c>ZlibStream</c> using the specified <c>CompressionMode</c>.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Compress</c>, the <c>ZlibStream</c>
will use the default compression level. The "captive" stream will be
closed when the <c>ZlibStream</c> is closed.
</para>
</remarks>
<example>
This example uses a <c>ZlibStream</c> to compress a file, and writes the
compressed data to another file.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(fileToCompress + ".zlib"))
{
using (Stream compressor = new ZlibStream(raw, CompressionMode.Compress))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(fileToCompress & ".zlib")
Using compressor As Stream = New ZlibStream(raw, CompressionMode.Compress)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the ZlibStream will compress or decompress.</param>
</member>
<member name="M:Ionic.Zlib.ZlibStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,Ionic.Zlib.CompressionLevel)">
<summary>
Create a <c>ZlibStream</c> using the specified <c>CompressionMode</c> and
the specified <c>CompressionLevel</c>.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Decompress</c>, the level parameter is ignored.
The "captive" stream will be closed when the <c>ZlibStream</c> is closed.
</para>
</remarks>
<example>
This example uses a <c>ZlibStream</c> to compress data from a file, and writes the
compressed data to another file.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(fileToCompress + ".zlib"))
{
using (Stream compressor = new ZlibStream(raw,
CompressionMode.Compress,
CompressionLevel.BestCompression))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(fileToCompress & ".zlib")
Using compressor As Stream = New ZlibStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream to be read or written while deflating or inflating.</param>
<param name="mode">Indicates whether the ZlibStream will compress or decompress.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
</member>
<member name="M:Ionic.Zlib.ZlibStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,System.Boolean)">
<summary>
Create a <c>ZlibStream</c> using the specified <c>CompressionMode</c>, and
explicitly specify whether the captive stream should be left open after
Deflation or Inflation.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Compress</c>, the <c>ZlibStream</c> will use
the default compression level.
</para>
<para>
This constructor allows the application to request that the captive stream
remain open after the deflation or inflation occurs. By default, after
<c>Close()</c> is called on the stream, the captive stream is also
closed. In some cases this is not desired, for example if the stream is a
<see cref="T:System.IO.MemoryStream"/> that will be re-read after
compression. Specify true for the <paramref name="leaveOpen"/> parameter to leave the stream
open.
</para>
<para>
See the other overloads of this constructor for example code.
</para>
</remarks>
<param name="stream">The stream which will be read or written. This is called the
"captive" stream in other places in this documentation.</param>
<param name="mode">Indicates whether the ZlibStream will compress or decompress.</param>
<param name="leaveOpen">true if the application would like the stream to remain
open after inflation/deflation.</param>
</member>
<member name="M:Ionic.Zlib.ZlibStream.#ctor(System.IO.Stream,Ionic.Zlib.CompressionMode,Ionic.Zlib.CompressionLevel,System.Boolean)">
<summary>
Create a <c>ZlibStream</c> using the specified <c>CompressionMode</c>
and the specified <c>CompressionLevel</c>, and explicitly specify
whether the stream should be left open after Deflation or Inflation.
</summary>
<remarks>
<para>
This constructor allows the application to request that the captive
stream remain open after the deflation or inflation occurs. By
default, after <c>Close()</c> is called on the stream, the captive
stream is also closed. In some cases this is not desired, for example
if the stream is a <see cref="T:System.IO.MemoryStream"/> that will be
re-read after compression. Specify true for the <paramref name="leaveOpen"/> parameter to leave the stream open.
</para>
<para>
When mode is <c>CompressionMode.Decompress</c>, the level parameter is
ignored.
</para>
</remarks>
<example>
This example shows how to use a ZlibStream to compress the data from a file,
and store the result into another file. The filestream remains open to allow
additional data to be written to it.
<code>
using (var output = System.IO.File.Create(fileToCompress + ".zlib"))
{
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (Stream compressor = new ZlibStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, true))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
// can write additional data to the output stream here
}
</code>
<code lang="VB">
Using output As FileStream = File.Create(fileToCompress & ".zlib")
Using input As Stream = File.OpenRead(fileToCompress)
Using compressor As Stream = New ZlibStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, True)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
' can write additional data to the output stream here.
End Using
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the ZlibStream will compress or decompress.</param>
<param name="leaveOpen">
true if the application would like the stream to remain open after
inflation/deflation.
</param>
<param name="level">
A tuning knob to trade speed for effectiveness. This parameter is
effective only when mode is <c>CompressionMode.Compress</c>.
</param>
</member>
<member name="M:Ionic.Zlib.ZlibStream.Dispose(System.Boolean)">
<summary>
Dispose the stream.
</summary>
<remarks>
<para>
This may or may not result in a <c>Close()</c> call on the captive
stream. See the constructors that have a <c>leaveOpen</c> parameter
for more information.
</para>
<para>
This method may be invoked in two distinct scenarios. If disposing
== true, the method has been called directly or indirectly by a
user's code, for example via the public Dispose() method. In this
case, both managed and unmanaged resources can be referenced and
disposed. If disposing == false, the method has been called by the
runtime from inside the object finalizer and this method should not
reference other objects; in that case only unmanaged resources must
be referenced or disposed.
</para>
</remarks>
<param name="disposing">
indicates whether the Dispose method was invoked by user code.
</param>
</member>
<member name="M:Ionic.Zlib.ZlibStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.Zlib.ZlibStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read data from the stream.
</summary>
<remarks>
<para>
If you wish to use the <c>ZlibStream</c> to compress data while reading,
you can create a <c>ZlibStream</c> with <c>CompressionMode.Compress</c>,
providing an uncompressed data stream. Then call <c>Read()</c> on that
<c>ZlibStream</c>, and the data read will be compressed. If you wish to
use the <c>ZlibStream</c> to decompress data while reading, you can create
a <c>ZlibStream</c> with <c>CompressionMode.Decompress</c>, providing a
readable compressed data stream. Then call <c>Read()</c> on that
<c>ZlibStream</c>, and the data will be decompressed as it is read.
</para>
<para>
A <c>ZlibStream</c> can be used for <c>Read()</c> or <c>Write()</c>, but
not both.
</para>
</remarks>
<param name="buffer">
The buffer into which the read data should be placed.</param>
<param name="offset">
the offset within that data array to put the first byte read.</param>
<param name="count">the number of bytes to read.</param>
<returns>the number of bytes read</returns>
</member>
<member name="M:Ionic.Zlib.ZlibStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Calling this method always throws a <see cref="T:System.NotSupportedException"/>.
</summary>
<param name="offset">
The offset to seek to....
IF THIS METHOD ACTUALLY DID ANYTHING.
</param>
<param name="origin">
The reference specifying how to apply the offset.... IF
THIS METHOD ACTUALLY DID ANYTHING.
</param>
<returns>nothing. This method always throws.</returns>
</member>
<member name="M:Ionic.Zlib.ZlibStream.SetLength(System.Int64)">
<summary>
Calling this method always throws a <see cref="T:System.NotSupportedException"/>.
</summary>
<param name="value">
The new value for the stream length.... IF
THIS METHOD ACTUALLY DID ANYTHING.
</param>
</member>
<member name="M:Ionic.Zlib.ZlibStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write data to the stream.
</summary>
<remarks>
<para>
If you wish to use the <c>ZlibStream</c> to compress data while writing,
you can create a <c>ZlibStream</c> with <c>CompressionMode.Compress</c>,
and a writable output stream. Then call <c>Write()</c> on that
<c>ZlibStream</c>, providing uncompressed data as input. The data sent to
the output stream will be the compressed form of the data written. If you
wish to use the <c>ZlibStream</c> to decompress data while writing, you
can create a <c>ZlibStream</c> with <c>CompressionMode.Decompress</c>, and a
writable output stream. Then call <c>Write()</c> on that stream,
providing previously compressed data. The data sent to the output stream
will be the decompressed form of the data written.
</para>
<para>
A <c>ZlibStream</c> can be used for <c>Read()</c> or <c>Write()</c>, but not both.
</para>
</remarks>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="M:Ionic.Zlib.ZlibStream.CompressString(System.String)">
<summary>
Compress a string into a byte array using ZLIB.
</summary>
<remarks>
Uncompress it with <see cref="M:Ionic.Zlib.ZlibStream.UncompressString(System.Byte[])"/>.
</remarks>
<seealso cref="M:Ionic.Zlib.ZlibStream.UncompressString(System.Byte[])"/>
<seealso cref="M:Ionic.Zlib.ZlibStream.CompressBuffer(System.Byte[])"/>
<seealso cref="M:Ionic.Zlib.GZipStream.CompressString(System.String)"/>
<param name="s">
A string to compress. The string will first be encoded
using UTF8, then compressed.
</param>
<returns>The string in compressed form</returns>
</member>
<member name="M:Ionic.Zlib.ZlibStream.CompressBuffer(System.Byte[])">
<summary>
Compress a byte array into a new byte array using ZLIB.
</summary>
<remarks>
Uncompress it with <see cref="M:Ionic.Zlib.ZlibStream.UncompressBuffer(System.Byte[])"/>.
</remarks>
<seealso cref="M:Ionic.Zlib.ZlibStream.CompressString(System.String)"/>
<seealso cref="M:Ionic.Zlib.ZlibStream.UncompressBuffer(System.Byte[])"/>
<param name="b">
A buffer to compress.
</param>
<returns>The data in compressed form</returns>
</member>
<member name="M:Ionic.Zlib.ZlibStream.UncompressString(System.Byte[])">
<summary>
Uncompress a ZLIB-compressed byte array into a single string.
</summary>
<seealso cref="M:Ionic.Zlib.ZlibStream.CompressString(System.String)"/>
<seealso cref="M:Ionic.Zlib.ZlibStream.UncompressBuffer(System.Byte[])"/>
<param name="compressed">
A buffer containing ZLIB-compressed data.
</param>
<returns>The uncompressed string</returns>
</member>
<member name="M:Ionic.Zlib.ZlibStream.UncompressBuffer(System.Byte[])">
<summary>
Uncompress a ZLIB-compressed byte array into a byte array.
</summary>
<seealso cref="M:Ionic.Zlib.ZlibStream.CompressBuffer(System.Byte[])"/>
<seealso cref="M:Ionic.Zlib.ZlibStream.UncompressString(System.Byte[])"/>
<param name="compressed">
A buffer containing ZLIB-compressed data.
</param>
<returns>The data in uncompressed form</returns>
</member>
<member name="P:Ionic.Zlib.ZlibStream.FlushMode">
<summary>
This property sets the flush behavior on the stream.
Sorry, though, not sure exactly how to describe all the various settings.
</summary>
</member>
<member name="P:Ionic.Zlib.ZlibStream.BufferSize">
<summary>
The size of the working buffer for the compression codec.
</summary>
<remarks>
<para>
The working buffer is used for all stream operations. The default size is
1024 bytes. The minimum size is 128 bytes. You may get better performance
with a larger buffer. Then again, you might not. You would have to test
it.
</para>
<para>
Set this before the first call to <c>Read()</c> or <c>Write()</c> on the
stream. If you try to set it afterwards, it will throw.
</para>
</remarks>
</member>
<member name="P:Ionic.Zlib.ZlibStream.TotalIn">
<summary> Returns the total number of bytes input so far.</summary>
</member>
<member name="P:Ionic.Zlib.ZlibStream.TotalOut">
<summary> Returns the total number of bytes output so far.</summary>
</member>
<member name="P:Ionic.Zlib.ZlibStream.CanRead">
<summary>
Indicates whether the stream can be read.
</summary>
<remarks>
The return value depends on whether the captive stream supports reading.
</remarks>
</member>
<member name="P:Ionic.Zlib.ZlibStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Ionic.Zlib.ZlibStream.CanWrite">
<summary>
Indicates whether the stream can be written.
</summary>
<remarks>
The return value depends on whether the captive stream supports writing.
</remarks>
</member>
<member name="P:Ionic.Zlib.ZlibStream.Length">
<summary>
Reading this property always throws a <see cref="T:System.NotSupportedException"/>.
</summary>
</member>
<member name="P:Ionic.Zlib.ZlibStream.Position">
<summary>
The position of the stream pointer.
</summary>
<remarks>
Setting this property always throws a <see cref="T:System.NotSupportedException"/>. Reading will return the total bytes
written out, if used in writing, or the total bytes read in, if used in
reading. The count may refer to compressed bytes or uncompressed bytes,
depending on how you've used the stream.
</remarks>
</member>
<member name="T:Ionic.Crc.CRC32">
<summary>
Computes a CRC-32. The CRC-32 algorithm is parameterized - you
can set the polynomial and enable or disable bit
reversal. This can be used for GZIP, BZip2, or ZIP.
</summary>
<remarks>
This type is used internally by DotNetZip; it is generally not used
directly by applications wishing to create, read, or manipulate zip
archive files.
</remarks>
</member>
<member name="M:Ionic.Crc.CRC32.GetCrc32(System.IO.Stream)">
<summary>
Returns the CRC32 for the specified stream.
</summary>
<param name="input">The stream over which to calculate the CRC32</param>
<returns>the CRC32 calculation</returns>
</member>
<member name="M:Ionic.Crc.CRC32.GetCrc32AndCopy(System.IO.Stream,System.IO.Stream)">
<summary>
Returns the CRC32 for the specified stream, and writes the input into the
output stream.
</summary>
<param name="input">The stream over which to calculate the CRC32</param>
<param name="output">The stream into which to deflate the input</param>
<returns>the CRC32 calculation</returns>
</member>
<member name="M:Ionic.Crc.CRC32.ComputeCrc32(System.Int32,System.Byte)">
<summary>
Get the CRC32 for the given (word,byte) combo. This is a
computation defined by PKzip for PKZIP 2.0 (weak) encryption.
</summary>
<param name="W">The word to start with.</param>
<param name="B">The byte to combine it with.</param>
<returns>The CRC-ized result.</returns>
</member>
<member name="M:Ionic.Crc.CRC32.SlurpBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Update the value for the running CRC32 using the given block of bytes.
This is useful when using the CRC32() class in a Stream.
</summary>
<param name="block">block of bytes to slurp</param>
<param name="offset">starting point in the block</param>
<param name="count">how many bytes within the block to slurp</param>
</member>
<member name="M:Ionic.Crc.CRC32.UpdateCRC(System.Byte)">
<summary>
Process one byte in the CRC.
</summary>
<param name = "b">the byte to include into the CRC . </param>
</member>
<member name="M:Ionic.Crc.CRC32.UpdateCRC(System.Byte,System.Int32)">
<summary>
Process a run of N identical bytes into the CRC.
</summary>
<remarks>
<para>
This method serves as an optimization for updating the CRC when a
run of identical bytes is found. Rather than passing in a buffer of
length n, containing all identical bytes b, this method accepts the
byte value and the length of the (virtual) buffer - the length of
the run.
</para>
</remarks>
<param name = "b">the byte to include into the CRC. </param>
<param name = "n">the number of times that byte should be repeated. </param>
</member>
<member name="M:Ionic.Crc.CRC32.Combine(System.Int32,System.Int32)">
<summary>
Combines the given CRC32 value with the current running total.
</summary>
<remarks>
This is useful when using a divide-and-conquer approach to
calculating a CRC. Multiple threads can each calculate a
CRC32 on a segment of the data, and then combine the
individual CRC32 values at the end.
</remarks>
<param name="crc">the crc value to be combined with this one</param>
<param name="length">the length of data the CRC value was calculated on</param>
</member>
<member name="M:Ionic.Crc.CRC32.#ctor">
<summary>
Create an instance of the CRC32 class using the default settings: no
bit reversal, and a polynomial of 0xEDB88320.
</summary>
</member>
<member name="M:Ionic.Crc.CRC32.#ctor(System.Boolean)">
<summary>
Create an instance of the CRC32 class, specifying whether to reverse
data bits or not.
</summary>
<param name='reverseBits'>
specify true if the instance should reverse data bits.
</param>
<remarks>
<para>
In the CRC-32 used by BZip2, the bits are reversed. Therefore if you
want a CRC32 with compatibility with BZip2, you should pass true
here. In the CRC-32 used by GZIP and PKZIP, the bits are not
reversed; Therefore if you want a CRC32 with compatibility with
those, you should pass false.
</para>
</remarks>
</member>
<member name="M:Ionic.Crc.CRC32.#ctor(System.Int32,System.Boolean)">
<summary>
Create an instance of the CRC32 class, specifying the polynomial and
whether to reverse data bits or not.
</summary>
<param name='polynomial'>
The polynomial to use for the CRC, expressed in the reversed (LSB)
format: the highest ordered bit in the polynomial value is the
coefficient of the 0th power; the second-highest order bit is the
coefficient of the 1 power, and so on. Expressed this way, the
polynomial for the CRC-32C used in IEEE 802.3, is 0xEDB88320.
</param>
<param name='reverseBits'>
specify true if the instance should reverse data bits.
</param>
<remarks>
<para>
In the CRC-32 used by BZip2, the bits are reversed. Therefore if you
want a CRC32 with compatibility with BZip2, you should pass true
here for the <c>reverseBits</c> parameter. In the CRC-32 used by
GZIP and PKZIP, the bits are not reversed; Therefore if you want a
CRC32 with compatibility with those, you should pass false for the
<c>reverseBits</c> parameter.
</para>
</remarks>
</member>
<member name="M:Ionic.Crc.CRC32.Reset">
<summary>
Reset the CRC-32 class - clear the CRC "remainder register."
</summary>
<remarks>
<para>
Use this when employing a single instance of this class to compute
multiple, distinct CRCs on multiple, distinct data blocks.
</para>
</remarks>
</member>
<member name="P:Ionic.Crc.CRC32.TotalBytesRead">
<summary>
Indicates the total number of bytes applied to the CRC.
</summary>
</member>
<member name="P:Ionic.Crc.CRC32.Crc32Result">
<summary>
Indicates the current CRC for all blocks slurped in.
</summary>
</member>
<member name="T:Ionic.Crc.CrcCalculatorStream">
<summary>
A Stream that calculates a CRC32 (a checksum) on all bytes read,
or on all bytes written.
</summary>
<remarks>
<para>
This class can be used to verify the CRC of a ZipEntry when
reading from a stream, or to calculate a CRC when writing to a
stream. The stream should be used to either read, or write, but
not both. If you intermix reads and writes, the results are not
defined.
</para>
<para>
This class is intended primarily for use internally by the
DotNetZip library.
</para>
</remarks>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream)">
<summary>
The default constructor.
</summary>
<remarks>
<para>
Instances returned from this constructor will leave the underlying
stream open upon Close(). The stream uses the default CRC32
algorithm, which implies a polynomial of 0xEDB88320.
</para>
</remarks>
<param name="stream">The underlying stream</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Boolean)">
<summary>
The constructor allows the caller to specify how to handle the
underlying stream at close.
</summary>
<remarks>
<para>
The stream uses the default CRC32 algorithm, which implies a
polynomial of 0xEDB88320.
</para>
</remarks>
<param name="stream">The underlying stream</param>
<param name="leaveOpen">true to leave the underlying stream
open upon close of the <c>CrcCalculatorStream</c>; false otherwise.</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64)">
<summary>
A constructor allowing the specification of the length of the stream
to read.
</summary>
<remarks>
<para>
The stream uses the default CRC32 algorithm, which implies a
polynomial of 0xEDB88320.
</para>
<para>
Instances returned from this constructor will leave the underlying
stream open upon Close().
</para>
</remarks>
<param name="stream">The underlying stream</param>
<param name="length">The length of the stream to slurp</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64,System.Boolean)">
<summary>
A constructor allowing the specification of the length of the stream
to read, as well as whether to keep the underlying stream open upon
Close().
</summary>
<remarks>
<para>
The stream uses the default CRC32 algorithm, which implies a
polynomial of 0xEDB88320.
</para>
</remarks>
<param name="stream">The underlying stream</param>
<param name="length">The length of the stream to slurp</param>
<param name="leaveOpen">true to leave the underlying stream
open upon close of the <c>CrcCalculatorStream</c>; false otherwise.</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64,System.Boolean,Ionic.Crc.CRC32)">
<summary>
A constructor allowing the specification of the length of the stream
to read, as well as whether to keep the underlying stream open upon
Close(), and the CRC32 instance to use.
</summary>
<remarks>
<para>
The stream uses the specified CRC32 instance, which allows the
application to specify how the CRC gets calculated.
</para>
</remarks>
<param name="stream">The underlying stream</param>
<param name="length">The length of the stream to slurp</param>
<param name="leaveOpen">true to leave the underlying stream
open upon close of the <c>CrcCalculatorStream</c>; false otherwise.</param>
<param name="crc32">the CRC32 instance to use to calculate the CRC32</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read from the stream
</summary>
<param name="buffer">the buffer to read</param>
<param name="offset">the offset at which to start</param>
<param name="count">the number of bytes to read</param>
<returns>the number of bytes actually read</returns>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write to the stream.
</summary>
<param name="buffer">the buffer from which to write</param>
<param name="offset">the offset at which to start writing</param>
<param name="count">the number of bytes to write</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Seeking is not supported on this stream. This method always throws
<see cref="T:System.NotSupportedException"/>
</summary>
<param name="offset">N/A</param>
<param name="origin">N/A</param>
<returns>N/A</returns>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.SetLength(System.Int64)">
<summary>
This method always throws
<see cref="T:System.NotSupportedException"/>
</summary>
<param name="value">N/A</param>
</member>
<member name="M:Ionic.Crc.CrcCalculatorStream.Close">
<summary>
Closes the stream.
</summary>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.TotalBytesSlurped">
<summary>
Gets the total number of bytes run through the CRC32 calculator.
</summary>
<remarks>
This is either the total number of bytes read, or the total number of
bytes written, depending on the direction of this stream.
</remarks>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.Crc">
<summary>
Provides the current CRC for all blocks slurped in.
</summary>
<remarks>
<para>
The running total of the CRC is kept as data is written or read
through the stream. read this property after all reads or writes to
get an accurate CRC for the entire stream.
</para>
</remarks>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.LeaveOpen">
<summary>
Indicates whether the underlying stream will be left open when the
<c>CrcCalculatorStream</c> is Closed.
</summary>
<remarks>
<para>
Set this at any point before calling <see cref="M:Ionic.Crc.CrcCalculatorStream.Close"/>.
</para>
</remarks>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.CanRead">
<summary>
Indicates whether the stream supports reading.
</summary>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.CanSeek">
<summary>
Indicates whether the stream supports seeking.
</summary>
<remarks>
<para>
Always returns false.
</para>
</remarks>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.CanWrite">
<summary>
Indicates whether the stream supports writing.
</summary>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.Length">
<summary>
Returns the length of the underlying stream.
</summary>
</member>
<member name="P:Ionic.Crc.CrcCalculatorStream.Position">
<summary>
The getter for this property returns the total bytes read.
If you use the setter, it will throw
<see cref="T:System.NotSupportedException"/>.
</summary>
</member>
</members>
</doc>
<?xml version="1.0"?>
<doc>
<assembly>
<name>log4net</name>
</assembly>
<members>
<member name="T:log4net.Appender.AdoNetAppender">
<summary>
Appender that logs to a database.
</summary>
<remarks>
<para>
<see cref="T:log4net.Appender.AdoNetAppender"/> appends logging events to a table within a
database. The appender can be configured to specify the connection
string by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionString"/> property.
The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/>
property. For more information on database connection strings for
your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>.
</para>
<para>
Records are written into the database either using a prepared
statement or a stored procedure. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property
is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement
or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored
procedure.
</para>
<para>
The prepared statement text or the name of the stored procedure
must be set in the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property.
</para>
<para>
The prepared statement or stored procedure can take a number
of parameters. Parameters are added using the <see cref="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"/>
method. This adds a single <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> to the
ordered list of parameters. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/>
type may be subclassed if required to provide database specific
functionality. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> specifies
the parameter name, database type, size, and how the value should
be generated using a <see cref="T:log4net.Layout.ILayout"/>.
</para>
</remarks>
<example>
An example of a SQL Server table that could be logged to:
<code lang="SQL">
CREATE TABLE [dbo].[Log] (
[ID] [int] IDENTITY (1, 1) NOT NULL ,
[Date] [datetime] NOT NULL ,
[Thread] [varchar] (255) NOT NULL ,
[Level] [varchar] (20) NOT NULL ,
[Logger] [varchar] (255) NOT NULL ,
[Message] [varchar] (4000) NOT NULL
) ON [PRIMARY]
</code>
</example>
<example>
An example configuration to log to the above table:
<code lang="XML" escaped="true">
<appender name="AdoNetAppender_SqlServer" type="log4net.Appender.AdoNetAppender">
<connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
<connectionString value="data source=SQLSVR;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sa"/>
<commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)"/>
<parameter>
<parameterName value="@log_date"/>
<dbType value="DateTime"/>
<layout type="log4net.Layout.PatternLayout" value="%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}"/>
</parameter>
<parameter>
<parameterName value="@thread"/>
<dbType value="String"/>
<size value="255"/>
<layout type="log4net.Layout.PatternLayout" value="%thread"/>
</parameter>
<parameter>
<parameterName value="@log_level"/>
<dbType value="String"/>
<size value="50"/>
<layout type="log4net.Layout.PatternLayout" value="%level"/>
</parameter>
<parameter>
<parameterName value="@logger"/>
<dbType value="String"/>
<size value="255"/>
<layout type="log4net.Layout.PatternLayout" value="%logger"/>
</parameter>
<parameter>
<parameterName value="@message"/>
<dbType value="String"/>
<size value="4000"/>
<layout type="log4net.Layout.PatternLayout" value="%message"/>
</parameter>
</appender>
</code>
</example>
<author>Julian Biddle</author>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Lance Nehring</author>
</member>
<member name="T:log4net.Appender.BufferingAppenderSkeleton">
<summary>
Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
buffers events in a fixed size buffer.
</summary>
<remarks>
<para>
This base class should be used by appenders that need to buffer a
number of events before logging them. For example the <see cref="T:log4net.Appender.AdoNetAppender"/>
buffers events and then submits the entire contents of the buffer to
the underlying database in one go.
</para>
<para>
Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/>
method to deliver the buffered events.
</para>
<para>The BufferingAppenderSkeleton maintains a fixed size cyclic
buffer of events. The size of the buffer is set using
the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
</para>
<para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect
each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
triggers, then the current buffer is sent immediately
(see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event
is stored in the buffer. For example, an evaluator can be used to
deliver the events immediately when an ERROR event arrives.
</para>
<para>
The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
By default the appender is NOT lossy. When the buffer is full all
the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>.
If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
buffer will not be sent when it is full, and new events arriving
in the appender will overwrite the oldest event in the buffer.
In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
triggers. This can be useful behavior when you need to know about
ERROR events but not about events with a lower level, configure an
evaluator that will trigger when an ERROR event arrives, the whole
buffer will be sent which gives a history of events leading up to
the ERROR event.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Appender.AppenderSkeleton">
<summary>
Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
</summary>
<remarks>
<para>
This class provides the code for common functionality, such
as support for threshold filtering and support for general filters.
</para>
<para>
Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
be called after the appenders properties have been configured.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Appender.IAppender">
<summary>
Implement this interface for your own strategies for printing log statements.
</summary>
<remarks>
<para>
Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
class which provides a default implementation of this interface.
</para>
<para>
Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
be called after the appenders properties have been configured.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Appender.IAppender.Close">
<summary>
Closes the appender and releases resources.
</summary>
<remarks>
<para>
Releases any resources allocated within the appender such as file handles,
network connections, etc.
</para>
<para>
It is a programming error to append to a closed appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)">
<summary>
Log the logging event in Appender specific way.
</summary>
<param name="loggingEvent">The event to log</param>
<remarks>
<para>
This method is called to log a message into this appender.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.IAppender.Name">
<summary>
Gets or sets the name of this appender.
</summary>
<value>The name of the appender.</value>
<remarks>
<para>The name uniquely identifies the appender.</para>
</remarks>
</member>
<member name="T:log4net.Appender.IBulkAppender">
<summary>
Interface for appenders that support bulk logging.
</summary>
<remarks>
<para>
This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to
support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders
should only implement this interface if they can bulk log efficiently.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])">
<summary>
Log the array of logging events in Appender specific way.
</summary>
<param name="loggingEvents">The events to log</param>
<remarks>
<para>
This method is called to log an array of events into this appender.
</para>
</remarks>
</member>
<member name="T:log4net.Core.IOptionHandler">
<summary>
Interface used to delay activate a configured object.
</summary>
<remarks>
<para>
This allows an object to defer activation of its options until all
options have been set. This is required for components which have
related options that remain ambiguous until all are set.
</para>
<para>
If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
must be called by the container after its all the configured properties have been set
and before the component can be used.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Core.IOptionHandler.ActivateOptions">
<summary>
Activate the options that were previously set with calls to properties.
</summary>
<remarks>
<para>
This allows an object to defer activation of its options until all
options have been set. This is required for components which have
related options that remain ambiguous until all are set.
</para>
<para>
If a component implements this interface then this method must be called
after its properties have been set before the component can be used.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
<summary>
Initial buffer size
</summary>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
<summary>
Maximum buffer size before it is recycled
</summary>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>Empty default constructor</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.Finalize">
<summary>
Finalizes this appender by calling the implementation's
<see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
</summary>
<remarks>
<para>
If this appender has not been closed then the <c>Finalize</c> method
will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
<summary>
Initialize the appender based on the options set
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.Close">
<summary>
Closes the appender and release resources.
</summary>
<remarks>
<para>
Release any resources allocated within the appender such as file handles,
network connections, etc.
</para>
<para>
It is a programming error to append to a closed appender.
</para>
<para>
This method cannot be overridden by subclasses. This method
delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
method which must be overridden in the subclass.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
<summary>
Performs threshold checks and invokes filters before
delegating actual logging to the subclasses specific
<see cref="M:Append(LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
This method cannot be overridden by derived classes. A
derived class should override the <see cref="M:Append(LoggingEvent)"/> method
which is called by this method.
</para>
<para>
The implementation of this method is as follows:
</para>
<para>
<list type="bullet">
<item>
<description>
Checks that the severity of the <paramref name="loggingEvent"/>
is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
appender.</description>
</item>
<item>
<description>
Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
<paramref name="loggingEvent"/>.
</description>
</item>
<item>
<description>
Calls <see cref="M:PreAppendCheck()"/> and checks that
it returns <c>true</c>.</description>
</item>
</list>
</para>
<para>
If all of the above steps succeed then the <paramref name="loggingEvent"/>
will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
<summary>
Performs threshold checks and invokes filters before
delegating actual logging to the subclasses specific
<see cref="M:Append(LoggingEvent[])"/> method.
</summary>
<param name="loggingEvents">The array of events to log.</param>
<remarks>
<para>
This method cannot be overridden by derived classes. A
derived class should override the <see cref="M:Append(LoggingEvent[])"/> method
which is called by this method.
</para>
<para>
The implementation of this method is as follows:
</para>
<para>
<list type="bullet">
<item>
<description>
Checks that the severity of the <paramref name="loggingEvents"/>
is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
appender.</description>
</item>
<item>
<description>
Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
<paramref name="loggingEvents"/>.
</description>
</item>
<item>
<description>
Calls <see cref="M:PreAppendCheck()"/> and checks that
it returns <c>true</c>.</description>
</item>
</list>
</para>
<para>
If all of the above steps succeed then the <paramref name="loggingEvents"/>
will be passed to the <see cref="M:Append(LoggingEvent[])"/> method.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
<summary>
Test if the logging event should we output by this appender
</summary>
<param name="loggingEvent">the event to test</param>
<returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
<remarks>
<para>
This method checks the logging event against the threshold level set
on this appender and also against the filters specified on this
appender.
</para>
<para>
The implementation of this method is as follows:
</para>
<para>
<list type="bullet">
<item>
<description>
Checks that the severity of the <paramref name="loggingEvent"/>
is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
appender.</description>
</item>
<item>
<description>
Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
<paramref name="loggingEvent"/>.
</description>
</item>
</list>
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
<summary>
Adds a filter to the end of the filter chain.
</summary>
<param name="filter">the filter to add to this appender</param>
<remarks>
<para>
The Filters are organized in a linked list.
</para>
<para>
Setting this property causes the new filter to be pushed onto the
back of the filter chain.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
<summary>
Clears the filter list for this appender.
</summary>
<remarks>
<para>
Clears the filter list for this appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
<summary>
Checks if the message level is below this appender's threshold.
</summary>
<param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
<remarks>
<para>
If there is no threshold set, then the return value is always <c>true</c>.
</para>
</remarks>
<returns>
<c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
requirements of this appender.
</returns>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.OnClose">
<summary>
Is called when the appender is closed. Derived classes should override
this method if resources need to be released.
</summary>
<remarks>
<para>
Releases any resources allocated within the appender such as file handles,
network connections, etc.
</para>
<para>
It is a programming error to append to a closed appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
<summary>
Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
to perform actual logging.
</summary>
<param name="loggingEvent">The event to append.</param>
<remarks>
<para>
A subclass must implement this method to perform
logging of the <paramref name="loggingEvent"/>.
</para>
<para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/>
if all the conditions listed for that method are met.
</para>
<para>
To restrict the logging of events in the appender
override the <see cref="M:PreAppendCheck()"/> method.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
<summary>
Append a bulk array of logging events.
</summary>
<param name="loggingEvents">the array of logging events</param>
<remarks>
<para>
This base class implementation calls the <see cref="M:Append(LoggingEvent)"/>
method for each element in the bulk array.
</para>
<para>
A sub class that can better process a bulk array of events should
override this method in addition to <see cref="M:Append(LoggingEvent)"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
<summary>
Called before <see cref="M:Append(LoggingEvent)"/> as a precondition.
</summary>
<remarks>
<para>
This method is called by <see cref="M:DoAppend(LoggingEvent)"/>
before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method.
</para>
<para>
This method can be overridden in a subclass to extend the checks
made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method.
</para>
<para>
A subclass should ensure that they delegate this call to
this base class if it is overridden.
</para>
</remarks>
<returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
<summary>
Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
</summary>
<param name="loggingEvent">The event to render.</param>
<returns>The event rendered as a string.</returns>
<remarks>
<para>
Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
set to render the <paramref name="loggingEvent"/> to
a string.
</para>
<para>If there is exception data in the logging event and
the layout does not process the exception, this method
will append the exception text to the rendered string.
</para>
<para>
Where possible use the alternative version of this method
<see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>.
That method streams the rendering onto an existing Writer
which can give better performance if the caller already has
a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
</summary>
<param name="loggingEvent">The event to render.</param>
<param name="writer">The TextWriter to write the formatted event to</param>
<remarks>
<para>
Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
set to render the <paramref name="loggingEvent"/> to
a string.
</para>
<para>If there is exception data in the logging event and
the layout does not process the exception, this method
will append the exception text to the rendered string.
</para>
<para>
Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/>
where possible. If, however, the caller needs to render the event
to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does
provide an efficient mechanism for doing so.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_layout">
<summary>
The layout of this appender.
</summary>
<remarks>
See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_name">
<summary>
The name of this appender.
</summary>
<remarks>
See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
<summary>
The level threshold of this appender.
</summary>
<remarks>
<para>
There is no level threshold filtering by default.
</para>
<para>
See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
<summary>
It is assumed and enforced that errorHandler is never null.
</summary>
<remarks>
<para>
It is assumed and enforced that errorHandler is never null.
</para>
<para>
See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
<summary>
The first filter in the filter chain.
</summary>
<remarks>
<para>
Set to <c>null</c> initially.
</para>
<para>
See <see cref="T:log4net.Filter.IFilter"/> for more information.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
<summary>
The last filter in the filter chain.
</summary>
<remarks>
See <see cref="T:log4net.Filter.IFilter"/> for more information.
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_closed">
<summary>
Flag indicating if this appender is closed.
</summary>
<remarks>
See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
</remarks>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
<summary>
The guard prevents an appender from repeatedly calling its own DoAppend method
</summary>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
<summary>
StringWriter used to render events
</summary>
</member>
<member name="F:log4net.Appender.AppenderSkeleton.declaringType">
<summary>
The fully qualified type of the AppenderSkeleton class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.Threshold">
<summary>
Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
</summary>
<value>
The threshold <see cref="T:log4net.Core.Level"/> of the appender.
</value>
<remarks>
<para>
All log events with lower level than the threshold level are ignored
by the appender.
</para>
<para>
In configuration files this option is specified by setting the
value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
string, such as "DEBUG", "INFO" and so on.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
<summary>
Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
</summary>
<value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
<remarks>
<para>
The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
<summary>
The filter chain.
</summary>
<value>The head of the filter chain filter chain.</value>
<remarks>
<para>
Returns the head Filter. The Filters are organized in a linked list
and so all Filters on this Appender are available through the result.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.Layout">
<summary>
Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
</summary>
<value>The layout of the appender.</value>
<remarks>
<para>
See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
</para>
</remarks>
<seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.Name">
<summary>
Gets or sets the name of this appender.
</summary>
<value>The name of the appender.</value>
<remarks>
<para>
The name uniquely identifies the appender.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
<summary>
Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
</summary>
<remarks>
<para>
In the rather exceptional case, where the appender
implementation admits a layout but can also work without it,
then the appender should return <c>true</c>.
</para>
<para>
This default implementation always returns <c>false</c>.
</para>
</remarks>
<returns>
<c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
</returns>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
<summary>
The default buffer size.
</summary>
<remarks>
The default size of the cyclic buffer used to store events.
This is set to 512 by default.
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
</summary>
<remarks>
<para>
Protected default constructor to allow subclassing.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
</summary>
<param name="eventMustBeFixed">the events passed through this appender must be
fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
<remarks>
<para>
Protected constructor to allow subclassing.
</para>
<para>
The <paramref name="eventMustBeFixed"/> should be set if the subclass
expects the events delivered to be fixed even if the
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
<summary>
Flush the currently buffered events
</summary>
<remarks>
<para>
Flushes any events that have been buffered.
</para>
<para>
If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
of the buffer will NOT be flushed to the appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
<summary>
Flush the currently buffered events
</summary>
<param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
<remarks>
<para>
Flushes events that have been buffered. If <paramref name="flushLossyBuffer"/> is
<c>false</c> then events will only be flushed if this buffer is non-lossy mode.
</para>
<para>
If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
of the buffer will only be flushed if <paramref name="flushLossyBuffer"/> is <c>true</c>.
In this case the contents of the buffer will be tested against the
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
events will be discarded.
</para>
<para>
If <paramref name="flushLossyBuffer"/> is <c>true</c> then the buffer will always
be emptied by calling this method.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
<summary>
Initialize the appender based on the options set
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
<summary>
Close this appender instance.
</summary>
<remarks>
<para>
Close this appender instance. If this appender is marked
as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
the buffer must be sent when the appender is closed.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">the event to log</param>
<remarks>
<para>
Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
</para>
<para>
The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
method) if one of the following conditions is met:
</para>
<list type="bullet">
<item>
<description>The cyclic buffer is full and this appender is
marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
</item>
<item>
<description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
it is triggered for the <paramref name="loggingEvent"/>
specified.</description>
</item>
</list>
<para>
Before the event is stored in the buffer it is fixed
(see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that
any data referenced by the event will be valid when the buffer
is processed.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
<summary>
Sends the contents of the buffer.
</summary>
<param name="firstLoggingEvent">The first logging event.</param>
<param name="buffer">The buffer containing the events that need to be send.</param>
<remarks>
<para>
The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
<summary>
Sends the events.
</summary>
<param name="events">The events that need to be send.</param>
<remarks>
<para>
The subclass must override this method to process the buffered events.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
<summary>
The size of the cyclic buffer used to hold the logging events.
</summary>
<remarks>
Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
<summary>
The cyclic buffer used to store the logging events.
</summary>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
<summary>
The triggering event evaluator that causes the buffer to be sent immediately.
</summary>
<remarks>
The object that is used to determine if an event causes the entire
buffer to be sent immediately. This field can be <c>null</c>, which
indicates that event triggering is not to be done. The evaluator
can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
<c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
<summary>
Indicates if the appender should overwrite events in the cyclic buffer
when it becomes full, or if the buffer should be flushed when the
buffer is full.
</summary>
<remarks>
If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
be set.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
<summary>
The triggering event evaluator filters discarded events.
</summary>
<remarks>
The object that is used to determine if an event that is discarded should
really be discarded or if it should be sent to the appenders.
This field can be <c>null</c>, which indicates that all discarded events will
be discarded.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
<summary>
Value indicating which fields in the event should be fixed
</summary>
<remarks>
By default all fields are fixed
</remarks>
</member>
<member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
<summary>
The events delivered to the subclass must be fixed.
</summary>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
<summary>
Gets or sets a value that indicates whether the appender is lossy.
</summary>
<value>
<c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
</value>
<remarks>
<para>
This appender uses a buffer to store logging events before
delivering them. A triggering event causes the whole buffer
to be send to the remote sink. If the buffer overruns before
a triggering event then logging events could be lost. Set
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
from being lost.
</para>
<para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
<summary>
Gets or sets the size of the cyclic buffer used to hold the
logging events.
</summary>
<value>
The size of the cyclic buffer used to hold the logging events.
</value>
<remarks>
<para>
The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
representing the maximum number of logging events to collect in
a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
oldest events are deleted as new events are added to the
buffer. By default the size of the cyclic buffer is 512 events.
</para>
<para>
If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
or equal to 1 then no buffering will occur. The logging event
will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
be buffered.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
<summary>
Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
buffer to be sent immediately.
</summary>
<value>
The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
sent immediately.
</value>
<remarks>
<para>
The evaluator will be called for each event that is appended to this
appender. If the evaluator triggers then the current buffer will
immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
</para>
<para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
<summary>
Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
</summary>
<value>
The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
</value>
<remarks>
<para>
The evaluator will be called for each event that is discarded from this
appender. If the evaluator triggers then the current buffer will immediately
be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
</para>
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
<summary>
Gets or sets a value indicating if only part of the logging event data
should be fixed.
</summary>
<value>
<c>true</c> if the appender should only fix part of the logging event
data, otherwise <c>false</c>. The default is <c>false</c>.
</value>
<remarks>
<para>
Setting this property to <c>true</c> will cause only part of the
event data to be fixed and serialized. This will improve performance.
</para>
<para>
See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
<summary>
Gets or sets a the fields that will be fixed in the event
</summary>
<value>
The event fields that will be fixed before the event is buffered
</value>
<remarks>
<para>
The logging event needs to have certain thread specific values
captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
for details.
</para>
</remarks>
<seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
</member>
<member name="M:log4net.Appender.AdoNetAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender"/> class.
</summary>
<remarks>
Public default constructor to initialize a new instance of this class.
</remarks>
</member>
<member name="M:log4net.Appender.AdoNetAppender.ActivateOptions">
<summary>
Initialize the appender based on the options set
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AdoNetAppender.OnClose">
<summary>
Override the parent method to close the database
</summary>
<remarks>
<para>
Closes the database command and database connection.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])">
<summary>
Inserts the events into the database.
</summary>
<param name="events">The events to insert into the database.</param>
<remarks>
<para>
Insert all the events specified in the <paramref name="events"/>
array into the database.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)">
<summary>
Adds a parameter to the command.
</summary>
<param name="parameter">The parameter to add to the command.</param>
<remarks>
<para>
Adds a parameter to the ordered list of command parameters.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])">
<summary>
Writes the events to the database using the transaction specified.
</summary>
<param name="dbTran">The transaction that the events will be executed under.</param>
<param name="events">The array of events to insert into the database.</param>
<remarks>
<para>
The transaction argument can be <c>null</c> if the appender has been
configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/>
property for more information.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)">
<summary>
Formats the log message into database statement text.
</summary>
<param name="logEvent">The event being logged.</param>
<remarks>
This method can be overridden by subclasses to provide
more control over the format of the database statement.
</remarks>
<returns>
Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
</returns>
</member>
<member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)">
<summary>
Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database.
</summary>
<remarks>
This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary).
</remarks>
<param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param>
<param name="connectionString">The connectionString output from the ResolveConnectionString method.</param>
<returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns>
</member>
<member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)">
<summary>
Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey
property.
</summary>
<remarks>
ConnectiongStringName is only supported on .NET 2.0 and higher.
</remarks>
<param name="connectionStringContext">Additional information describing the connection string.</param>
<returns>A connection string used to connect to the database.</returns>
</member>
<member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
<summary>
Retrieves the class type of the ADO.NET provider.
</summary>
<remarks>
<para>
Gets the Type of the ADO.NET provider to use to connect to the
database. This method resolves the type specified in the
<see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
</para>
<para>
Subclasses can override this method to return a different type
if necessary.
</para>
</remarks>
<returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
</member>
<member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseCommand">
<summary>
Prepares the database command and initialize the parameters.
</summary>
</member>
<member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
<summary>
Connects to the database.
</summary>
</member>
<member name="M:log4net.Appender.AdoNetAppender.DisposeCommand(System.Boolean)">
<summary>
Cleanup the existing command.
</summary>
<param name="ignoreException">
If true, a message will be written using LogLog.Warn if an exception is encountered when calling Dispose.
</param>
</member>
<member name="M:log4net.Appender.AdoNetAppender.DiposeConnection">
<summary>
Cleanup the existing connection.
</summary>
<remarks>
Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method.
</remarks>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_usePreparedCommand">
<summary>
Flag to indicate if we are using a command object
</summary>
<remarks>
<para>
Set to <c>true</c> when the appender is to use a prepared
statement or stored procedure to insert into the database.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_parameters">
<summary>
The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
</summary>
<remarks>
<para>
The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
<summary>
The security context to use for privileged calls
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
<summary>
The <see cref="T:System.Data.IDbConnection"/> that will be used
to insert logging events into a database.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_dbCommand">
<summary>
The database command.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
<summary>
Database connection string.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey">
<summary>
The appSettings key from App.Config that contains the connection string.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_connectionStringName">
<summary>
The connectionStrings key from App.Config that contains the connection string.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
<summary>
String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_commandText">
<summary>
The text of the command.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_commandType">
<summary>
The command type.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
<summary>
Indicates whether to use transactions when writing to the database.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
<summary>
Indicates whether to use transactions when writing to the database.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppender.declaringType">
<summary>
The fully qualified type of the AdoNetAppender class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Appender.AdoNetAppender.ConnectionString">
<summary>
Gets or sets the database connection string that is used to connect to
the database.
</summary>
<value>
The database connection string used to connect to the database.
</value>
<remarks>
<para>
The connections string is specific to the connection type.
See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information.
</para>
</remarks>
<example>Connection string for MS Access via ODBC:
<code>"DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"</code>
</example>
<example>Another connection string for MS Access via ODBC:
<code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code>
</example>
<example>Connection string for MS Access via OLE DB:
<code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code>
</example>
</member>
<member name="P:log4net.Appender.AdoNetAppender.AppSettingsKey">
<summary>
The appSettings key from App.Config that contains the connection string.
</summary>
</member>
<member name="P:log4net.Appender.AdoNetAppender.ConnectionStringName">
<summary>
The connectionStrings key from App.Config that contains the connection string.
</summary>
<remarks>
This property requires at least .NET 2.0.
</remarks>
</member>
<member name="P:log4net.Appender.AdoNetAppender.ConnectionType">
<summary>
Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
that should be created.
</summary>
<value>
The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
</value>
<remarks>
<para>
The type name of the ADO.NET provider to use.
</para>
<para>
The default is to use the OLE DB provider.
</para>
</remarks>
<example>Use the OLE DB Provider. This is the default value.
<code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
</example>
<example>Use the MS SQL Server Provider.
<code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
</example>
<example>Use the ODBC Provider.
<code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
This is an optional package that you can download from
<a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
search for <b>ODBC .NET Data Provider</b>.
</example>
<example>Use the Oracle Provider.
<code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
This is an optional package that you can download from
<a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
search for <b>.NET Managed Provider for Oracle</b>.
</example>
</member>
<member name="P:log4net.Appender.AdoNetAppender.CommandText">
<summary>
Gets or sets the command text that is used to insert logging events
into the database.
</summary>
<value>
The command text used to insert logging events into the database.
</value>
<remarks>
<para>
Either the text of the prepared statement or the
name of the stored procedure to execute to write into
the database.
</para>
<para>
The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if
this text is a prepared statement or a stored procedure.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AdoNetAppender.CommandType">
<summary>
Gets or sets the command type to execute.
</summary>
<value>
The command type to execute.
</value>
<remarks>
<para>
This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify
that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute,
or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the
<see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure
to execute.
</para>
<para>
The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>).
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AdoNetAppender.UseTransactions">
<summary>
Should transactions be used to insert logging events in the database.
</summary>
<value>
<c>true</c> if transactions should be used to insert logging events in
the database, otherwise <c>false</c>. The default value is <c>true</c>.
</value>
<remarks>
<para>
Gets or sets a value that indicates whether transactions should be used
to insert logging events in the database.
</para>
<para>
When set a single transaction will be used to insert the buffered events
into the database. Otherwise each event will be inserted without using
an explicit transaction.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AdoNetAppender.SecurityContext">
<summary>
Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
</summary>
<value>
The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
</value>
<remarks>
<para>
Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender
the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
security context to use. The default behavior is to use the security context
of the current thread.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError">
<summary>
Should this appender try to reconnect to the database on error.
</summary>
<value>
<c>true</c> if the appender should try to reconnect to the database after an
error has occurred, otherwise <c>false</c>. The default value is <c>false</c>,
i.e. not to try to reconnect.
</value>
<remarks>
<para>
The default behaviour is for the appender not to try to reconnect to the
database if an error occurs. Subsequent logging events are discarded.
</para>
<para>
To force the appender to attempt to reconnect to the database set this
property to <c>true</c>.
</para>
<note>
When the appender attempts to connect to the database there may be a
delay of up to the connection timeout specified in the connection string.
This delay will block the calling application's thread.
Until the connection can be reestablished this potential delay may occur multiple times.
</note>
</remarks>
</member>
<member name="P:log4net.Appender.AdoNetAppender.Connection">
<summary>
Gets or sets the underlying <see cref="T:System.Data.IDbConnection"/>.
</summary>
<value>
The underlying <see cref="T:System.Data.IDbConnection"/>.
</value>
<remarks>
<see cref="T:log4net.Appender.AdoNetAppender"/> creates a <see cref="T:System.Data.IDbConnection"/> to insert
logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender"/>
can use this property to get or set this <see cref="T:System.Data.IDbConnection"/>. Use the
underlying <see cref="T:System.Data.IDbConnection"/> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection"/> if
you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender"/> provides.
</remarks>
</member>
<member name="T:log4net.Appender.AdoNetAppenderParameter">
<summary>
Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
</summary>
<remarks>
<para>
This class provides the basic database parameter properties
as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
</para>
<para>This type can be subclassed to provide database specific
functionality. The two methods that are called externally are
<see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> class.
</summary>
<remarks>
Default constructor for the AdoNetAppenderParameter class.
</remarks>
</member>
<member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
<summary>
Prepare the specified database command object.
</summary>
<param name="command">The command to prepare.</param>
<remarks>
<para>
Prepares the database command object by adding
this parameter to its collection of parameters.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
<summary>
Renders the logging event and set the parameter value in the command.
</summary>
<param name="command">The command containing the parameter.</param>
<param name="loggingEvent">The event to be rendered.</param>
<remarks>
<para>
Renders the logging event using this parameters layout
object. Sets the value of the parameter on the command object.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
<summary>
The name of this parameter.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
<summary>
The database type for this parameter.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
<summary>
Flag to infer type rather than use the DbType
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
<summary>
The precision for this parameter.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
<summary>
The scale for this parameter.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
<summary>
The size for this parameter.
</summary>
</member>
<member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
<summary>
The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
logging event into an object for this parameter.
</summary>
</member>
<member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
<summary>
Gets or sets the name of this parameter.
</summary>
<value>
The name of this parameter.
</value>
<remarks>
<para>
The name of this parameter. The parameter name
must match up to a named parameter to the SQL stored procedure
or prepared statement.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
<summary>
Gets or sets the database type for this parameter.
</summary>
<value>
The database type for this parameter.
</value>
<remarks>
<para>
The database type for this parameter. This property should
be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
</para>
<para>
This property is optional. If not specified the ADO.NET provider
will attempt to infer the type from the value.
</para>
</remarks>
<seealso cref="P:System.Data.IDataParameter.DbType"/>
</member>
<member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
<summary>
Gets or sets the precision for this parameter.
</summary>
<value>
The precision for this parameter.
</value>
<remarks>
<para>
The maximum number of digits used to represent the Value.
</para>
<para>
This property is optional. If not specified the ADO.NET provider
will attempt to infer the precision from the value.
</para>
</remarks>
<seealso cref="P:System.Data.IDbDataParameter.Precision"/>
</member>
<member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
<summary>
Gets or sets the scale for this parameter.
</summary>
<value>
The scale for this parameter.
</value>
<remarks>
<para>
The number of decimal places to which Value is resolved.
</para>
<para>
This property is optional. If not specified the ADO.NET provider
will attempt to infer the scale from the value.
</para>
</remarks>
<seealso cref="P:System.Data.IDbDataParameter.Scale"/>
</member>
<member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
<summary>
Gets or sets the size for this parameter.
</summary>
<value>
The size for this parameter.
</value>
<remarks>
<para>
The maximum size, in bytes, of the data within the column.
</para>
<para>
This property is optional. If not specified the ADO.NET provider
will attempt to infer the size from the value.
</para>
<para>
For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case.
</para>
</remarks>
<seealso cref="P:System.Data.IDbDataParameter.Size"/>
</member>
<member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
<summary>
Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
render the logging event into an object for this
parameter.
</summary>
<value>
The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
logging event into an object for this parameter.
</value>
<remarks>
<para>
The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
parameter.
</para>
<para>
The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
for use in the property.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.AnsiColorTerminalAppender">
<summary>
Appends logging events to the terminal using ANSI color escape sequences.
</summary>
<remarks>
<para>
AnsiColorTerminalAppender appends log events to the standard output stream
or the error output stream using a layout specified by the
user. It also allows the color of a specific level of message to be set.
</para>
<note>
This appender expects the terminal to understand the VT100 control set
in order to interpret the color codes. If the terminal or console does not
understand the control codes the behavior is not defined.
</note>
<para>
By default, all output is written to the console's standard output stream.
The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
error stream.
</para>
<para>
NOTE: This appender writes each message to the <c>System.Console.Out</c> or
<c>System.Console.Error</c> that is set at the time the event is appended.
Therefore it is possible to programmatically redirect the output of this appender
(for example NUnit does this to capture program output). While this is the desired
behavior of this appender it may have security implications in your application.
</para>
<para>
When configuring the ANSI colored terminal appender, a mapping should be
specified to map a logging level to a color. For example:
</para>
<code lang="XML" escaped="true">
<mapping>
<level value="ERROR"/>
<foreColor value="White"/>
<backColor value="Red"/>
<attributes value="Bright,Underscore"/>
</mapping>
<mapping>
<level value="DEBUG"/>
<backColor value="Green"/>
</mapping>
</code>
<para>
The Level is the standard log4net logging level and ForeColor and BackColor can be any
of the following values:
<list type="bullet">
<item><term>Blue</term><description></description></item>
<item><term>Green</term><description></description></item>
<item><term>Red</term><description></description></item>
<item><term>White</term><description></description></item>
<item><term>Yellow</term><description></description></item>
<item><term>Purple</term><description></description></item>
<item><term>Cyan</term><description></description></item>
</list>
These color values cannot be combined together to make new colors.
</para>
<para>
The attributes can be any combination of the following:
<list type="bullet">
<item><term>Bright</term><description>foreground is brighter</description></item>
<item><term>Dim</term><description>foreground is dimmer</description></item>
<item><term>Underscore</term><description>message is underlined</description></item>
<item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
<item><term>Reverse</term><description>foreground and background are reversed</description></item>
<item><term>Hidden</term><description>output is hidden</description></item>
<item><term>Strikethrough</term><description>message has a line through it</description></item>
</list>
While any of these attributes may be combined together not all combinations
work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
no sense.
</para>
</remarks>
<author>Patrick Wagstrom</author>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
<summary>
The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
standard output stream.
</summary>
<remarks>
<para>
The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
standard output stream.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
<summary>
The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
standard error output stream.
</summary>
<remarks>
<para>
The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
standard error output stream.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
<summary>
Ansi code to reset terminal
</summary>
</member>
<member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class.
</summary>
<remarks>
The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class is set up to write
to the standard output stream.
</remarks>
</member>
<member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
<summary>
Add a mapping of level to color
</summary>
<param name="mapping">The mapping to add</param>
<remarks>
<para>
Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
Each mapping defines the foreground and background colours
for a level.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes the event to the console.
</para>
<para>
The format of the output will depend on the appender's layout.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
<summary>
Initialize the options for this appender
</summary>
<remarks>
<para>
Initialize the level to color mappings set on this appender.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
<summary>
Flag to write output to the error stream rather than the standard output stream
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
<summary>
Mapping from level object to color value
</summary>
</member>
<member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
<summary>
Target is the value of the console output stream.
</summary>
<value>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</value>
<remarks>
<para>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
<summary>
The enum of possible display attributes
</summary>
<remarks>
<para>
The following flags can be combined together to
form the ANSI color attributes.
</para>
</remarks>
<seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
<summary>
text is bright
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
<summary>
text is dim
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
<summary>
text is underlined
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
<summary>
text is blinking
</summary>
<remarks>
Not all terminals support this attribute
</remarks>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
<summary>
text and background colors are reversed
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
<summary>
text is hidden
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
<summary>
text is displayed with a strikethrough
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light">
<summary>
text color is light
</summary>
</member>
<member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
<summary>
The enum of possible foreground or background color values for
use with the color mapping method
</summary>
<remarks>
<para>
The output can be in one for the following ANSI colors.
</para>
</remarks>
<seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
<summary>
color is black
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
<summary>
color is red
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
<summary>
color is green
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
<summary>
color is yellow
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
<summary>
color is blue
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
<summary>
color is magenta
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
<summary>
color is cyan
</summary>
</member>
<member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
<summary>
color is white
</summary>
</member>
<member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
<summary>
A class to act as a mapping between the level that a logging call is made at and
the color it should be displayed as.
</summary>
<remarks>
<para>
Defines the mapping between a level and the color it should be displayed in.
</para>
</remarks>
</member>
<member name="T:log4net.Util.LevelMappingEntry">
<summary>
An entry in the <see cref="T:log4net.Util.LevelMapping"/>
</summary>
<remarks>
<para>
This is an abstract base class for types that are stored in the
<see cref="T:log4net.Util.LevelMapping"/> object.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.LevelMappingEntry.#ctor">
<summary>
Default protected constructor
</summary>
<remarks>
<para>
Default protected constructor
</para>
</remarks>
</member>
<member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
<summary>
Initialize any options defined on this entry
</summary>
<remarks>
<para>
Should be overridden by any classes that need to initialise based on their options
</para>
</remarks>
</member>
<member name="P:log4net.Util.LevelMappingEntry.Level">
<summary>
The level that is the key for this mapping
</summary>
<value>
The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
</value>
<remarks>
<para>
Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
mapping subclass.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
<summary>
Initialize the options for the object
</summary>
<remarks>
<para>
Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
and append the attributes.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
<summary>
The mapped foreground color for the specified level
</summary>
<remarks>
<para>
Required property.
The mapped foreground color for the specified level
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
<summary>
The mapped background color for the specified level
</summary>
<remarks>
<para>
Required property.
The mapped background color for the specified level
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
<summary>
The color attributes for the specified level
</summary>
<remarks>
<para>
Required property.
The color attributes for the specified level
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
<summary>
The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
<see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
</summary>
</member>
<member name="T:log4net.Appender.AppenderCollection">
<summary>
A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
</summary>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
<summary>
Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
</summary>
<param name="list">list to create a readonly wrapper arround</param>
<returns>
An <c>AppenderCollection</c> wrapper that is read-only.
</returns>
</member>
<member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
<summary>
An empty readonly static AppenderCollection
</summary>
</member>
<member name="M:log4net.Appender.AppenderCollection.#ctor">
<summary>
Initializes a new instance of the <c>AppenderCollection</c> class
that is empty and has the default initial capacity.
</summary>
</member>
<member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
<summary>
Initializes a new instance of the <c>AppenderCollection</c> class
that has the specified initial capacity.
</summary>
<param name="capacity">
The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
</param>
</member>
<member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
<summary>
Initializes a new instance of the <c>AppenderCollection</c> class
that contains elements copied from the specified <c>AppenderCollection</c>.
</summary>
<param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
</member>
<member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
<summary>
Initializes a new instance of the <c>AppenderCollection</c> class
that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
</summary>
<param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
</member>
<member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
<summary>
Initializes a new instance of the <c>AppenderCollection</c> class
that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
</summary>
<param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
</member>
<member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
<summary>
Allow subclasses to avoid our default constructors
</summary>
<param name="tag"></param>
<exclude/>
</member>
<member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
<summary>
Copies the entire <c>AppenderCollection</c> to a one-dimensional
<see cref="T:log4net.Appender.IAppender"/> array.
</summary>
<param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
</member>
<member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
<summary>
Copies the entire <c>AppenderCollection</c> to a one-dimensional
<see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
<param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
<summary>
Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
<returns>The index at which the value has been added.</returns>
</member>
<member name="M:log4net.Appender.AppenderCollection.Clear">
<summary>
Removes all elements from the <c>AppenderCollection</c>.
</summary>
</member>
<member name="M:log4net.Appender.AppenderCollection.Clone">
<summary>
Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
</summary>
<returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
</member>
<member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
<summary>
Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
<returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
<summary>
Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
in the <c>AppenderCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
<returns>
The zero-based index of the first occurrence of <paramref name="item"/>
in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
</returns>
</member>
<member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
<summary>
Inserts an element into the <c>AppenderCollection</c> at the specified index.
</summary>
<param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
<param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="index"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
</exception>
</member>
<member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
<summary>
Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
<exception cref="T:System.ArgumentException">
The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
</exception>
</member>
<member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
<summary>
Removes the element at the specified index of the <c>AppenderCollection</c>.
</summary>
<param name="index">The zero-based index of the element to remove.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="index"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
</exception>
</member>
<member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
</summary>
<returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
</member>
<member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
<summary>
Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
</summary>
<param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
<returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
</member>
<member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
<summary>
Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
</summary>
<param name="x">The <see cref="T:log4net.Appender.IAppender"/> array whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
<returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
</member>
<member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
<summary>
Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
</summary>
<param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
<returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
</member>
<member name="M:log4net.Appender.AppenderCollection.TrimToSize">
<summary>
Sets the capacity to the actual number of elements.
</summary>
</member>
<member name="M:log4net.Appender.AppenderCollection.ToArray">
<summary>
Return the collection elements as an array
</summary>
<returns>the array</returns>
</member>
<member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="i"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
</exception>
</member>
<member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="i"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
</exception>
</member>
<member name="P:log4net.Appender.AppenderCollection.Count">
<summary>
Gets the number of elements actually contained in the <c>AppenderCollection</c>.
</summary>
</member>
<member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
<summary>
Gets a value indicating whether access to the collection is synchronized (thread-safe).
</summary>
<returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns>
</member>
<member name="P:log4net.Appender.AppenderCollection.SyncRoot">
<summary>
Gets an object that can be used to synchronize access to the collection.
</summary>
</member>
<member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
<summary>
Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="index"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
</exception>
</member>
<member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
<summary>
Gets a value indicating whether the collection has a fixed size.
</summary>
<value>true if the collection has a fixed size; otherwise, false. The default is false</value>
</member>
<member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
<summary>
Gets a value indicating whether the IList is read-only.
</summary>
<value>true if the collection is read-only; otherwise, false. The default is false</value>
</member>
<member name="P:log4net.Appender.AppenderCollection.Capacity">
<summary>
Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
</summary>
</member>
<member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
<summary>
Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
</summary>
<exclude/>
</member>
<member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element in the collection.
</summary>
<returns>
<c>true</c> if the enumerator was successfully advanced to the next element;
<c>false</c> if the enumerator has passed the end of the collection.
</returns>
<exception cref="T:System.InvalidOperationException">
The collection was modified after the enumerator was created.
</exception>
</member>
<member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, before the first element in the collection.
</summary>
</member>
<member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
</member>
<member name="T:log4net.Appender.AppenderCollection.Tag">
<summary>
Type visible only to our subclasses
Used to access protected constructor
</summary>
<exclude/>
</member>
<member name="F:log4net.Appender.AppenderCollection.Tag.Default">
<summary>
A value
</summary>
</member>
<member name="T:log4net.Appender.AppenderCollection.Enumerator">
<summary>
Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
</summary>
<exclude/>
</member>
<member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
<summary>
Initializes a new instance of the <c>Enumerator</c> class.
</summary>
<param name="tc"></param>
</member>
<member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
<summary>
Advances the enumerator to the next element in the collection.
</summary>
<returns>
<c>true</c> if the enumerator was successfully advanced to the next element;
<c>false</c> if the enumerator has passed the end of the collection.
</returns>
<exception cref="T:System.InvalidOperationException">
The collection was modified after the enumerator was created.
</exception>
</member>
<member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
<summary>
Sets the enumerator to its initial position, before the first element in the collection.
</summary>
</member>
<member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
</member>
<member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
<exclude/>
</member>
<member name="T:log4net.Appender.AspNetTraceAppender">
<summary>
<para>
Appends log events to the ASP.NET <see cref="T:System.Web.TraceContext"/> system.
</para>
</summary>
<remarks>
<para>
Diagnostic information and tracing messages that you specify are appended to the output
of the page that is sent to the requesting browser. Optionally, you can view this information
from a separate trace viewer (Trace.axd) that displays trace information for every page in a
given application.
</para>
<para>
Trace statements are processed and displayed only when tracing is enabled. You can control
whether tracing is displayed to a page, to the trace viewer, or both.
</para>
<para>
The logging event is passed to the <see cref="M:TraceContext.Write(string)"/> or
<see cref="M:TraceContext.Warn(string)"/> method depending on the level of the logging event.
The event's logger name is the default value for the category parameter of the Write/Warn method.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Ron Grabowski</author>
</member>
<member name="M:log4net.Appender.AspNetTraceAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.AspNetTraceAppender"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.AspNetTraceAppender.Append(log4net.Core.LoggingEvent)">
<summary>
Write the logging event to the ASP.NET trace
</summary>
<param name="loggingEvent">the event to log</param>
<remarks>
<para>
Write the logging event to the ASP.NET trace
<c>HttpContext.Current.Trace</c>
(<see cref="T:System.Web.TraceContext"/>).
</para>
</remarks>
</member>
<member name="F:log4net.Appender.AspNetTraceAppender.m_category">
<summary>
Defaults to %logger
</summary>
</member>
<member name="P:log4net.Appender.AspNetTraceAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.AspNetTraceAppender.Category">
<summary>
The category parameter sent to the Trace method.
</summary>
<remarks>
<para>
Defaults to %logger which will use the logger name of the current
<see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
</para>
<para>
</para>
</remarks>
</member>
<member name="T:log4net.Appender.BufferingForwardingAppender">
<summary>
Buffers events and then forwards them to attached appenders.
</summary>
<remarks>
<para>
The events are buffered in this appender until conditions are
met to allow the appender to deliver the events to the attached
appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
conditions that cause the buffer to be sent.
</para>
<para>The forwarding appender can be used to specify different
thresholds and filters for the same appender at different locations
within the hierarchy.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Core.IAppenderAttachable">
<summary>
Interface for attaching appenders to objects.
</summary>
<remarks>
<para>
Interface for attaching, removing and retrieving appenders.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
<summary>
Attaches an appender.
</summary>
<param name="appender">The appender to add.</param>
<remarks>
<para>
Add the specified appender. The implementation may
choose to allow or deny duplicate appenders.
</para>
</remarks>
</member>
<member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
<summary>
Gets an attached appender with the specified name.
</summary>
<param name="name">The name of the appender to get.</param>
<returns>
The appender with the name specified, or <c>null</c> if no appender with the
specified name is found.
</returns>
<remarks>
<para>
Returns an attached appender with the <paramref name="name"/> specified.
If no appender with the specified name is found <c>null</c> will be
returned.
</para>
</remarks>
</member>
<member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
<summary>
Removes all attached appenders.
</summary>
<remarks>
<para>
Removes and closes all attached appenders
</para>
</remarks>
</member>
<member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
<summary>
Removes the specified appender from the list of attached appenders.
</summary>
<param name="appender">The appender to remove.</param>
<returns>The appender removed from the list</returns>
<remarks>
<para>
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</para>
</remarks>
</member>
<member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
<summary>
Removes the appender with the specified name from the list of appenders.
</summary>
<param name="name">The name of the appender to remove.</param>
<returns>The appender removed from the list</returns>
<remarks>
<para>
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</para>
</remarks>
</member>
<member name="P:log4net.Core.IAppenderAttachable.Appenders">
<summary>
Gets all attached appenders.
</summary>
<value>
A collection of attached appenders.
</value>
<remarks>
<para>
Gets a collection of attached appenders.
If there are no attached appenders the
implementation should return an empty
collection rather than <c>null</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
<summary>
Closes the appender and releases resources.
</summary>
<remarks>
<para>
Releases any resources allocated within the appender such as file handles,
network connections, etc.
</para>
<para>
It is a programming error to append to a closed appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
<summary>
Send the events.
</summary>
<param name="events">The events that need to be send.</param>
<remarks>
<para>
Forwards the events to the attached appenders.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
<summary>
Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
instance.
</summary>
<param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
<remarks>
<para>
If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
appenders, then it won't be added again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
<summary>
Looks for the appender with the specified name.
</summary>
<param name="name">The name of the appender to lookup.</param>
<returns>
The appender with the specified name, or <c>null</c>.
</returns>
<remarks>
<para>
Get the named appender attached to this buffering appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
<summary>
Removes all previously added appenders from this appender.
</summary>
<remarks>
<para>
This is useful when re-reading configuration information.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
<summary>
Removes the specified appender from the list of appenders.
</summary>
<param name="appender">The appender to remove.</param>
<returns>The appender removed from the list</returns>
<remarks>
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</remarks>
</member>
<member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
<summary>
Removes the appender with the specified name from the list of appenders.
</summary>
<param name="name">The name of the appender to remove.</param>
<returns>The appender removed from the list</returns>
<remarks>
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</remarks>
</member>
<member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
<summary>
Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
</summary>
</member>
<member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
<summary>
Gets the appenders contained in this appender as an
<see cref="T:System.Collections.ICollection"/>.
</summary>
<remarks>
If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
is returned.
</remarks>
<returns>
A collection of the appenders in this appender.
</returns>
</member>
<member name="T:log4net.Appender.ColoredConsoleAppender">
<summary>
Appends logging events to the console.
</summary>
<remarks>
<para>
ColoredConsoleAppender appends log events to the standard output stream
or the error output stream using a layout specified by the
user. It also allows the color of a specific type of message to be set.
</para>
<para>
By default, all output is written to the console's standard output stream.
The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the
error stream.
</para>
<para>
NOTE: This appender writes directly to the application's attached console
not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>.
The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be
programmatically redirected (for example NUnit does this to capture program output).
This appender will ignore these redirections because it needs to use Win32
API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/>
must be used.
</para>
<para>
When configuring the colored console appender, mapping should be
specified to map a logging level to a color. For example:
</para>
<code lang="XML" escaped="true">
<mapping>
<level value="ERROR"/>
<foreColor value="White"/>
<backColor value="Red, HighIntensity"/>
</mapping>
<mapping>
<level value="DEBUG"/>
<backColor value="Green"/>
</mapping>
</code>
<para>
The Level is the standard log4net logging level and ForeColor and BackColor can be any
combination of the following values:
<list type="bullet">
<item><term>Blue</term><description></description></item>
<item><term>Green</term><description></description></item>
<item><term>Red</term><description></description></item>
<item><term>White</term><description></description></item>
<item><term>Yellow</term><description></description></item>
<item><term>Purple</term><description></description></item>
<item><term>Cyan</term><description></description></item>
<item><term>HighIntensity</term><description></description></item>
</list>
</para>
</remarks>
<author>Rick Hobbs</author>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut">
<summary>
The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
standard output stream.
</summary>
<remarks>
<para>
The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
standard output stream.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError">
<summary>
The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
standard error output stream.
</summary>
<remarks>
<para>
The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
standard error output stream.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ColoredConsoleAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class.
</summary>
<remarks>
The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
to the standard output stream.
</remarks>
</member>
<member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
with the specified layout.
</summary>
<param name="layout">the layout to use for this appender</param>
<remarks>
The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
to the standard output stream.
</remarks>
</member>
<member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
with the specified layout.
</summary>
<param name="layout">the layout to use for this appender</param>
<param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
<remarks>
When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
the standard error output stream. Otherwise, output is written to the standard
output stream.
</remarks>
</member>
<member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)">
<summary>
Add a mapping of level to color - done by the config file
</summary>
<param name="mapping">The mapping to add</param>
<remarks>
<para>
Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender.
Each mapping defines the foreground and background colors
for a level.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes the event to the console.
</para>
<para>
The format of the output will depend on the appender's layout.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions">
<summary>
Initialize the options for this appender
</summary>
<remarks>
<para>
Initialize the level to color mappings set on this appender.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream">
<summary>
Flag to write output to the error stream rather than the standard output stream
</summary>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping">
<summary>
Mapping from level object to color value
</summary>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter">
<summary>
The console output stream writer to write to
</summary>
<remarks>
<para>
This writer is not thread safe.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ColoredConsoleAppender.Target">
<summary>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</summary>
<value>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</value>
<remarks>
<para>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.ColoredConsoleAppender.Colors">
<summary>
The enum of possible color values for use with the color mapping method
</summary>
<remarks>
<para>
The following flags can be combined together to
form the colors.
</para>
</remarks>
<seealso cref="T:log4net.Appender.ColoredConsoleAppender"/>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue">
<summary>
color is blue
</summary>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green">
<summary>
color is green
</summary>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red">
<summary>
color is red
</summary>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White">
<summary>
color is white
</summary>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow">
<summary>
color is yellow
</summary>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple">
<summary>
color is purple
</summary>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan">
<summary>
color is cyan
</summary>
</member>
<member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity">
<summary>
color is intensified
</summary>
</member>
<member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors">
<summary>
A class to act as a mapping between the level that a logging call is made at and
the color it should be displayed as.
</summary>
<remarks>
<para>
Defines the mapping between a level and the color it should be displayed in.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions">
<summary>
Initialize the options for the object
</summary>
<remarks>
<para>
Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor">
<summary>
The mapped foreground color for the specified level
</summary>
<remarks>
<para>
Required property.
The mapped foreground color for the specified level.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor">
<summary>
The mapped background color for the specified level
</summary>
<remarks>
<para>
Required property.
The mapped background color for the specified level.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor">
<summary>
The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for
setting the console color.
</summary>
</member>
<member name="T:log4net.Appender.ConsoleAppender">
<summary>
Appends logging events to the console.
</summary>
<remarks>
<para>
ConsoleAppender appends log events to the standard output stream
or the error output stream using a layout specified by the
user.
</para>
<para>
By default, all output is written to the console's standard output stream.
The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
error stream.
</para>
<para>
NOTE: This appender writes each message to the <c>System.Console.Out</c> or
<c>System.Console.Error</c> that is set at the time the event is appended.
Therefore it is possible to programmatically redirect the output of this appender
(for example NUnit does this to capture program output). While this is the desired
behavior of this appender it may have security implications in your application.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
<summary>
The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
standard output stream.
</summary>
<remarks>
<para>
The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
standard output stream.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
<summary>
The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
standard error output stream.
</summary>
<remarks>
<para>
The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
standard error output stream.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ConsoleAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class.
</summary>
<remarks>
The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
to the standard output stream.
</remarks>
</member>
<member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
with the specified layout.
</summary>
<param name="layout">the layout to use for this appender</param>
<remarks>
The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
to the standard output stream.
</remarks>
</member>
<member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
with the specified layout.
</summary>
<param name="layout">the layout to use for this appender</param>
<param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
<remarks>
When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
the standard error output stream. Otherwise, output is written to the standard
output stream.
</remarks>
</member>
<member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes the event to the console.
</para>
<para>
The format of the output will depend on the appender's layout.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ConsoleAppender.Target">
<summary>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</summary>
<value>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</value>
<remarks>
<para>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.DebugAppender">
<summary>
Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
</summary>
<remarks>
<para>
The application configuration file can be used to control what listeners
are actually used. See the MSDN documentation for the
<see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
debug system.
</para>
<para>
Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/>
method. The event's logger name is passed as the value for the category name to the Write method.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Appender.DebugAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>
with a specified layout.
</summary>
<param name="layout">The layout to use with this appender.</param>
<remarks>
<para>
Obsolete constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
<summary>
Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
is called.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
<summary>
Immediate flush means that the underlying writer or output stream
will be flushed at the end of each append operation.
</summary>
<remarks>
<para>
Immediate flush is slower but ensures that each append request is
actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
<c>false</c>, then there is a good chance that the last few
logs events are not actually written to persistent media if and
when the application crashes.
</para>
<para>
The default value is <c>true</c>.</para>
</remarks>
</member>
<member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
<summary>
Gets or sets a value that indicates whether the appender will
flush at the end of each write.
</summary>
<remarks>
<para>The default behavior is to flush at the end of each
write. If the option is set to<c>false</c>, then the underlying
stream can defer writing to physical medium to a later time.
</para>
<para>
Avoiding the flush operation at the end of each append results
in a performance gain of 10 to 20 percent. However, there is safety
trade-off involved in skipping flushing. Indeed, when flushing is
skipped, then it is likely that the last few log events will not
be recorded on disk when the application exits. This is a high
price to pay even for a 20% performance gain.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.DebugAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.EventLogAppender">
<summary>
Writes events to the system event log.
</summary>
<remarks>
<para>
The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges.
See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog
</para>
<para>
The <c>EventID</c> of the event log entry can be
set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
on the <see cref="T:log4net.Core.LoggingEvent"/>.
</para>
<para>
The <c>Category</c> of the event log entry can be
set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
on the <see cref="T:log4net.Core.LoggingEvent"/>.
</para>
<para>
There is a limit of 32K characters for an event log message
</para>
<para>
When configuring the EventLogAppender a mapping can be
specified to map a logging level to an event log entry type. For example:
</para>
<code lang="XML">
<mapping>
<level value="ERROR" />
<eventLogEntryType value="Error" />
</mapping>
<mapping>
<level value="DEBUG" />
<eventLogEntryType value="Information" />
</mapping>
</code>
<para>
The Level is the standard log4net logging level and eventLogEntryType can be any value
from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.:
<list type="bullet">
<item><term>Error</term><description>an error event</description></item>
<item><term>Warning</term><description>a warning event</description></item>
<item><term>Information</term><description>an informational event</description></item>
</list>
</para>
</remarks>
<author>Aspi Havewala</author>
<author>Douglas de la Torre</author>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Thomas Voss</author>
</member>
<member name="M:log4net.Appender.EventLogAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class
with the specified <see cref="T:log4net.Layout.ILayout"/>.
</summary>
<param name="layout">The <see cref="T:log4net.Layout.ILayout"/> to use with this appender.</param>
<remarks>
<para>
Obsolete constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)">
<summary>
Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file
</summary>
<param name="mapping">The mapping to add</param>
<remarks>
<para>
Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender.
Each mapping defines the event log entry type for a level.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.EventLogAppender.ActivateOptions">
<summary>
Initialize the appender based on the options set
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)">
<summary>
Create an event log source
</summary>
<remarks>
Uses different API calls under NET_2_0
</remarks>
</member>
<member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
method.
</summary>
<param name="loggingEvent">the event to log</param>
<remarks>
<para>Writes the event to the system event log using the
<see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para>
<para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>)
set then this integer will be used as the event log event id.</para>
<para>
There is a limit of 32K characters for an event log message
</para>
</remarks>
</member>
<member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)">
<summary>
Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/>
</summary>
<param name="level">the Level to convert to an EventLogEntryType</param>
<returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/></returns>
<remarks>
Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/>
values to use in logging levels than there are in the
<see cref="T:log4net.Core.Level"/> this is a one way mapping. There is
a loss of information during the conversion.
</remarks>
</member>
<member name="F:log4net.Appender.EventLogAppender.m_logName">
<summary>
The log name is the section in the event logs where the messages
are stored.
</summary>
</member>
<member name="F:log4net.Appender.EventLogAppender.m_applicationName">
<summary>
Name of the application to use when logging. This appears in the
application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>.
</summary>
</member>
<member name="F:log4net.Appender.EventLogAppender.m_machineName">
<summary>
The name of the machine which holds the event log. This is
currently only allowed to be '.' i.e. the current machine.
</summary>
</member>
<member name="F:log4net.Appender.EventLogAppender.m_levelMapping">
<summary>
Mapping from level object to EventLogEntryType
</summary>
</member>
<member name="F:log4net.Appender.EventLogAppender.m_securityContext">
<summary>
The security context to use for privileged calls
</summary>
</member>
<member name="F:log4net.Appender.EventLogAppender.m_eventId">
<summary>
The event ID to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
</summary>
</member>
<member name="F:log4net.Appender.EventLogAppender.m_category">
<summary>
The event category to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
</summary>
</member>
<member name="F:log4net.Appender.EventLogAppender.declaringType">
<summary>
The fully qualified type of the EventLogAppender class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_DEFAULT">
<summary>
The maximum size supported by default.
</summary>
<remarks>
http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx
The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766
may leave space for a two byte null terminator of #0#0). The 32766 max
length is what the .NET 4.0 source code checks for, but this is WRONG!
Strings with a length > 31839 on Windows Vista or higher can CORRUPT
the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent()
for the use of the 32766 max size.
</remarks>
</member>
<member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_VISTA_OR_NEWER">
<summary>
The maximum size supported by a windows operating system that is vista
or newer.
</summary>
<remarks>
See ReportEvent API:
http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx
ReportEvent's lpStrings parameter:
"A pointer to a buffer containing an array of
null-terminated strings that are merged into the message before Event Viewer
displays the string to the user. This parameter must be a valid pointer
(or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters."
Going beyond the size of 31839 will (at some point) corrupt the event log on Windows
Vista or higher! It may succeed for a while...but you will eventually run into the
error: "System.ComponentModel.Win32Exception : A device attached to the system is
not functioning", and the event log will then be corrupt (I was able to corrupt
an event log using a length of 31877 on Windows 7).
The max size for Windows Vista or higher is documented here:
http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx.
Going over this size may succeed a few times but the buffer will overrun and
eventually corrupt the log (based on testing).
The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API.
The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a
terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the
buffer, given enough time).
</remarks>
</member>
<member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE">
<summary>
The maximum size that the operating system supports for
a event log message.
</summary>
<remarks>
Used to determine the maximum string length that can be written
to the operating system event log and eventually truncate a string
that exceeds the limits.
</remarks>
</member>
<member name="M:log4net.Appender.EventLogAppender.GetMaxEventLogMessageSize">
<summary>
This method determines the maximum event log message size allowed for
the current environment.
</summary>
<returns></returns>
</member>
<member name="P:log4net.Appender.EventLogAppender.LogName">
<summary>
The name of the log where messages will be stored.
</summary>
<value>
The string name of the log where messages will be stored.
</value>
<remarks>
<para>This is the name of the log as it appears in the Event Viewer
tree. The default value is to log into the <c>Application</c>
log, this is where most applications write their events. However
if you need a separate log for your application (or applications)
then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para>
<para>This should not be used to distinguish your event log messages
from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>
property should be used to distinguish events. This property should be
used to group together events into a single log.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.EventLogAppender.ApplicationName">
<summary>
Property used to set the Application name. This appears in the
event logs when logging.
</summary>
<value>
The string used to distinguish events from different sources.
</value>
<remarks>
Sets the event log source property.
</remarks>
</member>
<member name="P:log4net.Appender.EventLogAppender.MachineName">
<summary>
This property is used to return the name of the computer to use
when accessing the event logs. Currently, this is the current
computer, denoted by a dot "."
</summary>
<value>
The string name of the machine holding the event log that
will be logged into.
</value>
<remarks>
This property cannot be changed. It is currently set to '.'
i.e. the local machine. This may be changed in future.
</remarks>
</member>
<member name="P:log4net.Appender.EventLogAppender.SecurityContext">
<summary>
Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
</summary>
<value>
The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
</value>
<remarks>
<para>
The system security context used to write to the EventLog.
</para>
<para>
Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender
the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
security context to use. The default behavior is to use the security context
of the current thread.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.EventLogAppender.EventId">
<summary>
Gets or sets the <c>EventId</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
</summary>
<remarks>
<para>
The <c>EventID</c> of the event log entry will normally be
set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
on the <see cref="T:log4net.Core.LoggingEvent"/>.
This property provides the fallback value which defaults to 0.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.EventLogAppender.Category">
<summary>
Gets or sets the <c>Category</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
</summary>
<remarks>
<para>
The <c>Category</c> of the event log entry will normally be
set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
on the <see cref="T:log4net.Core.LoggingEvent"/>.
This property provides the fallback value which defaults to 0.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.EventLogAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType">
<summary>
A class to act as a mapping between the level that a logging call is made at and
the color it should be displayed as.
</summary>
<remarks>
<para>
Defines the mapping between a level and its event log entry type.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType">
<summary>
The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
</summary>
<remarks>
<para>
Required property.
The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
</para>
</remarks>
</member>
<member name="T:log4net.Appender.FileAppender">
<summary>
Appends logging events to a file.
</summary>
<remarks>
<para>
Logging events are sent to the file specified by
the <see cref="P:log4net.Appender.FileAppender.File"/> property.
</para>
<para>
The file can be opened in either append or overwrite mode
by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
If the file path is relative it is taken as relative from
the application base directory. The file encoding can be
specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
</para>
<para>
The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
values will be written each time the file is opened and closed
respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
then the file may contain multiple copies of the header and footer.
</para>
<para>
This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
is called. This will typically be during configuration.
If the file cannot be opened for writing the appender will attempt
to open the file again each time a message is logged to the appender.
If the file cannot be opened for writing when a message is logged then
the message will be discarded by this appender.
</para>
<para>
The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
is to obtain an exclusive write lock on the file until this appender is closed.
The alternative models only hold a
write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>)
or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>).
</para>
<para>
All locking strategies have issues and you should seriously consider using a different strategy that
avoids having multiple processes logging to the same file.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Rodrigo B. de Oliveira</author>
<author>Douglas de la Torre</author>
<author>Niall Daley</author>
</member>
<member name="T:log4net.Appender.TextWriterAppender">
<summary>
Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
</summary>
<remarks>
<para>
An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
</para>
<para>
This appender may be used stand alone if initialized with an appropriate
writer, however it is typically used as a base class for an appender that
can open a <see cref="T:System.IO.TextWriter"/> to write to.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Douglas de la Torre</author>
</member>
<member name="M:log4net.Appender.TextWriterAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and
sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
with the specified <see cref="T:System.IO.Stream"/>.
</summary>
<param name="layout">The layout to use with this appender.</param>
<param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
<remarks>
<para>
Obsolete constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and sets
the output destination to the specified <see cref="T:System.IO.StreamWriter"/>.
</summary>
<param name="layout">The layout to use with this appender</param>
<param name="writer">The <see cref="T:System.IO.TextWriter"/> to output to</param>
<remarks>
The <see cref="T:System.IO.TextWriter"/> must have been previously opened.
</remarks>
<remarks>
<para>
Obsolete constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
<summary>
This method determines if there is a sense in attempting to append.
</summary>
<remarks>
<para>
This method checks if an output target has been set and if a
layout has been set.
</para>
</remarks>
<returns><c>false</c> if any of the preconditions fail.</returns>
</member>
<member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes a log statement to the output stream if the output stream exists
and is writable.
</para>
<para>
The format of the output will depend on the appender's layout.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
method.
</summary>
<param name="loggingEvents">The array of events to log.</param>
<remarks>
<para>
This method writes all the bulk logged events to the output writer
before flushing the stream.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.OnClose">
<summary>
Close this appender instance. The underlying stream or writer is also closed.
</summary>
<remarks>
Closed appenders cannot be reused.
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
<summary>
Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
</summary>
<remarks>
<para>
Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
<summary>
Closes the underlying <see cref="T:System.IO.TextWriter"/>.
</summary>
<remarks>
<para>
Closes the underlying <see cref="T:System.IO.TextWriter"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.Reset">
<summary>
Clears internal references to the underlying <see cref="T:System.IO.TextWriter"/>
and other variables.
</summary>
<remarks>
<para>
Subclasses can override this method for an alternate closing behavior.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
<summary>
Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
</summary>
<remarks>
<para>
Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
<summary>
Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
</summary>
<remarks>
<para>
Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
<summary>
Called to allow a subclass to lazily initialize the writer
</summary>
<remarks>
<para>
This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
<see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
attempt to initialize the writer multiple times.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.TextWriterAppender.m_qtw">
<summary>
This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
will be written to.
</summary>
</member>
<member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
<summary>
Immediate flush means that the underlying <see cref="T:System.IO.TextWriter"/>
or output stream will be flushed at the end of each append operation.
</summary>
<remarks>
<para>
Immediate flush is slower but ensures that each append request is
actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
<c>false</c>, then there is a good chance that the last few
logging events are not actually persisted if and when the application
crashes.
</para>
<para>
The default value is <c>true</c>.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.TextWriterAppender.declaringType">
<summary>
The fully qualified type of the TextWriterAppender class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
<summary>
Gets or set whether the appender will flush at the end
of each append operation.
</summary>
<value>
<para>
The default behavior is to flush at the end of each
append operation.
</para>
<para>
If this option is set to <c>false</c>, then the underlying
stream can defer persisting the logging event to a later
time.
</para>
</value>
<remarks>
Avoiding the flush operation at the end of each append results in
a performance gain of 10 to 20 percent. However, there is safety
trade-off involved in skipping flushing. Indeed, when flushing is
skipped, then it is likely that the last few log events will not
be recorded on disk when the application exits. This is a high
price to pay even for a 20% performance gain.
</remarks>
</member>
<member name="P:log4net.Appender.TextWriterAppender.Writer">
<summary>
Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
</summary>
<remarks>
<para>
The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
</para>
<para>
The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
instance is closed.
</para>
<para>
<b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
<summary>
Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
<see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
</summary>
<value>
The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
</value>
</member>
<member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
<summary>
Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
will be written to.
</summary>
<value>
The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
</value>
<remarks>
<para>
This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
will be written to.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Default constructor
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
<summary>
Construct a new appender using the layout, file and append mode.
</summary>
<param name="layout">the layout to use with this appender</param>
<param name="filename">the full path to the file to write to</param>
<param name="append">flag to indicate if the file should be appended to</param>
<remarks>
<para>
Obsolete constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
<summary>
Construct a new appender using the layout and file specified.
The file will be appended to.
</summary>
<param name="layout">the layout to use with this appender</param>
<param name="filename">the full path to the file to write to</param>
<remarks>
<para>
Obsolete constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.ActivateOptions">
<summary>
Activate the options on the file appender.
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
</para>
<para>
This will cause the file to be opened.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.Reset">
<summary>
Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
</summary>
<remarks>
<para>
Resets the filename and the file stream.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.PrepareWriter">
<summary>
Called to initialize the file writer
</summary>
<remarks>
<para>
Will be called for each logged message until the file is
successfully opened.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes a log statement to the output stream if the output stream exists
and is writable.
</para>
<para>
The format of the output will depend on the appender's layout.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
method.
</summary>
<param name="loggingEvents">The array of events to log.</param>
<remarks>
<para>
Acquires the output file locks once before writing all the events to
the stream.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.WriteFooter">
<summary>
Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
</summary>
<remarks>
<para>
Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.WriteHeader">
<summary>
Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
</summary>
<remarks>
<para>
Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.CloseWriter">
<summary>
Closes the underlying <see cref="T:System.IO.TextWriter"/>.
</summary>
<remarks>
<para>
Closes the underlying <see cref="T:System.IO.TextWriter"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.CloseFile">
<summary>
Closes the previously opened file.
</summary>
<remarks>
<para>
Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
closes the file.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
<summary>
Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
</summary>
<param name="fileName">The path to the log file. Must be a fully qualified path.</param>
<param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
<remarks>
<para>
Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
<summary>
Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
</summary>
<param name="fileName">The path to the log file. Must be a fully qualified path.</param>
<param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
<remarks>
<para>
If there was already an opened file, then the previous file
is closed first.
</para>
<para>
This method will ensure that the directory structure
for the <paramref name="fileName"/> specified exists.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
<summary>
Sets the quiet writer used for file output
</summary>
<param name="fileStream">the file stream that has been opened for writing</param>
<remarks>
<para>
This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
over the <paramref name="fileStream"/> and passes it to the
<see cref="M:SetQWForFiles(TextWriter)"/> method.
</para>
<para>
This method can be overridden by sub classes that want to wrap the
<see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
data using a <c>System.Security.Cryptography.CryptoStream</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
<summary>
Sets the quiet writer being used.
</summary>
<param name="writer">the writer over the file stream that has been opened for writing</param>
<remarks>
<para>
This method can be overridden by sub classes that want to
wrap the <see cref="T:System.IO.TextWriter"/> in some way.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
<summary>
Convert a path into a fully qualified path.
</summary>
<param name="path">The path to convert.</param>
<returns>The fully qualified path.</returns>
<remarks>
<para>
Converts the path specified to a fully
qualified path. If the path is relative it is
taken as relative from the application base
directory.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.FileAppender.m_appendToFile">
<summary>
Flag to indicate if we should append to the file
or overwrite the file. The default is to append.
</summary>
</member>
<member name="F:log4net.Appender.FileAppender.m_fileName">
<summary>
The name of the log file.
</summary>
</member>
<member name="F:log4net.Appender.FileAppender.m_encoding">
<summary>
The encoding to use for the file stream.
</summary>
</member>
<member name="F:log4net.Appender.FileAppender.m_securityContext">
<summary>
The security context to use for privileged calls
</summary>
</member>
<member name="F:log4net.Appender.FileAppender.m_stream">
<summary>
The stream to log to. Has added locking semantics
</summary>
</member>
<member name="F:log4net.Appender.FileAppender.m_lockingModel">
<summary>
The locking model to use
</summary>
</member>
<member name="F:log4net.Appender.FileAppender.declaringType">
<summary>
The fully qualified type of the FileAppender class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Appender.FileAppender.File">
<summary>
Gets or sets the path to the file that logging will be written to.
</summary>
<value>
The path to the file that logging will be written to.
</value>
<remarks>
<para>
If the path is relative it is taken as relative from
the application base directory.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.FileAppender.AppendToFile">
<summary>
Gets or sets a flag that indicates whether the file should be
appended to or overwritten.
</summary>
<value>
Indicates whether the file should be appended to or overwritten.
</value>
<remarks>
<para>
If the value is set to false then the file will be overwritten, if
it is set to true then the file will be appended to.
</para>
The default value is true.
</remarks>
</member>
<member name="P:log4net.Appender.FileAppender.Encoding">
<summary>
Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
</summary>
<value>
The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
</value>
<remarks>
<para>
The default encoding set is <see cref="P:System.Text.Encoding.Default"/>
which is the encoding for the system's current ANSI code page.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.FileAppender.SecurityContext">
<summary>
Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
</summary>
<value>
The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
</value>
<remarks>
<para>
Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
security context to use. The default behavior is to use the security context
of the current thread.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.FileAppender.LockingModel">
<summary>
Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
</summary>
<value>
The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
</value>
<remarks>
<para>
Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
</para>
<para>
There are three built in locking models, <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>, <see cref="T:log4net.Appender.FileAppender.MinimalLock"/> and <see cref="T:log4net.Appender.FileAppender.InterProcessLock"/> .
The first locks the file from the start of logging to the end, the
second locks only for the minimal amount of time when logging each message
and the last synchronizes processes using a named system wide Mutex.
</para>
<para>
The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.FileAppender.LockingStream">
<summary>
Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
to manage access to an underlying resource.
</summary>
</member>
<member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
<summary>
True asynchronous writes are not supported, the implementation forces a synchronous write.
</summary>
</member>
<member name="T:log4net.Core.LogException">
<summary>
Exception base type for log4net.
</summary>
<remarks>
<para>
This type extends <see cref="T:System.ApplicationException"/>. It
does not add any new functionality but does differentiate the
type of exception being thrown.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.LogException.#ctor">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogException.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="message">A message to include with the exception.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class with
the specified message.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
<summary>
Constructor
</summary>
<param name="message">A message to include with the exception.</param>
<param name="innerException">A nested exception to include.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
with the specified message and inner exception.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Serialization constructor
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
with serialized data.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.FileAppender.LockingModelBase">
<summary>
Locking model base class
</summary>
<remarks>
<para>
Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
<summary>
Open the output file
</summary>
<param name="filename">The filename to use</param>
<param name="append">Whether to append to the file, or overwrite</param>
<param name="encoding">The encoding to use</param>
<remarks>
<para>
Open the file specified and prepare for logging.
No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
<see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
<summary>
Close the file
</summary>
<remarks>
<para>
Close the file. No further writes will be made.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
<summary>
Acquire the lock on the file
</summary>
<returns>A stream that is ready to be written to.</returns>
<remarks>
<para>
Acquire the lock on the file in preparation for writing to it.
Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
must be called to release the lock on the output file.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
<summary>
Release the lock on the file
</summary>
<remarks>
<para>
Release the lock on the file. No further writes will be made to the
stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)">
<summary>
Helper method that creates a FileStream under CurrentAppender's SecurityContext.
</summary>
<remarks>
<para>
Typically called during OpenFile or AcquireLock.
</para>
<para>
If the directory portion of the <paramref name="filename"/> does not exist, it is created
via Directory.CreateDirecctory.
</para>
</remarks>
<param name="filename"></param>
<param name="append"></param>
<param name="fileShare"></param>
<returns></returns>
</member>
<member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)">
<summary>
Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext.
</summary>
<remarks>
Does not set <paramref name="stream"/> to null.
</remarks>
<param name="stream"></param>
</member>
<member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
<summary>
Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
</summary>
<value>
The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
</value>
<remarks>
<para>
The file appender this locking model is attached to and working on
behalf of.
</para>
<para>
The file appender is used to locate the security context and the error handler to use.
</para>
<para>
The value of this property will be set before <see cref="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)"/> is
called.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.FileAppender.ExclusiveLock">
<summary>
Hold an exclusive lock on the output file
</summary>
<remarks>
<para>
Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
Maintains an exclusive lock on the file during this time.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
<summary>
Open the file specified and prepare for logging.
</summary>
<param name="filename">The filename to use</param>
<param name="append">Whether to append to the file, or overwrite</param>
<param name="encoding">The encoding to use</param>
<remarks>
<para>
Open the file specified and prepare for logging.
No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
<see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
<summary>
Close the file
</summary>
<remarks>
<para>
Close the file. No further writes will be made.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
<summary>
Acquire the lock on the file
</summary>
<returns>A stream that is ready to be written to.</returns>
<remarks>
<para>
Does nothing. The lock is already taken
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
<summary>
Release the lock on the file
</summary>
<remarks>
<para>
Does nothing. The lock will be released when the file is closed.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.FileAppender.MinimalLock">
<summary>
Acquires the file lock for each write
</summary>
<remarks>
<para>
Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
thus holding the lock for the minimal amount of time. This method of locking
is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
other processes to move/delete the log file whilst logging continues.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
<summary>
Prepares to open the file when the first message is logged.
</summary>
<param name="filename">The filename to use</param>
<param name="append">Whether to append to the file, or overwrite</param>
<param name="encoding">The encoding to use</param>
<remarks>
<para>
Open the file specified and prepare for logging.
No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
<summary>
Close the file
</summary>
<remarks>
<para>
Close the file. No further writes will be made.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
<summary>
Acquire the lock on the file
</summary>
<returns>A stream that is ready to be written to.</returns>
<remarks>
<para>
Acquire the lock on the file in preparation for writing to it.
Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
must be called to release the lock on the output file.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
<summary>
Release the lock on the file
</summary>
<remarks>
<para>
Release the lock on the file. No further writes will be made to the
stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.FileAppender.InterProcessLock">
<summary>
Provides cross-process file locking.
</summary>
<author>Ron Grabowski</author>
<author>Steve Wranovsky</author>
</member>
<member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
<summary>
Open the file specified and prepare for logging.
</summary>
<param name="filename">The filename to use</param>
<param name="append">Whether to append to the file, or overwrite</param>
<param name="encoding">The encoding to use</param>
<remarks>
<para>
Open the file specified and prepare for logging.
No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called.
Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>,
-<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile">
<summary>
Close the file
</summary>
<remarks>
<para>
Close the file. No further writes will be made.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock">
<summary>
Acquire the lock on the file
</summary>
<returns>A stream that is ready to be written to.</returns>
<remarks>
<para>
Does nothing. The lock is already taken
</para>
</remarks>
</member>
<member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock">
<summary>
</summary>
</member>
<member name="T:log4net.Appender.ForwardingAppender">
<summary>
This appender forwards logging events to attached appenders.
</summary>
<remarks>
<para>
The forwarding appender can be used to specify different thresholds
and filters for the same appender at different locations within the hierarchy.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Appender.ForwardingAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ForwardingAppender.OnClose">
<summary>
Closes the appender and releases resources.
</summary>
<remarks>
<para>
Releases any resources allocated within the appender such as file handles,
network connections, etc.
</para>
<para>
It is a programming error to append to a closed appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
<summary>
Forward the logging event to the attached appenders
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Delivers the logging event to all the attached appenders.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
<summary>
Forward the logging events to the attached appenders
</summary>
<param name="loggingEvents">The array of events to log.</param>
<remarks>
<para>
Delivers the logging events to all the attached appenders.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
<summary>
Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
instance.
</summary>
<param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
<remarks>
<para>
If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
appenders, then it won't be added again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
<summary>
Looks for the appender with the specified name.
</summary>
<param name="name">The name of the appender to lookup.</param>
<returns>
The appender with the specified name, or <c>null</c>.
</returns>
<remarks>
<para>
Get the named appender attached to this appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
<summary>
Removes all previously added appenders from this appender.
</summary>
<remarks>
<para>
This is useful when re-reading configuration information.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
<summary>
Removes the specified appender from the list of appenders.
</summary>
<param name="appender">The appender to remove.</param>
<returns>The appender removed from the list</returns>
<remarks>
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</remarks>
</member>
<member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
<summary>
Removes the appender with the specified name from the list of appenders.
</summary>
<param name="name">The name of the appender to remove.</param>
<returns>The appender removed from the list</returns>
<remarks>
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</remarks>
</member>
<member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
<summary>
Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
</summary>
</member>
<member name="P:log4net.Appender.ForwardingAppender.Appenders">
<summary>
Gets the appenders contained in this appender as an
<see cref="T:System.Collections.ICollection"/>.
</summary>
<remarks>
If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
is returned.
</remarks>
<returns>
A collection of the appenders in this appender.
</returns>
</member>
<member name="T:log4net.Appender.LocalSyslogAppender">
<summary>
Logs events to a local syslog service.
</summary>
<remarks>
<note>
This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
If these functions are not available on the local system then this appender will not work!
</note>
<para>
The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
</para>
<para>
This appender talks to a local syslog service. If you need to log to a remote syslog
daemon and you cannot configure your local syslog service to do this you may be
able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
</para>
<para>
Syslog messages must have a facility and and a severity. The severity
is derived from the Level of the logging event.
The facility must be chosen from the set of defined syslog
<see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
and cannot be extended.
</para>
<para>
An identifier is specified with each log message. This can be specified
by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
as the tag) must not contain white space. The default value for the
identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
</para>
</remarks>
<author>Rob Lyon</author>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class.
</summary>
<remarks>
This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class is set up to write
to a local syslog service.
</remarks>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
<summary>
Add a mapping of level to severity
</summary>
<param name="mapping">The mapping to add</param>
<remarks>
<para>
Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
<summary>
Initialize the appender based on the options set.
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes the event to a remote syslog daemon.
</para>
<para>
The format of the output will depend on the appender's layout.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
<summary>
Close the syslog when the appender is closed
</summary>
<remarks>
<para>
Close the syslog when the appender is closed
</para>
</remarks>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
<summary>
Translates a log4net level to a syslog severity.
</summary>
<param name="level">A log4net level.</param>
<returns>A syslog severity.</returns>
<remarks>
<para>
Translates a log4net level to a syslog severity.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
<summary>
Generate a syslog priority.
</summary>
<param name="facility">The syslog facility.</param>
<param name="severity">The syslog severity.</param>
<returns>A syslog priority.</returns>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
<summary>
The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
<summary>
The message identity
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
<summary>
Marshaled handle to the identity string. We have to hold on to the
string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
pointer to the ident and dereference it for each log message.
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
<summary>
Mapping from level object to syslog severity
</summary>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
<summary>
Open connection to system logger.
</summary>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
<summary>
Generate a log message.
</summary>
<remarks>
<para>
The libc syslog method takes a format string and a variable argument list similar
to the classic printf function. As this type of vararg list is not supported
by C# we need to specify the arguments explicitly. Here we have specified the
format string with a single message argument. The caller must set the format
string to <c>"%s"</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.LocalSyslogAppender.closelog">
<summary>
Close descriptor used to write to system logger.
</summary>
</member>
<member name="P:log4net.Appender.LocalSyslogAppender.Identity">
<summary>
Message identity
</summary>
<remarks>
<para>
An identifier is specified with each log message. This can be specified
by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
as the tag) must not contain white space. The default value for the
identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
</para>
</remarks>
</member>
<member name="P:log4net.Appender.LocalSyslogAppender.Facility">
<summary>
Syslog facility
</summary>
<remarks>
Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
facilities is predefined and cannot be extended. The default value
is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
</remarks>
</member>
<member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
<summary>
This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
<summary>
syslog severities
</summary>
<remarks>
<para>
The log4net Level maps to a syslog severity using the
<see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
<summary>
system is unusable
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
<summary>
action must be taken immediately
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
<summary>
critical conditions
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
<summary>
error conditions
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
<summary>
warning conditions
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
<summary>
normal but significant condition
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
<summary>
informational
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
<summary>
debug-level messages
</summary>
</member>
<member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
<summary>
syslog facilities
</summary>
<remarks>
<para>
The syslog facility defines which subsystem the logging comes from.
This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
<summary>
kernel messages
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
<summary>
random user-level messages
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
<summary>
mail system
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
<summary>
system daemons
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
<summary>
security/authorization messages
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
<summary>
messages generated internally by syslogd
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
<summary>
line printer subsystem
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
<summary>
network news subsystem
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
<summary>
UUCP subsystem
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
<summary>
clock (cron/at) daemon
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
<summary>
security/authorization messages (private)
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
<summary>
ftp daemon
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
<summary>
NTP subsystem
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
<summary>
log audit
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
<summary>
log alert
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
<summary>
clock daemon
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
<summary>
reserved for local use
</summary>
</member>
<member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
<summary>
A class to act as a mapping between the level that a logging call is made at and
the syslog severity that is should be logged at.
</summary>
<remarks>
<para>
A class to act as a mapping between the level that a logging call is made at and
the syslog severity that is should be logged at.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
<summary>
The mapped syslog severity for the specified level
</summary>
<remarks>
<para>
Required property.
The mapped syslog severity for the specified level
</para>
</remarks>
</member>
<member name="T:log4net.Appender.ManagedColoredConsoleAppender">
<summary>
Appends colorful logging events to the console, using the .NET 2
built-in capabilities.
</summary>
<remarks>
<para>
ManagedColoredConsoleAppender appends log events to the standard output stream
or the error output stream using a layout specified by the
user. It also allows the color of a specific type of message to be set.
</para>
<para>
By default, all output is written to the console's standard output stream.
The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> property can be set to direct the output to the
error stream.
</para>
<para>
When configuring the colored console appender, mappings should be
specified to map logging levels to colors. For example:
</para>
<code lang="XML" escaped="true">
<mapping>
<level value="ERROR"/>
<foreColor value="DarkRed"/>
<backColor value="White"/>
</mapping>
<mapping>
<level value="WARN"/>
<foreColor value="Yellow"/>
</mapping>
<mapping>
<level value="INFO"/>
<foreColor value="White"/>
</mapping>
<mapping>
<level value="DEBUG"/>
<foreColor value="Blue"/>
</mapping>
</code>
<para>
The Level is the standard log4net logging level while
ForeColor and BackColor are the values of <see cref="T:System.ConsoleColor"/>
enumeration.
</para>
<para>
Based on the ColoredConsoleAppender
</para>
</remarks>
<author>Rick Hobbs</author>
<author>Nicko Cadell</author>
<author>Pavlos Touboulidis</author>
</member>
<member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleOut">
<summary>
The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
standard output stream.
</summary>
<remarks>
<para>
The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
standard output stream.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleError">
<summary>
The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
standard error output stream.
</summary>
<remarks>
<para>
The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
standard error output stream.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ManagedColoredConsoleAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class.
</summary>
<remarks>
The instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class is set up to write
to the standard output stream.
</remarks>
</member>
<member name="M:log4net.Appender.ManagedColoredConsoleAppender.AddMapping(log4net.Appender.ManagedColoredConsoleAppender.LevelColors)">
<summary>
Add a mapping of level to color - done by the config file
</summary>
<param name="mapping">The mapping to add</param>
<remarks>
<para>
Add a <see cref="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"/> mapping to this appender.
Each mapping defines the foreground and background colors
for a level.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ManagedColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes the event to the console.
</para>
<para>
The format of the output will depend on the appender's layout.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.ManagedColoredConsoleAppender.ActivateOptions">
<summary>
Initialize the options for this appender
</summary>
<remarks>
<para>
Initialize the level to color mappings set on this appender.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_writeToErrorStream">
<summary>
Flag to write output to the error stream rather than the standard output stream
</summary>
</member>
<member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_levelMapping">
<summary>
Mapping from level object to color value
</summary>
</member>
<member name="P:log4net.Appender.ManagedColoredConsoleAppender.Target">
<summary>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</summary>
<value>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</value>
<remarks>
<para>
Target is the value of the console output stream.
This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ManagedColoredConsoleAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors">
<summary>
A class to act as a mapping between the level that a logging call is made at and
the color it should be displayed as.
</summary>
<remarks>
<para>
Defines the mapping between a level and the color it should be displayed in.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.ForeColor">
<summary>
The mapped foreground color for the specified level
</summary>
<remarks>
<para>
Required property.
The mapped foreground color for the specified level.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.BackColor">
<summary>
The mapped background color for the specified level
</summary>
<remarks>
<para>
Required property.
The mapped background color for the specified level.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.MemoryAppender">
<summary>
Stores logging events in an array.
</summary>
<remarks>
<para>
The memory appender stores all the logging events
that are appended in an in-memory array.
</para>
<para>
Use the <see cref="M:log4net.Appender.MemoryAppender.GetEvents"/> method to get
the current list of events that have been appended.
</para>
<para>
Use the <see cref="M:Clear()"/> method to clear the
current list of events.
</para>
</remarks>
<author>Julian Biddle</author>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Appender.MemoryAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.MemoryAppender.GetEvents">
<summary>
Gets the events that have been logged.
</summary>
<returns>The events that have been logged</returns>
<remarks>
<para>
Gets the events that have been logged.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">the event to log</param>
<remarks>
<para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
</remarks>
</member>
<member name="M:log4net.Appender.MemoryAppender.Clear">
<summary>
Clear the list of events
</summary>
<remarks>
Clear the list of events
</remarks>
</member>
<member name="F:log4net.Appender.MemoryAppender.m_eventsList">
<summary>
The list of events that have been appended.
</summary>
</member>
<member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
<summary>
Value indicating which fields in the event should be fixed
</summary>
<remarks>
By default all fields are fixed
</remarks>
</member>
<member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
<summary>
Gets or sets a value indicating whether only part of the logging event
data should be fixed.
</summary>
<value>
<c>true</c> if the appender should only fix part of the logging event
data, otherwise <c>false</c>. The default is <c>false</c>.
</value>
<remarks>
<para>
Setting this property to <c>true</c> will cause only part of the event
data to be fixed and stored in the appender, hereby improving performance.
</para>
<para>
See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.MemoryAppender.Fix">
<summary>
Gets or sets the fields that will be fixed in the event
</summary>
<remarks>
<para>
The logging event needs to have certain thread specific values
captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
for details.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.NetSendAppender">
<summary>
Logs entries by sending network messages using the
<see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/> native function.
</summary>
<remarks>
<para>
You can send messages only to names that are active
on the network. If you send the message to a user name,
that user must be logged on and running the Messenger
service to receive the message.
</para>
<para>
The receiver will get a top most window displaying the
messages one at a time, therefore this appender should
not be used to deliver a high volume of messages.
</para>
<para>
The following table lists some possible uses for this appender :
</para>
<para>
<list type="table">
<listheader>
<term>Action</term>
<description>Property Value(s)</description>
</listheader>
<item>
<term>Send a message to a user account on the local machine</term>
<description>
<para>
<see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of the local machine>
</para>
<para>
<see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <user name>
</para>
</description>
</item>
<item>
<term>Send a message to a user account on a remote machine</term>
<description>
<para>
<see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of the remote machine>
</para>
<para>
<see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <user name>
</para>
</description>
</item>
<item>
<term>Send a message to a domain user account</term>
<description>
<para>
<see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of a domain controller | uninitialized>
</para>
<para>
<see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <user name>
</para>
</description>
</item>
<item>
<term>Send a message to all the names in a workgroup or domain</term>
<description>
<para>
<see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <workgroup name | domain name>*
</para>
</description>
</item>
<item>
<term>Send a message from the local machine to a remote machine</term>
<description>
<para>
<see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of the local machine | uninitialized>
</para>
<para>
<see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <name of the remote machine>
</para>
</description>
</item>
</list>
</para>
<para>
<b>Note :</b> security restrictions apply for sending
network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/>
for more information.
</para>
</remarks>
<example>
<para>
An example configuration section to log information
using this appender from the local machine, named
LOCAL_PC, to machine OPERATOR_PC :
</para>
<code lang="XML" escaped="true">
<appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
<server value="LOCAL_PC"/>
<recipient value="OPERATOR_PC"/>
<layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n"/>
</appender>
</code>
</example>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Appender.NetSendAppender.m_server">
<summary>
The DNS or NetBIOS name of the server on which the function is to execute.
</summary>
</member>
<member name="F:log4net.Appender.NetSendAppender.m_sender">
<summary>
The sender of the network message.
</summary>
</member>
<member name="F:log4net.Appender.NetSendAppender.m_recipient">
<summary>
The message alias to which the message should be sent.
</summary>
</member>
<member name="F:log4net.Appender.NetSendAppender.m_securityContext">
<summary>
The security context to use for privileged calls
</summary>
</member>
<member name="M:log4net.Appender.NetSendAppender.#ctor">
<summary>
Initializes the appender.
</summary>
<remarks>
The default constructor initializes all fields to their default values.
</remarks>
</member>
<member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
<summary>
Initialize the appender based on the options set.
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
</para>
<para>
The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was specified.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was not specified.</exception>
</member>
<member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Sends the event using a network message.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
<summary>
Sends a buffer of information to a registered message alias.
</summary>
<param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
<param name="msgName">The message alias to which the message buffer should be sent</param>
<param name="fromName">The originator of the message.</param>
<param name="buffer">The message text.</param>
<param name="bufferSize">The length, in bytes, of the message text.</param>
<remarks>
<para>
The following restrictions apply for sending network messages:
</para>
<para>
<list type="table">
<listheader>
<term>Platform</term>
<description>Requirements</description>
</listheader>
<item>
<term>Windows NT</term>
<description>
<para>
No special group membership is required to send a network message.
</para>
<para>
Admin, Accounts, Print, or Server Operator group membership is required to
successfully send a network message on a remote server.
</para>
</description>
</item>
<item>
<term>Windows 2000 or later</term>
<description>
<para>
If you send a message on a domain controller that is running Active Directory,
access is allowed or denied based on the access control list (ACL) for the securable
object. The default ACL permits only Domain Admins and Account Operators to send a network message.
</para>
<para>
On a member server or workstation, only Administrators and Server Operators can send a network message.
</para>
</description>
</item>
</list>
</para>
<para>
For more information see <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/security_requirements_for_the_network_management_functions.asp">Security Requirements for the Network Management Functions</a>.
</para>
</remarks>
<returns>
<para>
If the function succeeds, the return value is zero.
</para>
</returns>
</member>
<member name="P:log4net.Appender.NetSendAppender.Sender">
<summary>
Gets or sets the sender of the message.
</summary>
<value>
The sender of the message.
</value>
<remarks>
If this property is not specified, the message is sent from the local computer.
</remarks>
</member>
<member name="P:log4net.Appender.NetSendAppender.Recipient">
<summary>
Gets or sets the message alias to which the message should be sent.
</summary>
<value>
The recipient of the message.
</value>
<remarks>
This property should always be specified in order to send a message.
</remarks>
</member>
<member name="P:log4net.Appender.NetSendAppender.Server">
<summary>
Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
</summary>
<value>
DNS or NetBIOS name of the remote server on which the function is to execute.
</value>
<remarks>
<para>
For Windows NT 4.0 and earlier, the string should begin with \\.
</para>
<para>
If this property is not specified, the local computer is used.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.NetSendAppender.SecurityContext">
<summary>
Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
</summary>
<value>
The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
</value>
<remarks>
<para>
Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
security context to use. The default behavior is to use the security context
of the current thread.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.OutputDebugStringAppender">
<summary>
Appends log events to the OutputDebugString system.
</summary>
<remarks>
<para>
OutputDebugStringAppender appends log events to the
OutputDebugString system.
</para>
<para>
The string is passed to the native <c>OutputDebugString</c>
function.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
<summary>
Write the logging event to the output debug string API
</summary>
<param name="loggingEvent">the event to log</param>
<remarks>
<para>
Write the logging event to the output debug string API
</para>
</remarks>
</member>
<member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
<summary>
Stub for OutputDebugString native method
</summary>
<param name="message">the string to output</param>
<remarks>
<para>
Stub for OutputDebugString native method
</para>
</remarks>
</member>
<member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.RemoteSyslogAppender">
<summary>
Logs events to a remote syslog daemon.
</summary>
<remarks>
<para>
The BSD syslog protocol is used to remotely log to
a syslog daemon. The syslogd listens for for messages
on UDP port 514.
</para>
<para>
The syslog UDP protocol is not authenticated. Most syslog daemons
do not accept remote log messages because of the security implications.
You may be able to use the LocalSyslogAppender to talk to a local
syslog service.
</para>
<para>
There is an RFC 3164 that claims to document the BSD Syslog Protocol.
This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
This appender generates what the RFC calls an "Original Device Message",
i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
this format of message will be accepted by all current syslog daemon
implementations. The daemon will attach the current time and the source
hostname or IP address to any messages received.
</para>
<para>
Syslog messages must have a facility and and a severity. The severity
is derived from the Level of the logging event.
The facility must be chosen from the set of defined syslog
<see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
and cannot be extended.
</para>
<para>
An identifier is specified with each log message. This can be specified
by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
as the tag) must not contain white space. The default value for the
identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
</para>
</remarks>
<author>Rob Lyon</author>
<author>Nicko Cadell</author>
</member>
<member name="T:log4net.Appender.UdpAppender">
<summary>
Sends logging events as connectionless UDP datagrams to a remote host or a
multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>.
</summary>
<remarks>
<para>
UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
</para>
<para>
To view the logging results, a custom application can be developed that listens for logging
events.
</para>
<para>
When decoding events send via this appender remember to use the same encoding
to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
property to specify the encoding to use.
</para>
</remarks>
<example>
This example shows how to log receive logging events that are sent
on IP address 244.0.0.1 and port 8080 to the console. The event is
encoded in the packet as a unicode string and it is decoded as such.
<code lang="C#">
IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
UdpClient udpClient;
byte[] buffer;
string loggingEvent;
try
{
udpClient = new UdpClient(8080);
while(true)
{
buffer = udpClient.Receive(ref remoteEndPoint);
loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
Console.WriteLine(loggingEvent);
}
}
catch(Exception e)
{
Console.WriteLine(e.ToString());
}
</code>
<code lang="Visual Basic">
Dim remoteEndPoint as IPEndPoint
Dim udpClient as UdpClient
Dim buffer as Byte()
Dim loggingEvent as String
Try
remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
udpClient = new UdpClient(8080)
While True
buffer = udpClient.Receive(ByRef remoteEndPoint)
loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
Console.WriteLine(loggingEvent)
Wend
Catch e As Exception
Console.WriteLine(e.ToString())
End Try
</code>
<para>
An example configuration section to log information using this appender to the
IP 224.0.0.1 on port 8080:
</para>
<code lang="XML" escaped="true">
<appender name="UdpAppender" type="log4net.Appender.UdpAppender">
<remoteAddress value="224.0.0.1"/>
<remotePort value="8080"/>
<layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/>
</appender>
</code>
</example>
<author>Gert Driesen</author>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Appender.UdpAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender"/> class.
</summary>
<remarks>
The default constructor initializes all fields to their default values.
</remarks>
</member>
<member name="M:log4net.Appender.UdpAppender.ActivateOptions">
<summary>
Initialize the appender based on the options set.
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
</para>
<para>
The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was specified or
an invalid remote or local TCP port number was specified.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was not specified.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The TCP port number assigned to <see cref="P:log4net.Appender.UdpAppender.LocalPort"/> or <see cref="P:log4net.Appender.UdpAppender.RemotePort"/> is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
</member>
<member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Sends the event using an UDP datagram.
</para>
<para>
Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.UdpAppender.OnClose">
<summary>
Closes the UDP connection and releases all resources associated with
this <see cref="T:log4net.Appender.UdpAppender"/> instance.
</summary>
<remarks>
<para>
Disables the underlying <see cref="T:System.Net.Sockets.UdpClient"/> and releases all managed
and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
<summary>
Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient"/> connection.
</summary>
<remarks>
<para>
The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
port number from which you intend to communicate.
</para>
<para>
Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
<summary>
The IP address of the remote host or multicast group to which
the logging event will be sent.
</summary>
</member>
<member name="F:log4net.Appender.UdpAppender.m_remotePort">
<summary>
The TCP port number of the remote host or multicast group to
which the logging event will be sent.
</summary>
</member>
<member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
<summary>
The cached remote endpoint to which the logging events will be sent.
</summary>
</member>
<member name="F:log4net.Appender.UdpAppender.m_localPort">
<summary>
The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
</summary>
</member>
<member name="F:log4net.Appender.UdpAppender.m_client">
<summary>
The <see cref="T:System.Net.Sockets.UdpClient"/> instance that will be used for sending the
logging events.
</summary>
</member>
<member name="F:log4net.Appender.UdpAppender.m_encoding">
<summary>
The encoding to use for the packet.
</summary>
</member>
<member name="P:log4net.Appender.UdpAppender.RemoteAddress">
<summary>
Gets or sets the IP address of the remote host or multicast group to which
the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
</summary>
<value>
The IP address of the remote host or multicast group to which the logging event
will be sent.
</value>
<remarks>
<para>
Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
239.255.255.255). Multicast packets can pass across different networks through routers, so
it is possible to use multicasts in an Internet scenario as long as your network provider
supports multicasting.
</para>
<para>
Hosts that want to receive particular multicast messages must register their interest by joining
the multicast group. Multicast messages are not sent to networks where no host has joined
the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
them from normal host addresses, allowing nodes to easily detect if a message is of interest.
</para>
<para>
Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
</para>
<para>
<list type="table">
<listheader>
<term>IP Address</term>
<description>Description</description>
</listheader>
<item>
<term>224.0.0.1</term>
<description>
<para>
Sends a message to all system on the subnet.
</para>
</description>
</item>
<item>
<term>224.0.0.2</term>
<description>
<para>
Sends a message to all routers on the subnet.
</para>
</description>
</item>
<item>
<term>224.0.0.12</term>
<description>
<para>
The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
</para>
</description>
</item>
</list>
</para>
<para>
A complete list of actually reserved multicast addresses and their owners in the ranges
defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
</para>
<para>
The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
addresses. These addresses can be reused with other local groups. Routers are typically
configured with filters to prevent multicast traffic in this range from flowing outside
of the local network.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.UdpAppender.RemotePort">
<summary>
Gets or sets the TCP port number of the remote host or multicast group to which
the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
</summary>
<value>
An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
indicating the TCP port number of the remote host or multicast group to which the logging event
will be sent.
</value>
<remarks>
The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will send messages to this TCP port number
on the remote host or multicast group.
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
</member>
<member name="P:log4net.Appender.UdpAppender.LocalPort">
<summary>
Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
</summary>
<value>
An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
</value>
<remarks>
<para>
The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will bind to this port for sending messages.
</para>
<para>
Setting the value to 0 (the default) will cause the udp client not to bind to
a local port.
</para>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
</member>
<member name="P:log4net.Appender.UdpAppender.Encoding">
<summary>
Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
</summary>
<value>
The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
</value>
<remarks>
<para>
The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.UdpAppender.Client">
<summary>
Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
</summary>
<value>
The underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
</value>
<remarks>
<see cref="T:log4net.Appender.UdpAppender"/> creates a <see cref="T:System.Net.Sockets.UdpClient"/> to send logging events
over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender"/> can use this
property to get or set this <see cref="T:System.Net.Sockets.UdpClient"/>. Use the underlying <see cref="T:System.Net.Sockets.UdpClient"/>
returned from <see cref="P:log4net.Appender.UdpAppender.Client"/> if you require access beyond that which
<see cref="T:log4net.Appender.UdpAppender"/> provides.
</remarks>
</member>
<member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
<summary>
Gets or sets the cached remote endpoint to which the logging events should be sent.
</summary>
<value>
The cached remote endpoint to which the logging events will be sent.
</value>
<remarks>
The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method will initialize the remote endpoint
with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
properties.
</remarks>
</member>
<member name="P:log4net.Appender.UdpAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
<summary>
Syslog port 514
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize">
<summary>
Initial buffer size
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity">
<summary>
Maximum buffer size before it is recycled
</summary>
</member>
<member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class.
</summary>
<remarks>
This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class is set up to write
to a remote syslog daemon.
</remarks>
</member>
<member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
<summary>
Add a mapping of level to severity
</summary>
<param name="mapping">The mapping to add</param>
<remarks>
<para>
Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
<summary>
This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes the event to a remote syslog daemon.
</para>
<para>
The format of the output will depend on the appender's layout.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
<summary>
Initialize the options for this appender
</summary>
<remarks>
<para>
Initialize the level to syslog severity mappings set on this appender.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
<summary>
Translates a log4net level to a syslog severity.
</summary>
<param name="level">A log4net level.</param>
<returns>A syslog severity.</returns>
<remarks>
<para>
Translates a log4net level to a syslog severity.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
<summary>
Generate a syslog priority.
</summary>
<param name="facility">The syslog facility.</param>
<param name="severity">The syslog severity.</param>
<returns>A syslog priority.</returns>
<remarks>
<para>
Generate a syslog priority.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
<summary>
The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
<summary>
The message identity
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
<summary>
Mapping from level object to syslog severity
</summary>
</member>
<member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
<summary>
Message identity
</summary>
<remarks>
<para>
An identifier is specified with each log message. This can be specified
by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
as the tag) must not contain white space. The default value for the
identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
</para>
</remarks>
</member>
<member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
<summary>
Syslog facility
</summary>
<remarks>
Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
facilities is predefined and cannot be extended. The default value
is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
</remarks>
</member>
<member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
<summary>
syslog severities
</summary>
<remarks>
<para>
The syslog severities.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
<summary>
system is unusable
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
<summary>
action must be taken immediately
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
<summary>
critical conditions
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
<summary>
error conditions
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
<summary>
warning conditions
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
<summary>
normal but significant condition
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
<summary>
informational
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
<summary>
debug-level messages
</summary>
</member>
<member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
<summary>
syslog facilities
</summary>
<remarks>
<para>
The syslog facilities
</para>
</remarks>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
<summary>
kernel messages
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
<summary>
random user-level messages
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
<summary>
mail system
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
<summary>
system daemons
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
<summary>
security/authorization messages
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
<summary>
messages generated internally by syslogd
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
<summary>
line printer subsystem
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
<summary>
network news subsystem
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
<summary>
UUCP subsystem
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
<summary>
clock (cron/at) daemon
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
<summary>
security/authorization messages (private)
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
<summary>
ftp daemon
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
<summary>
NTP subsystem
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
<summary>
log audit
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
<summary>
log alert
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
<summary>
clock daemon
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
<summary>
reserved for local use
</summary>
</member>
<member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
<summary>
reserved for local use
</summary>
</member>
<member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
<summary>
A class to act as a mapping between the level that a logging call is made at and
the syslog severity that is should be logged at.
</summary>
<remarks>
<para>
A class to act as a mapping between the level that a logging call is made at and
the syslog severity that is should be logged at.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
<summary>
The mapped syslog severity for the specified level
</summary>
<remarks>
<para>
Required property.
The mapped syslog severity for the specified level
</para>
</remarks>
</member>
<member name="T:log4net.Appender.RemotingAppender">
<summary>
Delivers logging events to a remote logging sink.
</summary>
<remarks>
<para>
This Appender is designed to deliver events to a remote sink.
That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
interface. It delivers the events using .NET remoting. The
object to deliver events to is specified by setting the
appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para>
<para>
The RemotingAppender buffers events before sending them. This allows it to
make more efficient use of the remoting infrastructure.</para>
<para>
Once the buffer is full the events are still not sent immediately.
They are scheduled to be sent using a pool thread. The effect is that
the send occurs asynchronously. This is very important for a
number of non obvious reasons. The remoting infrastructure will
flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
remoting boundary. If the server is not contactable then
the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
having side effects on the calling application the remoting call must be made
from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
the events will block in the thread pool manager until a thread is available.</para>
<para>
Because the events are sent asynchronously using pool threads it is possible to close
this appender before all the queued events have been sent.
When closing the appender attempts to wait until all the queued events have been sent, but
this will timeout after 30 seconds regardless.</para>
<para>
If this appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
event has fired it may not be possible to send all the queued events. During process
exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
event handler is allowed to run for. If the runtime terminates the threads before
the queued events have been sent then they will be lost. To ensure that all events
are sent the appender must be closed before the application exits. See
<see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown
log4net programmatically.</para>
</remarks>
<seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Daniel Cazzulino</author>
</member>
<member name="M:log4net.Appender.RemotingAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RemotingAppender.ActivateOptions">
<summary>
Initialize the appender based on the options set
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
<summary>
Send the contents of the buffer to the remote sink.
</summary>
<remarks>
The events are not sent immediately. They are scheduled to be sent
using a pool thread. The effect is that the send occurs asynchronously.
This is very important for a number of non obvious reasons. The remoting
infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
remoting boundary. If the server is not contactable then
the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
having side effects on the calling application the remoting call must be made
from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
the events will block in the thread pool manager until a thread is available.
</remarks>
<param name="events">The events to send.</param>
</member>
<member name="M:log4net.Appender.RemotingAppender.OnClose">
<summary>
Override base class close.
</summary>
<remarks>
<para>
This method waits while there are queued work items. The events are
sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items
will be sent once a thread pool thread is available to send them, therefore
it is possible to close the appender before all the queued events have been
sent.</para>
<para>
This method attempts to wait until all the queued events have been sent, but this
method will timeout after 30 seconds regardless.</para>
<para>
If the appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/>
event has fired it may not be possible to send all the queued events. During process
exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/>
event handler is allowed to run for.</para>
</remarks>
</member>
<member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend">
<summary>
A work item is being queued into the thread pool
</summary>
</member>
<member name="M:log4net.Appender.RemotingAppender.EndAsyncSend">
<summary>
A work item from the thread pool has completed
</summary>
</member>
<member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)">
<summary>
Send the contents of the buffer to the remote sink.
</summary>
<remarks>
This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>.
This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/>
objects in the state param.
</remarks>
<param name="state">the logging events to send</param>
</member>
<member name="F:log4net.Appender.RemotingAppender.m_sinkUrl">
<summary>
The URL of the remote sink.
</summary>
</member>
<member name="F:log4net.Appender.RemotingAppender.m_sinkObj">
<summary>
The local proxy (.NET remoting) for the remote logging sink.
</summary>
</member>
<member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount">
<summary>
The number of queued callbacks currently waiting or executing
</summary>
</member>
<member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent">
<summary>
Event used to signal when there are no queued work items
</summary>
<remarks>
This event is set when there are no queued work items. In this
state it is safe to close the appender.
</remarks>
</member>
<member name="P:log4net.Appender.RemotingAppender.Sink">
<summary>
Gets or sets the URL of the well-known object that will accept
the logging events.
</summary>
<value>
The well-known URL of the remote sink.
</value>
<remarks>
<para>
The URL of the remoting sink that will accept logging events.
The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
interface.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink">
<summary>
Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
</summary>
<remarks>
This interface must be implemented by a remoting sink
if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used
to deliver logging events to the sink.
</remarks>
</member>
<member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])">
<summary>
Delivers logging events to the remote sink
</summary>
<param name="events">Array of events to log.</param>
<remarks>
<para>
Delivers logging events to the remote sink
</para>
</remarks>
</member>
<member name="T:log4net.Appender.RollingFileAppender">
<summary>
Appender that rolls log files based on size or date or both.
</summary>
<remarks>
<para>
RollingFileAppender can roll log files based on size or date or both
depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
is crossed.
When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
is crossed, but within a date boundary the file will also be rolled
once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
the appender is configured. This effectively means that the log file can be
rolled once per program execution.
</para>
<para>
A of few additional optional features have been added:
<list type="bullet">
<item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
<item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
<item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
</list>
</para>
<note>
<para>
For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
greater than zero is highly recommended, otherwise all the backup files need
to be renamed each time a new backup is created.
</para>
<para>
When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
to <see langword="true"/> will reduce the number of file renamings to few or none.
</para>
</note>
<note type="caution">
<para>
Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
the log file directory of backup files will cause unexpected and unwanted side effects.
</para>
</note>
<para>
If Date/Time based rolling is enabled this appender will attempt to roll existing files
in the directory without a Date/Time tag based on the last write date of the base log file.
The appender only rolls the log file when a message is logged. If Date/Time based rolling
is enabled then the appender will not roll the log file at the Date/Time boundary but
at the point when the next message is logged after the boundary has been crossed.
</para>
<para>
The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
has the same behavior when opening the log file.
The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
is called. This will typically be during configuration.
If the file cannot be opened for writing the appender will attempt
to open the file again each time a message is logged to the appender.
If the file cannot be opened for writing when a message is logged then
the message will be discarded by this appender.
</para>
<para>
When rolling a backup file necessitates deleting an older backup file the
file to be deleted is moved to a temporary name before being deleted.
</para>
<note type="caution">
<para>
A maximum number of backup files when rolling on date/time boundaries is not supported.
</para>
</note>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Aspi Havewala</author>
<author>Douglas de la Torre</author>
<author>Edward Smit</author>
</member>
<member name="M:log4net.Appender.RollingFileAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.RollingFileAppender.declaringType">
<summary>
The fully qualified type of the RollingFileAppender class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
<summary>
Sets the quiet writer being used.
</summary>
<remarks>
This method can be overridden by sub classes.
</remarks>
<param name="writer">the writer to set</param>
</member>
<member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
<summary>
Write out a logging event.
</summary>
<param name="loggingEvent">the event to write to file.</param>
<remarks>
<para>
Handles append time behavior for RollingFileAppender. This checks
if a roll over either by date (checked first) or time (checked second)
is need and then appends to the file last.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
<summary>
Write out an array of logging events.
</summary>
<param name="loggingEvents">the events to write to file.</param>
<remarks>
<para>
Handles append time behavior for RollingFileAppender. This checks
if a roll over either by date (checked first) or time (checked second)
is need and then appends to the file last.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
<summary>
Performs any required rolling before outputting the next event
</summary>
<remarks>
<para>
Handles append time behavior for RollingFileAppender. This checks
if a roll over either by date (checked first) or time (checked second)
is need and then appends to the file last.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
<summary>
Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
is false then the fully qualified name is determined and used.
</summary>
<param name="fileName">the name of the file to open</param>
<param name="append">true to append to existing file</param>
<remarks>
<para>This method will ensure that the directory structure
for the <paramref name="fileName"/> specified exists.</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
<summary>
Get the current output file name
</summary>
<param name="fileName">the base file name</param>
<returns>the output file name</returns>
<remarks>
The output file name is based on the base fileName specified.
If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
file name is the same as the base file passed in. Otherwise
the output file depends on the date pattern, on the count
direction or both.
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
<summary>
Determines curSizeRollBackups (only within the current roll point)
</summary>
</member>
<member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
<summary>
Generates a wildcard pattern that can be used to find all files
that are similar to the base file name.
</summary>
<param name="baseFileName"></param>
<returns></returns>
</member>
<member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
<summary>
Builds a list of filenames for all files matching the base filename plus a file
pattern.
</summary>
<param name="baseFilePath"></param>
<returns></returns>
</member>
<member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
<summary>
Initiates a roll over if needed for crossing a date boundary since the last run.
</summary>
</member>
<member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
<summary>
Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
</summary>
<remarks>
<para>
Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
The following is done
<list type="bullet">
<item>determine curSizeRollBackups (only within the current roll point)</item>
<item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
</list>
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
<summary>
Does the work of bumping the 'current' file counter higher
to the highest count when an incremental file name is seen.
The highest count is either the first file (when count direction
is greater than 0) or the last file (when count direction less than 0).
In either case, we want to know the highest count that is present.
</summary>
<param name="baseFile"></param>
<param name="curFileName"></param>
</member>
<member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)">
<summary>
Attempts to extract a number from the end of the file name that indicates
the number of the times the file has been rolled over.
</summary>
<remarks>
Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
</remarks>
<param name="curFileName"></param>
<returns></returns>
</member>
<member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
<summary>
Takes a list of files and a base file name, and looks for
'incremented' versions of the base file. Bumps the max
count up to the highest count seen.
</summary>
<param name="baseFile"></param>
<param name="arrayFiles"></param>
</member>
<member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
<summary>
Calculates the RollPoint for the datePattern supplied.
</summary>
<param name="datePattern">the date pattern to calculate the check period for</param>
<returns>The RollPoint that is most accurate for the date pattern supplied</returns>
<remarks>
Essentially the date pattern is examined to determine what the
most suitable roll point is. The roll point chosen is the roll point
with the smallest period that can be detected using the date pattern
supplied. i.e. if the date pattern only outputs the year, month, day
and hour then the smallest roll point that can be detected would be
and hourly roll point as minutes could not be detected.
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
<summary>
Initialize the appender based on the options set
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
</para>
<para>
Sets initial conditions including date/time roll over information, first check,
scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
the current number of backups.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)">
<summary>
</summary>
<param name="path1"></param>
<param name="path2">.1, .2, .3, etc.</param>
<returns></returns>
</member>
<member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
<summary>
Rollover the file(s) to date/time tagged file(s).
</summary>
<param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
<remarks>
<para>
Rollover the file(s) to date/time tagged file(s).
Resets curSizeRollBackups.
If fileIsOpen is set then the new file is opened (through SafeOpenFile).
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
<summary>
Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
</summary>
<param name="fromFile">Name of existing file to roll.</param>
<param name="toFile">New name for file.</param>
<remarks>
<para>
Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
also checks for existence of target file and deletes if it does.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
<summary>
Test if a file exists at a specified path
</summary>
<param name="path">the path to the file</param>
<returns>true if the file exists</returns>
<remarks>
<para>
Test if a file exists at a specified path
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
<summary>
Deletes the specified file if it exists.
</summary>
<param name="fileName">The file to delete.</param>
<remarks>
<para>
Delete a file if is exists.
The file is first moved to a new filename then deleted.
This allows the file to be removed even when it cannot
be deleted, but it still can be moved.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
<summary>
Implements file roll base on file size.
</summary>
<remarks>
<para>
If the maximum number of size based backups is reached
(<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
file is deleted -- its index determined by the sign of countDirection.
If <c>countDirection</c> < 0, then files
{<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
are renamed to {<c>File.2</c>, ...,
<c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
renamed <c>File.1</c> and closed.
</para>
<para>
A new file is created to receive further log output.
</para>
<para>
If <c>maxSizeRollBackups</c> is equal to zero, then the
<c>File</c> is truncated with no backup files created.
</para>
<para>
If <c>maxSizeRollBackups</c> < 0, then <c>File</c> is
renamed if needed and no files are deleted.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
<summary>
Implements file roll.
</summary>
<param name="baseFileName">the base name to rename</param>
<remarks>
<para>
If the maximum number of size based backups is reached
(<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
file is deleted -- its index determined by the sign of countDirection.
If <c>countDirection</c> < 0, then files
{<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
are renamed to {<c>File.2</c>, ...,
<c>File.curSizeRollBackups</c>}.
</para>
<para>
If <c>maxSizeRollBackups</c> is equal to zero, then the
<c>File</c> is truncated with no backup files created.
</para>
<para>
If <c>maxSizeRollBackups</c> < 0, then <c>File</c> is
renamed if needed and no files are deleted.
</para>
<para>
This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
<summary>
Get the start time of the next window for the current rollpoint
</summary>
<param name="currentDateTime">the current date</param>
<param name="rollPoint">the type of roll point we are working with</param>
<returns>the start time for the next roll point an interval after the currentDateTime date</returns>
<remarks>
<para>
Returns the date of the next roll point after the currentDateTime date passed to the method.
</para>
<para>
The basic strategy is to subtract the time parts that are less significant
than the rollpoint from the current time. This should roll the time back to
the start of the time window for the current rollpoint. Then we add 1 window
worth of time and get the start time of the next window for the rollpoint.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
<summary>
This object supplies the current date/time. Allows test code to plug in
a method to control this class when testing date/time based rolling. The default
implementation uses the underlying value of DateTime.Now.
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
<summary>
The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
meaning daily rollover.
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
<summary>
The actual formatted filename that is currently being written to
or will be the file transferred to on roll over
(based on staticLogFileName).
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
<summary>
The timestamp when we shall next recompute the filename.
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_now">
<summary>
Holds date of last roll over
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
<summary>
The type of rolling done
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
<summary>
The default maximum file size is 10MB
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
<summary>
There is zero backup files by default
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
<summary>
How many sized based backups have been made so far
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
<summary>
The rolling file count direction.
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
<summary>
The rolling mode used in this appender.
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
<summary>
Cache flag set if we are rolling by date.
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
<summary>
Cache flag set if we are rolling by size.
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
<summary>
Value indicating whether to always log to the same file.
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension">
<summary>
Value indicating whether to preserve the file name extension when rolling.
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
<summary>
FileName provided in configuration. Used for rolling properly
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.s_date1970">
<summary>
The 1st of January 1970 in UTC
</summary>
</member>
<member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy">
<summary>
Gets or sets the strategy for determining the current date and time. The default
implementation is to use LocalDateTime which internally calls through to DateTime.Now.
DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying
<see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
</summary>
<value>
An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time.
</value>
<remarks>
<para>
Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time.
</para>
<para>
There are two built strategies for determining the current date and time,
<see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>
and <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
</para>
<para>
The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.RollingFileAppender.DatePattern">
<summary>
Gets or sets the date pattern to be used for generating file names
when rolling over on date.
</summary>
<value>
The date pattern to be used for generating file names when rolling
over on date.
</value>
<remarks>
<para>
Takes a string in the same format as expected by
<see cref="T:log4net.DateFormatter.SimpleDateFormatter"/>.
</para>
<para>
This property determines the rollover schedule when rolling over
on date.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
<summary>
Gets or sets the maximum number of backup files that are kept before
the oldest is erased.
</summary>
<value>
The maximum number of backup files that are kept before the oldest is
erased.
</value>
<remarks>
<para>
If set to zero, then there will be no backup files and the log file
will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
</para>
<para>
If a negative number is supplied then no deletions will be made. Note
that this could result in very slow performance as a large number of
files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
</para>
<para>
The maximum applies to <b>each</b> time based group of files and
<b>not</b> the total.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
<summary>
Gets or sets the maximum size that the output file is allowed to reach
before being rolled over to backup files.
</summary>
<value>
The maximum size in bytes that the output file is allowed to reach before being
rolled over to backup files.
</value>
<remarks>
<para>
This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
that it is required for differentiating the setter taking a
<see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
argument.
</para>
<para>
The default maximum file size is 10MB (10*1024*1024).
</para>
</remarks>
</member>
<member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
<summary>
Gets or sets the maximum size that the output file is allowed to reach
before being rolled over to backup files.
</summary>
<value>
The maximum size that the output file is allowed to reach before being
rolled over to backup files.
</value>
<remarks>
<para>
This property allows you to specify the maximum size with the
suffixes "KB", "MB" or "GB" so that the size is interpreted being
expressed respectively in kilobytes, megabytes or gigabytes.
</para>
<para>
For example, the value "10KB" will be interpreted as 10240 bytes.
</para>
<para>
The default maximum file size is 10MB.
</para>
<para>
If you have the option to set the maximum file size programmatically
consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.RollingFileAppender.CountDirection">
<summary>
Gets or sets the rolling file count direction.
</summary>
<value>
The rolling file count direction.
</value>
<remarks>
<para>
Indicates if the current file is the lowest numbered file or the
highest numbered file.
</para>
<para>
By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> < 0),
i.e. log.1 is most recent, log.5 is the 5th backup, etc...
</para>
<para>
<see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> >= 0 does the opposite i.e.
log.1 is the first backup made, log.5 is the 5th backup made, etc.
For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> >= 0 to reduce
rollover costs.
</para>
<para>The default file count direction is -1.</para>
</remarks>
</member>
<member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
<summary>
Gets or sets the rolling style.
</summary>
<value>The rolling style.</value>
<remarks>
<para>
The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/>.
</para>
<para>
When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
<see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
the appender would append to a single file rather than rolling
the file each time it is opened.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension">
<summary>
Gets or sets a value indicating whether to preserve the file name extension when rolling.
</summary>
<value>
<c>true</c> if the file name extension should be preserved.
</value>
<remarks>
<para>
By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
However, under Windows the new file name will loose any program associations as the
extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
file.curSizeRollBackup.log to maintain any program associations.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
<summary>
Gets or sets a value indicating whether to always log to
the same file.
</summary>
<value>
<c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
</value>
<remarks>
<para>
By default file.log is always the current file. Optionally
file.log.yyyy-mm-dd for current formatted datePattern can by the currently
logging file (or file.log.curSizeRollBackup or even
file.log.yyyy-mm-dd.curSizeRollBackup).
</para>
<para>
This will make time based rollovers with a large number of backups
much faster as the appender it won't have to rename all the backups!
</para>
</remarks>
</member>
<member name="T:log4net.Appender.RollingFileAppender.RollingMode">
<summary>
Style of rolling to use
</summary>
<remarks>
<para>
Style of rolling to use
</para>
</remarks>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
<summary>
Roll files once per program execution
</summary>
<remarks>
<para>
Roll files once per program execution.
Well really once each time this appender is
configured.
</para>
<para>
Setting this option also sets <c>AppendToFile</c> to
<c>false</c> on the <c>RollingFileAppender</c>, otherwise
this appender would just be a normal file appender.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
<summary>
Roll files based only on the size of the file
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
<summary>
Roll files based only on the date
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
<summary>
Roll files based on both the size and date of the file
</summary>
</member>
<member name="T:log4net.Appender.RollingFileAppender.RollPoint">
<summary>
The code assumes that the following 'time' constants are in a increasing sequence.
</summary>
<remarks>
<para>
The code assumes that the following 'time' constants are in a increasing sequence.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
<summary>
Roll the log not based on the date
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
<summary>
Roll the log for each minute
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
<summary>
Roll the log for each hour
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
<summary>
Roll the log twice a day (midday and midnight)
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
<summary>
Roll the log each day (midnight)
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
<summary>
Roll the log each week
</summary>
</member>
<member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
<summary>
Roll the log each month
</summary>
</member>
<member name="T:log4net.Appender.RollingFileAppender.IDateTime">
<summary>
This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
</summary>
<remarks>
This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
Used primarily to allow test classes to plug themselves in so they can
supply test date/times.
</remarks>
</member>
<member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
<summary>
Gets the <i>current</i> time.
</summary>
<value>The <i>current</i> time.</value>
<remarks>
<para>
Gets the <i>current</i> time.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.RollingFileAppender.LocalDateTime">
<summary>
Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
</summary>
</member>
<member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now">
<summary>
Gets the <b>current</b> time.
</summary>
<value>The <b>current</b> time.</value>
<remarks>
<para>
Gets the <b>current</b> time.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.RollingFileAppender.UniversalDateTime">
<summary>
Implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time as the coordinated universal time (UTC).
</summary>
</member>
<member name="P:log4net.Appender.RollingFileAppender.UniversalDateTime.Now">
<summary>
Gets the <b>current</b> time.
</summary>
<value>The <b>current</b> time.</value>
<remarks>
<para>
Gets the <b>current</b> time.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.SmtpAppender">
<summary>
Send an e-mail when a specific logging event occurs, typically on errors
or fatal errors.
</summary>
<remarks>
<para>
The number of logging events delivered in this e-mail depend on
the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
<see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
cyclic buffer. This keeps memory requirements at a reasonable level while
still delivering useful application context.
</para>
<note type="caution">
Authentication and setting the server Port are only available on the MS .NET 1.1 runtime.
For these features to be enabled you need to ensure that you are using a version of
the log4net assembly that is built against the MS .NET 1.1 framework and that you are
running the your application on the MS .NET 1.1 runtime. On all other platforms only sending
unauthenticated messages to a server listening on port 25 (the default) is supported.
</note>
<para>
Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to
either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set.
</para>
<para>
To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Appender.SmtpAppender.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Default constructor
</para>
</remarks>
</member>
<member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])">
<summary>
Sends the contents of the cyclic buffer as an e-mail message.
</summary>
<param name="events">The logging events to send.</param>
</member>
<member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)">
<summary>
Send the email message
</summary>
<param name="messageBody">the body text to include in the mail</param>
</member>
<member name="P:log4net.Appender.SmtpAppender.To">
<summary>
Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions).
</summary>
<value>
<para>
For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
</para>
<para>
For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
</para>
</value>
<remarks>
<para>
For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
</para>
<para>
For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.Cc">
<summary>
Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses
that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions).
</summary>
<value>
<para>
For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
</para>
<para>
For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
</para>
</value>
<remarks>
<para>
For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
</para>
<para>
For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.Bcc">
<summary>
Gets or sets a semicolon-delimited list of recipient e-mail addresses
that will be blind carbon copied.
</summary>
<value>
A semicolon-delimited list of e-mail addresses.
</value>
<remarks>
<para>
A semicolon-delimited list of recipient e-mail addresses.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.From">
<summary>
Gets or sets the e-mail address of the sender.
</summary>
<value>
The e-mail address of the sender.
</value>
<remarks>
<para>
The e-mail address of the sender.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.Subject">
<summary>
Gets or sets the subject line of the e-mail message.
</summary>
<value>
The subject line of the e-mail message.
</value>
<remarks>
<para>
The subject line of the e-mail message.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.SmtpHost">
<summary>
Gets or sets the name of the SMTP relay mail server to use to send
the e-mail messages.
</summary>
<value>
The name of the e-mail relay server. If SmtpServer is not set, the
name of the local SMTP server is used.
</value>
<remarks>
<para>
The name of the e-mail relay server. If SmtpServer is not set, the
name of the local SMTP server is used.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.LocationInfo">
<summary>
Obsolete
</summary>
<remarks>
Use the BufferingAppenderSkeleton Fix methods instead
</remarks>
<remarks>
<para>
Obsolete property.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.Authentication">
<summary>
The mode to use to authentication with the SMTP server
</summary>
<remarks>
<note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
<para>
Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>,
<see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using
<see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate.
When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current
thread, if impersonating, or the process will be used to authenticate.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.Username">
<summary>
The username to use to authenticate with the SMTP server
</summary>
<remarks>
<note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
<para>
A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
<see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
otherwise the username will be ignored.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.Password">
<summary>
The password to use to authenticate with the SMTP server
</summary>
<remarks>
<note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
<para>
A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
<see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
otherwise the password will be ignored.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.Port">
<summary>
The port on which the SMTP server is listening
</summary>
<remarks>
<note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note>
<para>
The port on which the SMTP server is listening. The default
port is <c>25</c>. The Port can only be changed when running on
the MS .NET 1.1 runtime.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.Priority">
<summary>
Gets or sets the priority of the e-mail message
</summary>
<value>
One of the <see cref="T:System.Net.Mail.MailPriority"/> values.
</value>
<remarks>
<para>
Sets the priority of the e-mails generated by this
appender. The default priority is <see cref="F:System.Net.Mail.MailPriority.Normal"/>.
</para>
<para>
If you are using this appender to report errors then
you may want to set the priority to <see cref="F:System.Net.Mail.MailPriority.High"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.EnableSsl">
<summary>
Enable or disable use of SSL when sending e-mail message
</summary>
<remarks>
This is available on MS .NET 2.0 runtime and higher
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.ReplyTo">
<summary>
Gets or sets the reply-to e-mail address.
</summary>
<remarks>
This is available on MS .NET 2.0 runtime and higher
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.SubjectEncoding">
<summary>
Gets or sets the subject encoding to be used.
</summary>
<remarks>
The default encoding is the operating system's current ANSI codepage.
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.BodyEncoding">
<summary>
Gets or sets the body encoding to be used.
</summary>
<remarks>
The default encoding is the operating system's current ANSI codepage.
</remarks>
</member>
<member name="P:log4net.Appender.SmtpAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication">
<summary>
Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property.
</summary>
<remarks>
<para>
SMTP authentication modes.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None">
<summary>
No authentication
</summary>
</member>
<member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic">
<summary>
Basic authentication.
</summary>
<remarks>
Requires a username and password to be supplied
</remarks>
</member>
<member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm">
<summary>
Integrated authentication
</summary>
<remarks>
Uses the Windows credentials from the current thread or process to authenticate.
</remarks>
</member>
<member name="T:log4net.Appender.SmtpPickupDirAppender">
<summary>
Send an email when a specific logging event occurs, typically on errors
or fatal errors. Rather than sending via smtp it writes a file into the
directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
as the IIS SMTP agent to manage sending the messages.
</summary>
<remarks>
<para>
The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
<see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
</para>
<para>
The number of logging events delivered in this e-mail depend on
the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
<see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
<see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
cyclic buffer. This keeps memory requirements at a reasonable level while
still delivering useful application context.
</para>
</remarks>
<author>Niall Daley</author>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Default constructor
</para>
</remarks>
</member>
<member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
<summary>
Sends the contents of the cyclic buffer as an e-mail message.
</summary>
<param name="events">The logging events to send.</param>
<remarks>
<para>
Sends the contents of the cyclic buffer as an e-mail message.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
<summary>
Activate the options on this appender.
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
<summary>
Convert a path into a fully qualified path.
</summary>
<param name="path">The path to convert.</param>
<returns>The fully qualified path.</returns>
<remarks>
<para>
Converts the path specified to a fully
qualified path. If the path is relative it is
taken as relative from the application base
directory.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
<summary>
The security context to use for privileged calls
</summary>
</member>
<member name="P:log4net.Appender.SmtpPickupDirAppender.To">
<summary>
Gets or sets a semicolon-delimited list of recipient e-mail addresses.
</summary>
<value>
A semicolon-delimited list of e-mail addresses.
</value>
<remarks>
<para>
A semicolon-delimited list of e-mail addresses.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpPickupDirAppender.From">
<summary>
Gets or sets the e-mail address of the sender.
</summary>
<value>
The e-mail address of the sender.
</value>
<remarks>
<para>
The e-mail address of the sender.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
<summary>
Gets or sets the subject line of the e-mail message.
</summary>
<value>
The subject line of the e-mail message.
</value>
<remarks>
<para>
The subject line of the e-mail message.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
<summary>
Gets or sets the path to write the messages to.
</summary>
<remarks>
<para>
Gets or sets the path to write the messages to. This should be the same
as that used by the agent sending the messages.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
<summary>
Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
</summary>
<value>
The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
</value>
<remarks>
<para>
Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
security context to use. The default behavior is to use the security context
of the current thread.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.TelnetAppender">
<summary>
Appender that allows clients to connect via Telnet to receive log messages
</summary>
<remarks>
<para>
The TelnetAppender accepts socket connections and streams logging messages
back to the client.
The output is provided in a telnet-friendly way so that a log can be monitored
over a TCP/IP socket.
This allows simple remote monitoring of application logging.
</para>
<para>
The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
</para>
</remarks>
<author>Keith Long</author>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Appender.TelnetAppender.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Default constructor
</para>
</remarks>
</member>
<member name="F:log4net.Appender.TelnetAppender.declaringType">
<summary>
The fully qualified type of the TelnetAppender class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.OnClose">
<summary>
Overrides the parent method to close the socket handler
</summary>
<remarks>
<para>
Closes all the outstanding connections.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
<summary>
Initialize the appender based on the options set.
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
</para>
<para>
Create the socket handler and wait for connections
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
<summary>
Writes the logging event to each connected client.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes the logging event to each connected client.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.TelnetAppender.Port">
<summary>
Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
</summary>
<value>
An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
</value>
<remarks>
<para>
The default value is 23 (the telnet port).
</para>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/>
or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
</member>
<member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.TelnetAppender.SocketHandler">
<summary>
Helper class to manage connected clients
</summary>
<remarks>
<para>
The SocketHandler class is used to accept connections from
clients. It is threaded so that clients can connect/disconnect
asynchronously.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
<summary>
Opens a new server port on <paramref ref="port"/>
</summary>
<param name="port">the local port to listen on for connections</param>
<remarks>
<para>
Creates a socket handler on the specified local server port.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
<summary>
Sends a string message to each of the connected clients
</summary>
<param name="message">the text to send</param>
<remarks>
<para>
Sends a string message to each of the connected clients
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
<summary>
Add a client to the internal clients list
</summary>
<param name="client">client to add</param>
</member>
<member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
<summary>
Remove a client from the internal clients list
</summary>
<param name="client">client to remove</param>
</member>
<member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)">
<summary>
Callback used to accept a connection on the server socket
</summary>
<param name="asyncResult">The result of the asynchronous operation</param>
<remarks>
<para>
On connection adds to the list of connections
if there are two many open connections you will be disconnected
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
<summary>
Close all network connections
</summary>
<remarks>
<para>
Make sure we close all network connections
</para>
</remarks>
</member>
<member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
<summary>
Test if this handler has active connections
</summary>
<value>
<c>true</c> if this handler has active connections
</value>
<remarks>
<para>
This property will be <c>true</c> while this handler has
active connections, that is at least one connection that
the handler will attempt to send a message to.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
<summary>
Class that represents a client connected to this handler
</summary>
<remarks>
<para>
Class that represents a client connected to this handler
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
<summary>
Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
</summary>
<param name="socket">the client's socket</param>
<remarks>
<para>
Opens a stream writer on the socket.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
<summary>
Write a string to the client
</summary>
<param name="message">string to send</param>
<remarks>
<para>
Write a string to the client
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
<summary>
Cleanup the clients connection
</summary>
<remarks>
<para>
Close the socket connection.
</para>
</remarks>
</member>
<member name="T:log4net.Appender.TraceAppender">
<summary>
Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
</summary>
<remarks>
<para>
The application configuration file can be used to control what listeners
are actually used. See the MSDN documentation for the
<see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
trace system.
</para>
<para>
Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
method. The event's logger name is the default value for the category parameter
of the Write method.
</para>
<para>
<b>Compact Framework</b><br/>
The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
class for any operation except <c>Assert</c>. When using the Compact Framework this
appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
</para>
</remarks>
<author>Douglas de la Torre</author>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Ron Grabowski</author>
</member>
<member name="M:log4net.Appender.TraceAppender.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>
with a specified layout.
</summary>
<param name="layout">The layout to use with this appender.</param>
<remarks>
<para>
Obsolete constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
<summary>
Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
</para>
</remarks>
</member>
<member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
<summary>
Immediate flush means that the underlying writer or output stream
will be flushed at the end of each append operation.
</summary>
<remarks>
<para>
Immediate flush is slower but ensures that each append request is
actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
<c>false</c>, then there is a good chance that the last few
logs events are not actually written to persistent media if and
when the application crashes.
</para>
<para>
The default value is <c>true</c>.</para>
</remarks>
</member>
<member name="F:log4net.Appender.TraceAppender.m_category">
<summary>
Defaults to %logger
</summary>
</member>
<member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
<summary>
Gets or sets a value that indicates whether the appender will
flush at the end of each write.
</summary>
<remarks>
<para>The default behavior is to flush at the end of each
write. If the option is set to<c>false</c>, then the underlying
stream can defer writing to physical medium to a later time.
</para>
<para>
Avoiding the flush operation at the end of each append results
in a performance gain of 10 to 20 percent. However, there is safety
trade-off involved in skipping flushing. Indeed, when flushing is
skipped, then it is likely that the last few log events will not
be recorded on disk when the application exits. This is a high
price to pay even for a 20% performance gain.
</para>
</remarks>
</member>
<member name="P:log4net.Appender.TraceAppender.Category">
<summary>
The category parameter sent to the Trace method.
</summary>
<remarks>
<para>
Defaults to %logger which will use the logger name of the current
<see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
</para>
<para>
</para>
</remarks>
</member>
<member name="P:log4net.Appender.TraceAppender.RequiresLayout">
<summary>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</summary>
<value><c>true</c></value>
<remarks>
<para>
This appender requires a <see cref="N:log4net.Layout"/> to be set.
</para>
</remarks>
</member>
<member name="T:log4net.Config.AliasDomainAttribute">
<summary>
Assembly level attribute that specifies a domain to alias to this assembly's repository.
</summary>
<remarks>
<para>
<b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
</para>
<para>
An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
however this can be overridden by an assembly loaded before the target assembly.
</para>
<para>
An assembly can alias another assembly's domain to its repository by
specifying this attribute with the name of the target domain.
</para>
<para>
This attribute can only be specified on the assembly and may be used
as many times as necessary to alias all the required domains.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Config.AliasRepositoryAttribute">
<summary>
Assembly level attribute that specifies a repository to alias to this assembly's repository.
</summary>
<remarks>
<para>
An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
however this can be overridden by an assembly loaded before the target assembly.
</para>
<para>
An assembly can alias another assembly's repository to its repository by
specifying this attribute with the name of the target repository.
</para>
<para>
This attribute can only be specified on the assembly and may be used
as many times as necessary to alias all the required repositories.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
the specified repository to alias to this assembly's repository.
</summary>
<param name="name">The repository to alias to this assemby's repository.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
the specified repository to alias to this assembly's repository.
</para>
</remarks>
</member>
<member name="P:log4net.Config.AliasRepositoryAttribute.Name">
<summary>
Gets or sets the repository to alias to this assemby's repository.
</summary>
<value>
The repository to alias to this assemby's repository.
</value>
<remarks>
<para>
The name of the repository to alias to this assemby's repository.
</para>
</remarks>
</member>
<member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute"/> class with
the specified domain to alias to this assembly's repository.
</summary>
<param name="name">The domain to alias to this assemby's repository.</param>
<remarks>
<para>
Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Config.BasicConfigurator">
<summary>
Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
</summary>
<remarks>
<para>
Allows very simple programmatic configuration of log4net.
</para>
<para>
Only one appender can be configured using this configurator.
The appender is set at the root of the hierarchy and all logging
events will be delivered to that appender.
</para>
<para>
Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method
be called after the appenders properties have been configured.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Config.BasicConfigurator.declaringType">
<summary>
The fully qualified type of the BasicConfigurator class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="M:log4net.Config.BasicConfigurator.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator"/> class.
</summary>
<remarks>
<para>
Uses a private access modifier to prevent instantiation of this class.
</para>
</remarks>
</member>
<member name="M:log4net.Config.BasicConfigurator.Configure">
<summary>
Initializes the log4net system with a default configuration.
</summary>
<remarks>
<para>
Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/>
that will write to <c>Console.Out</c>. The log messages are
formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
layout style.
</para>
</remarks>
</member>
<member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)">
<summary>
Initializes the log4net system using the specified appender.
</summary>
<param name="appender">The appender to use to log all logging events.</param>
<remarks>
<para>
Initializes the log4net system using the specified appender.
</para>
</remarks>
</member>
<member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender[])">
<summary>
Initializes the log4net system using the specified appenders.
</summary>
<param name="appenders">The appenders to use to log all logging events.</param>
<remarks>
<para>
Initializes the log4net system using the specified appenders.
</para>
</remarks>
</member>
<member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
<summary>
Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
</summary>
<param name="repository">The repository to configure.</param>
<remarks>
<para>
Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
that will write to <c>Console.Out</c>. The log messages are
formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
layout style.
</para>
</remarks>
</member>
<member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
<summary>
Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
</summary>
<param name="repository">The repository to configure.</param>
<param name="appender">The appender to use to log all logging events.</param>
<remarks>
<para>
Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
</para>
</remarks>
</member>
<member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])">
<summary>
Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders.
</summary>
<param name="repository">The repository to configure.</param>
<param name="appenders">The appenders to use to log all logging events.</param>
<remarks>
<para>
Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
</para>
</remarks>
</member>
<member name="T:log4net.Config.ConfiguratorAttribute">
<summary>
Base class for all log4net configuration attributes.
</summary>
<remarks>
This is an abstract class that must be extended by
specific configurators. This attribute allows the
configurator to be parameterized by an assembly level
attribute.
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
<summary>
Constructor used by subclasses.
</summary>
<param name="priority">the ordering priority for this configurator</param>
<remarks>
<para>
The <paramref name="priority"/> is used to order the configurator
attributes before they are invoked. Higher priority configurators are executed
before lower priority ones.
</para>
</remarks>
</member>
<member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
</summary>
<param name="sourceAssembly">The assembly that this attribute was defined on.</param>
<param name="targetRepository">The repository to configure.</param>
<remarks>
<para>
Abstract method implemented by a subclass. When this method is called
the subclass should configure the <paramref name="targetRepository"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
<summary>
Compare this instance to another ConfiguratorAttribute
</summary>
<param name="obj">the object to compare to</param>
<returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
<remarks>
<para>
Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
Sorts by priority in descending order. Objects with the same priority are
randomly ordered.
</para>
</remarks>
</member>
<member name="T:log4net.Config.DomainAttribute">
<summary>
Assembly level attribute that specifies the logging domain for the assembly.
</summary>
<remarks>
<para>
<b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
</para>
<para>
Assemblies are mapped to logging domains. Each domain has its own
logging repository. This attribute specified on the assembly controls
the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
specifies the type of the repository objects to create for the domain. If
this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
then the assembly will be part of the default shared logging domain.
</para>
<para>
This attribute can only be specified on the assembly and may only be used
once per assembly.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Config.RepositoryAttribute">
<summary>
Assembly level attribute that specifies the logging repository for the assembly.
</summary>
<remarks>
<para>
Assemblies are mapped to logging repository. This attribute specified
on the assembly controls
the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
is not specified then the assembly will be part of the default shared logging repository.
</para>
<para>
This attribute can only be specified on the assembly and may only be used
once per assembly.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Config.RepositoryAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
<summary>
Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class
with the name of the repository.
</summary>
<param name="name">The name of the repository.</param>
<remarks>
<para>
Initialize the attribute with the name for the assembly's repository.
</para>
</remarks>
</member>
<member name="P:log4net.Config.RepositoryAttribute.Name">
<summary>
Gets or sets the name of the logging repository.
</summary>
<value>
The string name to use as the name of the repository associated with this
assembly.
</value>
<remarks>
<para>
This value does not have to be unique. Several assemblies can share the
same repository. They will share the logging configuration of the repository.
</para>
</remarks>
</member>
<member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
<summary>
Gets or sets the type of repository to create for this assembly.
</summary>
<value>
The type of repository to create for this assembly.
</value>
<remarks>
<para>
The type of the repository to create for the assembly.
The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
interface.
</para>
<para>
This will be the type of repository created when
the repository is created. If multiple assemblies reference the
same repository then the repository is only created once using the
<see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> of the first assembly to call into the
repository.
</para>
</remarks>
</member>
<member name="M:log4net.Config.DomainAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class.
</summary>
<remarks>
<para>
Obsolete. Use RepositoryAttribute instead of DomainAttribute.
</para>
</remarks>
</member>
<member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
<summary>
Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class
with the name of the domain.
</summary>
<param name="name">The name of the domain.</param>
<remarks>
<para>
Obsolete. Use RepositoryAttribute instead of DomainAttribute.
</para>
</remarks>
</member>
<member name="T:log4net.Config.DOMConfigurator">
<summary>
Use this class to initialize the log4net environment using an Xml tree.
</summary>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
<para>
Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Config.DOMConfigurator.#ctor">
<summary>
Private constructor
</summary>
</member>
<member name="M:log4net.Config.DOMConfigurator.Configure">
<summary>
Automatically configures the log4net system based on the
application's configuration settings.
</summary>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
Each application has a configuration file. This has the
same name as the application with '.config' appended.
This file is XML and calling this function prompts the
configurator to look in that file for a section called
<c>log4net</c> that contains the configuration data.
</remarks>
</member>
<member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)">
<summary>
Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
stored in the application's configuration file.
</summary>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
Each application has a configuration file. This has the
same name as the application with '.config' appended.
This file is XML and calling this function prompts the
configurator to look in that file for a section called
<c>log4net</c> that contains the configuration data.
</remarks>
<param name="repository">The repository to configure.</param>
</member>
<member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)">
<summary>
Configures log4net using a <c>log4net</c> element
</summary>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
Loads the log4net configuration from the XML element
supplied as <paramref name="element"/>.
</remarks>
<param name="element">The element to parse.</param>
</member>
<member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
element.
</summary>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
Loads the log4net configuration from the XML element
supplied as <paramref name="element"/>.
</remarks>
<param name="repository">The repository to configure.</param>
<param name="element">The element to parse.</param>
</member>
<member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)">
<summary>
Configures log4net using the specified configuration file.
</summary>
<param name="configFile">The XML file to load the configuration from.</param>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
<para>
The configuration file must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the log4net configuration data.
</para>
<para>
The log4net configuration file can possible be specified in the application's
configuration file (either <c>MyAppName.exe.config</c> for a
normal application on <c>Web.config</c> for an ASP.NET application).
</para>
<example>
The following example configures log4net using a configuration file, of which the
location is stored in the application's configuration file :
</example>
<code lang="C#">
using log4net.Config;
using System.IO;
using System.Configuration;
...
DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
</code>
<para>
In the <c>.config</c> file, the path to the log4net can be specified like this :
</para>
<code lang="XML" escaped="true">
<configuration>
<appSettings>
<add key="log4net-config-file" value="log.config"/>
</appSettings>
</configuration>
</code>
</remarks>
</member>
<member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)">
<summary>
Configures log4net using the specified configuration file.
</summary>
<param name="configStream">A stream to load the XML configuration from.</param>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
<para>
The configuration data must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the log4net configuration data.
</para>
<para>
Note that this method will NOT close the stream parameter.
</para>
</remarks>
</member>
<member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
file.
</summary>
<param name="repository">The repository to configure.</param>
<param name="configFile">The XML file to load the configuration from.</param>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
<para>
The configuration file must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the configuration data.
</para>
<para>
The log4net configuration file can possible be specified in the application's
configuration file (either <c>MyAppName.exe.config</c> for a
normal application on <c>Web.config</c> for an ASP.NET application).
</para>
<example>
The following example configures log4net using a configuration file, of which the
location is stored in the application's configuration file :
</example>
<code lang="C#">
using log4net.Config;
using System.IO;
using System.Configuration;
...
DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
</code>
<para>
In the <c>.config</c> file, the path to the log4net can be specified like this :
</para>
<code lang="XML" escaped="true">
<configuration>
<appSettings>
<add key="log4net-config-file" value="log.config"/>
</appSettings>
</configuration>
</code>
</remarks>
</member>
<member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
file.
</summary>
<param name="repository">The repository to configure.</param>
<param name="configStream">The stream to load the XML configuration from.</param>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
<para>
The configuration data must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the configuration data.
</para>
<para>
Note that this method will NOT close the stream parameter.
</para>
</remarks>
</member>
<member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
<summary>
Configures log4net using the file specified, monitors the file for changes
and reloads the configuration if a change is detected.
</summary>
<param name="configFile">The XML file to load the configuration from.</param>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
<para>
The configuration file must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the configuration data.
</para>
<para>
The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
and depends on the behavior of that class.
</para>
<para>
For more information on how to configure log4net using
a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
</para>
</remarks>
<seealso cref="M:Configure(FileInfo)"/>
</member>
<member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
monitors the file for changes and reloads the configuration if a change
is detected.
</summary>
<param name="repository">The repository to configure.</param>
<param name="configFile">The XML file to load the configuration from.</param>
<remarks>
<para>
<b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
</para>
<para>
The configuration file must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the configuration data.
</para>
<para>
The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
and depends on the behavior of that class.
</para>
<para>
For more information on how to configure log4net using
a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
</para>
</remarks>
<seealso cref="M:Configure(FileInfo)"/>
</member>
<member name="T:log4net.Config.DOMConfiguratorAttribute">
<summary>
Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
</summary>
<remarks>
<para>
<b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
</para>
<para>
This attribute may only be used at the assembly scope and can only
be used once per assembly.
</para>
<para>
Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
methods.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Config.XmlConfiguratorAttribute">
<summary>
Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
</summary>
<remarks>
<para>
This attribute may only be used at the assembly scope and can only
be used once per assembly.
</para>
<para>
Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
methods.
</para>
<para>
If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
properties are set the configuration is loaded from the application's .config file.
If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
<see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
specifies a path to a file to load the config from. The path is relative to the
application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
<c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
<see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
</para>
<para>
The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
to watch the configuration file for changes.
</para>
<note>
<para>
Log4net will only look for assembly level configuration attributes once.
When using the log4net assembly level attributes to control the configuration
of log4net you must ensure that the first call to any of the
<see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
attributes.
</para>
<para>
If you cannot guarantee the order in which log4net calls will be made from
different assemblies you must use programmatic configuration instead, i.e.
call the <see cref="M:XmlConfigurator.Configure()"/> method directly.
</para>
</note>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Default constructor
</para>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
</summary>
<param name="sourceAssembly">The assembly that this attribute was defined on.</param>
<param name="targetRepository">The repository to configure.</param>
<remarks>
<para>
Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
configure it.
</para>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository"/> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
</member>
<member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
<summary>
Attempt to load configuration from the local file system
</summary>
<param name="sourceAssembly">The assembly that this attribute was defined on.</param>
<param name="targetRepository">The repository to configure.</param>
</member>
<member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
<summary>
Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
</summary>
<param name="targetRepository">The repository to configure.</param>
<param name="configFile">the FileInfo pointing to the config file</param>
</member>
<member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
<summary>
Attempt to load configuration from a URI
</summary>
<param name="sourceAssembly">The assembly that this attribute was defined on.</param>
<param name="targetRepository">The repository to configure.</param>
</member>
<member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType">
<summary>
The fully qualified type of the XmlConfiguratorAttribute class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
<summary>
Gets or sets the filename of the configuration file.
</summary>
<value>
The filename of the configuration file.
</value>
<remarks>
<para>
If specified, this is the name of the configuration file to use with
the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
<b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>).
</para>
<para>
The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
<summary>
Gets or sets the extension of the configuration file.
</summary>
<value>
The extension of the configuration file.
</value>
<remarks>
<para>
If specified this is the extension for the configuration file.
The path to the config file is built by using the <b>application
base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>),
the <b>assembly file name</b> and the config file extension.
</para>
<para>
If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
<c>MyClassLibrary.dll.MyExt</c>.
</para>
<para>
The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
<summary>
Gets or sets a value indicating whether to watch the configuration file.
</summary>
<value>
<c>true</c> if the configuration should be watched, <c>false</c> otherwise.
</value>
<remarks>
<para>
If this flag is specified and set to <c>true</c> then the framework
will watch the configuration file and will reload the config each time
the file is modified.
</para>
<para>
The config file can only be watched if it is loaded from local disk.
In a No-Touch (Smart Client) deployment where the application is downloaded
from a web server the config file may not reside on the local disk
and therefore it may not be able to watch it.
</para>
<note>
Watching configuration is not supported on the SSCLI.
</note>
</remarks>
</member>
<member name="T:log4net.Config.Log4NetConfigurationSectionHandler">
<summary>
Class to register for the log4net section of the configuration file
</summary>
<remarks>
The log4net section of the configuration file needs to have a section
handler registered. This is the section handler used. It simply returns
the XML element that is the root of the section.
</remarks>
<example>
Example of registering the log4net section handler :
<code lang="XML" escaped="true">
<configuration>
<configSections>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
</configSections>
<log4net>
log4net configuration XML goes here
</log4net>
</configuration>
</code>
</example>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class.
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)">
<summary>
Parses the configuration section.
</summary>
<param name="parent">The configuration settings in a corresponding parent configuration section.</param>
<param name="configContext">The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference.</param>
<param name="section">The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</param>
<returns>The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</returns>
<remarks>
<para>
Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data,
</para>
</remarks>
</member>
<member name="T:log4net.Config.PluginAttribute">
<summary>
Assembly level attribute that specifies a plugin to attach to
the repository.
</summary>
<remarks>
<para>
Specifies the type of a plugin to create and attach to the
assembly's repository. The plugin type must implement the
<see cref="T:log4net.Plugin.IPlugin"/> interface.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Plugin.IPluginFactory">
<summary>
Interface used to create plugins.
</summary>
<remarks>
<para>
Interface used to create a plugin.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
<summary>
Creates the plugin object.
</summary>
<returns>the new plugin instance</returns>
<remarks>
<para>
Create and return a new plugin instance.
</para>
</remarks>
</member>
<member name="M:log4net.Config.PluginAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
with the specified type.
</summary>
<param name="typeName">The type name of plugin to create.</param>
<remarks>
<para>
Create the attribute with the plugin type specified.
</para>
<para>
Where possible use the constructor that takes a <see cref="T:System.Type"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
with the specified type.
</summary>
<param name="type">The type of plugin to create.</param>
<remarks>
<para>
Create the attribute with the plugin type specified.
</para>
</remarks>
</member>
<member name="M:log4net.Config.PluginAttribute.CreatePlugin">
<summary>
Creates the plugin object defined by this attribute.
</summary>
<remarks>
<para>
Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
specified by this attribute.
</para>
</remarks>
<returns>The plugin object.</returns>
</member>
<member name="M:log4net.Config.PluginAttribute.ToString">
<summary>
Returns a representation of the properties of this object.
</summary>
<remarks>
<para>
Overrides base class <see cref="M:Object.ToString()" /> method to
return a representation of the properties of this object.
</para>
</remarks>
<returns>A representation of the properties of this object</returns>
</member>
<member name="P:log4net.Config.PluginAttribute.Type">
<summary>
Gets or sets the type for the plugin.
</summary>
<value>
The type for the plugin.
</value>
<remarks>
<para>
The type for the plugin.
</para>
</remarks>
</member>
<member name="P:log4net.Config.PluginAttribute.TypeName">
<summary>
Gets or sets the type name for the plugin.
</summary>
<value>
The type name for the plugin.
</value>
<remarks>
<para>
The type name for the plugin.
</para>
<para>
Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
</para>
</remarks>
</member>
<member name="T:log4net.Config.SecurityContextProviderAttribute">
<summary>
Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
</summary>
<remarks>
<para>
This attribute may only be used at the assembly scope and can only
be used once per assembly.
</para>
<para>
Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
methods.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
<summary>
Construct provider attribute with type specified
</summary>
<param name="providerType">the type of the provider to use</param>
<remarks>
<para>
The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
class.
</para>
</remarks>
</member>
<member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
<summary>
Configures the SecurityContextProvider
</summary>
<param name="sourceAssembly">The assembly that this attribute was defined on.</param>
<param name="targetRepository">The repository to configure.</param>
<remarks>
<para>
Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType">
<summary>
The fully qualified type of the SecurityContextProviderAttribute class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
<summary>
Gets or sets the type of the provider to use.
</summary>
<value>
the type of the provider to use.
</value>
<remarks>
<para>
The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
class.
</para>
</remarks>
</member>
<member name="T:log4net.Config.XmlConfigurator">
<summary>
Use this class to initialize the log4net environment using an Xml tree.
</summary>
<remarks>
<para>
Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Config.XmlConfigurator.#ctor">
<summary>
Private constructor
</summary>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure">
<summary>
Automatically configures the log4net system based on the
application's configuration settings.
</summary>
<remarks>
<para>
Each application has a configuration file. This has the
same name as the application with '.config' appended.
This file is XML and calling this function prompts the
configurator to look in that file for a section called
<c>log4net</c> that contains the configuration data.
</para>
<para>
To use this method to configure log4net you must specify
the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
handler for the <c>log4net</c> configuration section. See the
<see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
</para>
</remarks>
<seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
<summary>
Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
stored in the application's configuration file.
</summary>
<remarks>
<para>
Each application has a configuration file. This has the
same name as the application with '.config' appended.
This file is XML and calling this function prompts the
configurator to look in that file for a section called
<c>log4net</c> that contains the configuration data.
</para>
<para>
To use this method to configure log4net you must specify
the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
handler for the <c>log4net</c> configuration section. See the
<see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
</para>
</remarks>
<param name="repository">The repository to configure.</param>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)">
<summary>
Configures log4net using a <c>log4net</c> element
</summary>
<remarks>
<para>
Loads the log4net configuration from the XML element
supplied as <paramref name="element"/>.
</para>
</remarks>
<param name="element">The element to parse.</param>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
element.
</summary>
<remarks>
Loads the log4net configuration from the XML element
supplied as <paramref name="element"/>.
</remarks>
<param name="repository">The repository to configure.</param>
<param name="element">The element to parse.</param>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)">
<summary>
Configures log4net using the specified configuration file.
</summary>
<param name="configFile">The XML file to load the configuration from.</param>
<remarks>
<para>
The configuration file must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the log4net configuration data.
</para>
<para>
The log4net configuration file can possible be specified in the application's
configuration file (either <c>MyAppName.exe.config</c> for a
normal application on <c>Web.config</c> for an ASP.NET application).
</para>
<para>
The first element matching <c><configuration></c> will be read as the
configuration. If this file is also a .NET .config file then you must specify
a configuration section for the <c>log4net</c> element otherwise .NET will
complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
<code lang="XML" escaped="true">
<configSections>
<section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
</configSections>
</code>
</para>
<example>
The following example configures log4net using a configuration file, of which the
location is stored in the application's configuration file :
</example>
<code lang="C#">
using log4net.Config;
using System.IO;
using System.Configuration;
...
XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
</code>
<para>
In the <c>.config</c> file, the path to the log4net can be specified like this :
</para>
<code lang="XML" escaped="true">
<configuration>
<appSettings>
<add key="log4net-config-file" value="log.config"/>
</appSettings>
</configuration>
</code>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)">
<summary>
Configures log4net using the specified configuration URI.
</summary>
<param name="configUri">A URI to load the XML configuration from.</param>
<remarks>
<para>
The configuration data must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the log4net configuration data.
</para>
<para>
The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
</para>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)">
<summary>
Configures log4net using the specified configuration data stream.
</summary>
<param name="configStream">A stream to load the XML configuration from.</param>
<remarks>
<para>
The configuration data must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the log4net configuration data.
</para>
<para>
Note that this method will NOT close the stream parameter.
</para>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
file.
</summary>
<param name="repository">The repository to configure.</param>
<param name="configFile">The XML file to load the configuration from.</param>
<remarks>
<para>
The configuration file must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the configuration data.
</para>
<para>
The log4net configuration file can possible be specified in the application's
configuration file (either <c>MyAppName.exe.config</c> for a
normal application on <c>Web.config</c> for an ASP.NET application).
</para>
<para>
The first element matching <c><configuration></c> will be read as the
configuration. If this file is also a .NET .config file then you must specify
a configuration section for the <c>log4net</c> element otherwise .NET will
complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
<code lang="XML" escaped="true">
<configSections>
<section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
</configSections>
</code>
</para>
<example>
The following example configures log4net using a configuration file, of which the
location is stored in the application's configuration file :
</example>
<code lang="C#">
using log4net.Config;
using System.IO;
using System.Configuration;
...
XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
</code>
<para>
In the <c>.config</c> file, the path to the log4net can be specified like this :
</para>
<code lang="XML" escaped="true">
<configuration>
<appSettings>
<add key="log4net-config-file" value="log.config"/>
</appSettings>
</configuration>
</code>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
URI.
</summary>
<param name="repository">The repository to configure.</param>
<param name="configUri">A URI to load the XML configuration from.</param>
<remarks>
<para>
The configuration data must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the configuration data.
</para>
<para>
The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
</para>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
file.
</summary>
<param name="repository">The repository to configure.</param>
<param name="configStream">The stream to load the XML configuration from.</param>
<remarks>
<para>
The configuration data must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the configuration data.
</para>
<para>
Note that this method will NOT close the stream parameter.
</para>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
<summary>
Configures log4net using the file specified, monitors the file for changes
and reloads the configuration if a change is detected.
</summary>
<param name="configFile">The XML file to load the configuration from.</param>
<remarks>
<para>
The configuration file must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the configuration data.
</para>
<para>
The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
and depends on the behavior of that class.
</para>
<para>
For more information on how to configure log4net using
a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
</para>
</remarks>
<seealso cref="M:Configure(FileInfo)"/>
</member>
<member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
<summary>
Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
monitors the file for changes and reloads the configuration if a change
is detected.
</summary>
<param name="repository">The repository to configure.</param>
<param name="configFile">The XML file to load the configuration from.</param>
<remarks>
<para>
The configuration file must be valid XML. It must contain
at least one element called <c>log4net</c> that holds
the configuration data.
</para>
<para>
The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
and depends on the behavior of that class.
</para>
<para>
For more information on how to configure log4net using
a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
</para>
</remarks>
<seealso cref="M:Configure(FileInfo)"/>
</member>
<member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
<summary>
Configures the specified repository using a <c>log4net</c> element.
</summary>
<param name="repository">The hierarchy to configure.</param>
<param name="element">The element to parse.</param>
<remarks>
<para>
Loads the log4net configuration from the XML element
supplied as <paramref name="element"/>.
</para>
<para>
This method is ultimately called by one of the Configure methods
to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler">
<summary>
Maps repository names to ConfigAndWatchHandler instances to allow a particular
ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is
reconfigured.
</summary>
</member>
<member name="F:log4net.Config.XmlConfigurator.declaringType">
<summary>
The fully qualified type of the XmlConfigurator class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
<summary>
Class used to watch config files.
</summary>
<remarks>
<para>
Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
changes to a specified file. Because multiple change notifications
may be raised when the file is modified, a timer is used to
compress the notifications into a single event. The timer
waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
change notifications arrive while the timer is waiting it
is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
elapse.
</para>
</remarks>
</member>
<member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
<summary>
The default amount of time to wait after receiving notification
before reloading the config file.
</summary>
</member>
<member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
<summary>
Holds the FileInfo used to configure the XmlConfigurator
</summary>
</member>
<member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
<summary>
Holds the repository being configured.
</summary>
</member>
<member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
<summary>
The timer used to compress the notification events.
</summary>
</member>
<member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher">
<summary>
Watches file for changes. This object should be disposed when no longer
needed to free system handles on the watched resources.
</summary>
</member>
<member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class to
watch a specified config file used to configure a repository.
</summary>
<param name="repository">The repository to configure.</param>
<param name="configFile">The configuration file to watch.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
<summary>
Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
</summary>
<param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
<param name="e">The argument indicates the file that caused the event to be fired.</param>
<remarks>
<para>
This handler reloads the configuration from the file when the event is fired.
</para>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
<summary>
Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
</summary>
<param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
<param name="e">The argument indicates the file that caused the event to be fired.</param>
<remarks>
<para>
This handler reloads the configuration from the file when the event is fired.
</para>
</remarks>
</member>
<member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
<summary>
Called by the timer when the configuration has been updated.
</summary>
<param name="state">null</param>
</member>
<member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose">
<summary>
Release the handles held by the watcher and timer.
</summary>
</member>
<member name="T:log4net.Core.CompactRepositorySelector">
<summary>
The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
for use with the compact framework
</summary>
<remarks>
<para>
This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
object.
</para>
<para>
The .NET Compact Framework 1.0 does not support retrieving assembly
level attributes therefore unlike the <c>DefaultRepositorySelector</c>
this selector does not examine the calling assembly for attributes.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="T:log4net.Core.IRepositorySelector">
<summary>
Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
</summary>
<remarks>
<para>
The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
to return to the caller.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
<summary>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
</summary>
<param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
</para>
<para>
How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
is made is not defined. The implementation may choose any method for
this association. The results of this method must be repeatable, i.e.
when called again with the same arguments the result must be the
save value.
</para>
</remarks>
</member>
<member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
<summary>
Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
</summary>
<param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
<remarks>
Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
calling <see cref="M:CreateRepository(string,Type)"/>.
</remarks>
</member>
<member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
<summary>
Creates a new repository for the assembly specified.
</summary>
<param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<returns>The repository created.</returns>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
same assembly specified will return the same repository instance.
</para>
<para>
How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
is made is not defined. The implementation may choose any method for
this association.
</para>
</remarks>
</member>
<member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
<summary>
Creates a new repository with the name specified.
</summary>
<param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<returns>The repository created.</returns>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
specified such that a call to <see cref="M:GetRepository(string)"/> with the
same name will return the same repository instance.
</para>
</remarks>
</member>
<member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
<summary>
Test if a named repository exists
</summary>
<param name="repositoryName">the named repository to check</param>
<returns><c>true</c> if the repository exists</returns>
<remarks>
<para>
Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/>
to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve
a repository.
</para>
</remarks>
</member>
<member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
<summary>
Gets an array of all currently defined repositories.
</summary>
<returns>
An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
<remarks>
<para>
Gets an array of all of the repositories created by this selector.
</para>
</remarks>
</member>
<member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
<summary>
Event to notify that a logger repository has been created.
</summary>
<value>
Event to notify that a logger repository has been created.
</value>
<remarks>
<para>
Event raised when a new repository is created.
The event source will be this selector. The event args will
be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
<summary>
Create a new repository selector
</summary>
<param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
<remarks>
<para>
Create an new compact repository selector.
The default type for repositories must be specified,
an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
<exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
</member>
<member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
<summary>
Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
</summary>
<param name="assembly">not used</param>
<returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
<remarks>
<para>
The <paramref name="assembly"/> argument is not used. This selector does not create a
separate repository for each assembly.
</para>
<para>
As a named repository is not specified the default repository is
returned. The default repository is named <c>log4net-default-repository</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
<summary>
Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
</summary>
<param name="repositoryName">the name of the repository to lookup</param>
<returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
<remarks>
<para>
Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
repository is <c>log4net-default-repository</c>. Other repositories
must be created using the <see cref="M:CreateRepository(string, Type)"/>.
If the named repository does not exist an exception is thrown.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
<exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
</member>
<member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
<summary>
Create a new repository for the assembly specified
</summary>
<param name="assembly">not used</param>
<param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
<returns>the repository created</returns>
<remarks>
<para>
The <paramref name="assembly"/> argument is not used. This selector does not create a
separate repository for each assembly.
</para>
<para>
If the <paramref name="repositoryType"/> is <c>null</c> then the
default repository type specified to the constructor is used.
</para>
<para>
As a named repository is not specified the default repository is
returned. The default repository is named <c>log4net-default-repository</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
<summary>
Create a new repository for the repository specified
</summary>
<param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
<param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
If this param is null then the default repository type is used.</param>
<returns>the repository created</returns>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository(string)"/> with the
same repository specified will return the same repository instance.
</para>
<para>
If the named repository already exists an exception will be thrown.
</para>
<para>
If <paramref name="repositoryType"/> is <c>null</c> then the default
repository type specified to the constructor is used.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
<exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
</member>
<member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
<summary>
Test if a named repository exists
</summary>
<param name="repositoryName">the named repository to check</param>
<returns><c>true</c> if the repository exists</returns>
<remarks>
<para>
Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
a repository.
</para>
</remarks>
</member>
<member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
<summary>
Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
</summary>
<returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
<remarks>
<para>
Gets an array of all of the repositories created by this selector.
</para>
</remarks>
</member>
<member name="F:log4net.Core.CompactRepositorySelector.declaringType">
<summary>
The fully qualified type of the CompactRepositorySelector class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
<summary>
Notify the registered listeners that the repository has been created
</summary>
<param name="repository">The repository that has been created</param>
<remarks>
<para>
Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
event.
</para>
</remarks>
</member>
<member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
<summary>
Event to notify that a logger repository has been created.
</summary>
<value>
Event to notify that a logger repository has been created.
</value>
<remarks>
<para>
Event raised when a new repository is created.
The event source will be this selector. The event args will
be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Core.DefaultRepositorySelector">
<summary>
The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
</summary>
<remarks>
<para>
Uses attributes defined on the calling assembly to determine how to
configure the hierarchy for the repository.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
<summary>
Creates a new repository selector.
</summary>
<param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
<remarks>
<para>
Create an new repository selector.
The default type for repositories must be specified,
an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null"/>.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
<summary>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
</summary>
<param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<remarks>
<para>
The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
attribute on the <paramref name="repositoryAssembly"/>.
</para>
<para>
The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
<see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
</para>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
the <paramref name="repositoryAssembly"/>.
</para>
</remarks>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
<summary>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
</summary>
<param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
<remarks>
<para>
Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
</para>
<para>
Use <see cref="M:CreateRepository(string, Type)"/> to create a repository.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
<exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
<summary>
Create a new repository for the assembly specified
</summary>
<param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<returns>The repository created.</returns>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
same assembly specified will return the same repository instance.
</para>
<para>
The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
the repository to create can be overridden by specifying the
<see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
<paramref name="repositoryAssembly"/>. The default values are to use the
<paramref name="repositoryType"/> implementation of the
<see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
<see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
</para>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
attributes defined on the <paramref name="repositoryAssembly"/>.
</para>
<para>
If a repository for the <paramref name="repositoryAssembly"/> already exists
that repository will be returned. An error will not be raised and that
repository may be of a different type to that specified in <paramref name="repositoryType"/>.
Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
assembly may be used to override the repository type specified in
<paramref name="repositoryType"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
<summary>
Creates a new repository for the assembly specified.
</summary>
<param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<param name="repositoryName">The name to assign to the created repository</param>
<param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
<returns>The repository created.</returns>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
same assembly specified will return the same repository instance.
</para>
<para>
The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
the repository to create can be overridden by specifying the
<see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
<paramref name="repositoryAssembly"/>. The default values are to use the
<paramref name="repositoryType"/> implementation of the
<see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
<see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
</para>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
attributes defined on the <paramref name="repositoryAssembly"/>.
</para>
<para>
If a repository for the <paramref name="repositoryAssembly"/> already exists
that repository will be returned. An error will not be raised and that
repository may be of a different type to that specified in <paramref name="repositoryType"/>.
Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
assembly may be used to override the repository type specified in
<paramref name="repositoryType"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
<summary>
Creates a new repository for the specified repository.
</summary>
<param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
<param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
If this param is <see langword="null"/> then the default repository type is used.</param>
<returns>The new repository.</returns>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository(string)"/> with the
same repository specified will return the same repository instance.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
<exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
<summary>
Test if a named repository exists
</summary>
<param name="repositoryName">the named repository to check</param>
<returns><c>true</c> if the repository exists</returns>
<remarks>
<para>
Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
a repository.
</para>
</remarks>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
<summary>
Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
</summary>
<returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
<remarks>
<para>
Gets an array of all of the repositories created by this selector.
</para>
</remarks>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
<summary>
Aliases a repository to an existing repository.
</summary>
<param name="repositoryAlias">The repository to alias.</param>
<param name="repositoryTarget">The repository that the repository is aliased to.</param>
<remarks>
<para>
The repository specified will be aliased to the repository when created.
The repository must not already exist.
</para>
<para>
When the repository is created it must utilize the same repository type as
the repository it is aliased to, otherwise the aliasing will fail.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">
<para><paramref name="repositoryAlias"/> is <see langword="null"/>.</para>
<para>-or-</para>
<para><paramref name="repositoryTarget"/> is <see langword="null"/>.</para>
</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
<summary>
Notifies the registered listeners that the repository has been created.
</summary>
<param name="repository">The repository that has been created.</param>
<remarks>
<para>
Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
</para>
</remarks>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
<summary>
Gets the repository name and repository type for the specified assembly.
</summary>
<param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
<param name="repositoryName">in/out param to hold the repository name to use for the assembly, caller should set this to the default value before calling.</param>
<param name="repositoryType">in/out param to hold the type of the repository to create for the assembly, caller should set this to the default value before calling.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
<summary>
Configures the repository using information from the assembly.
</summary>
<param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
attributes which define the configuration for the repository.</param>
<param name="repository">The repository to configure.</param>
<exception cref="T:System.ArgumentNullException">
<para><paramref name="assembly"/> is <see langword="null"/>.</para>
<para>-or-</para>
<para><paramref name="repository"/> is <see langword="null"/>.</para>
</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
<summary>
Loads the attribute defined plugins on the assembly.
</summary>
<param name="assembly">The assembly that contains the attributes.</param>
<param name="repository">The repository to add the plugins to.</param>
<exception cref="T:System.ArgumentNullException">
<para><paramref name="assembly"/> is <see langword="null"/>.</para>
<para>-or-</para>
<para><paramref name="repository"/> is <see langword="null"/>.</para>
</exception>
</member>
<member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
<summary>
Loads the attribute defined aliases on the assembly.
</summary>
<param name="assembly">The assembly that contains the attributes.</param>
<param name="repository">The repository to alias to.</param>
<exception cref="T:System.ArgumentNullException">
<para><paramref name="assembly"/> is <see langword="null"/>.</para>
<para>-or-</para>
<para><paramref name="repository"/> is <see langword="null"/>.</para>
</exception>
</member>
<member name="F:log4net.Core.DefaultRepositorySelector.declaringType">
<summary>
The fully qualified type of the DefaultRepositorySelector class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
<summary>
Event to notify that a logger repository has been created.
</summary>
<value>
Event to notify that a logger repository has been created.
</value>
<remarks>
<para>
Event raised when a new repository is created.
The event source will be this selector. The event args will
be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Core.ErrorCode">
<summary>
Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
</summary>
<remarks>
<para>
Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Core.ErrorCode.GenericFailure">
<summary>
A general error
</summary>
</member>
<member name="F:log4net.Core.ErrorCode.WriteFailure">
<summary>
Error while writing output
</summary>
</member>
<member name="F:log4net.Core.ErrorCode.FlushFailure">
<summary>
Failed to flush file
</summary>
</member>
<member name="F:log4net.Core.ErrorCode.CloseFailure">
<summary>
Failed to close file
</summary>
</member>
<member name="F:log4net.Core.ErrorCode.FileOpenFailure">
<summary>
Unable to open output file
</summary>
</member>
<member name="F:log4net.Core.ErrorCode.MissingLayout">
<summary>
No layout specified
</summary>
</member>
<member name="F:log4net.Core.ErrorCode.AddressParseFailure">
<summary>
Failed to parse address
</summary>
</member>
<member name="T:log4net.Core.ExceptionEvaluator">
<summary>
An evaluator that triggers on an Exception type
</summary>
<remarks>
<para>
This evaluator will trigger if the type of the Exception
passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. ///
</para>
</remarks>
<author>Drew Schaeffer</author>
</member>
<member name="T:log4net.Core.ITriggeringEventEvaluator">
<summary>
Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
</summary>
<remarks>
<para>
Implementations of this interface allow certain appenders to decide
when to perform an appender specific action.
</para>
<para>
The action or behavior triggered is defined by the implementation.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
<summary>
Test if this event triggers the action
</summary>
<param name="loggingEvent">The event to check</param>
<returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
<remarks>
<para>
Return <c>true</c> if this event triggers the action
</para>
</remarks>
</member>
<member name="F:log4net.Core.ExceptionEvaluator.m_type">
<summary>
The type that causes the trigger to fire.
</summary>
</member>
<member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass">
<summary>
Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire.
</summary>
</member>
<member name="M:log4net.Core.ExceptionEvaluator.#ctor">
<summary>
Default ctor to allow dynamic creation through a configurator.
</summary>
</member>
<member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)">
<summary>
Constructs an evaluator and initializes to trigger on <paramref name="exType"/>
</summary>
<param name="exType">the type that triggers this evaluator.</param>
<param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param>
</member>
<member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
<summary>
Is this <paramref name="loggingEvent"/> the triggering event?
</summary>
<param name="loggingEvent">The event to check</param>
<returns>This method returns <c>true</c>, if the logging event Exception
Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
Otherwise it returns <c>false</c></returns>
<remarks>
<para>
This evaluator will trigger if the Exception Type of the event
passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Core.ExceptionEvaluator.ExceptionType">
<summary>
The type that triggers this evaluator.
</summary>
</member>
<member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass">
<summary>
If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
</summary>
</member>
<member name="T:log4net.Core.IErrorHandler">
<summary>
Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler"/>.
</summary>
<remarks>
<para>
Error handling is a particularly tedious to get right because by
definition errors are hard to predict and to reproduce.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
<summary>
Handles the error and information about the error condition is passed as
a parameter.
</summary>
<param name="message">The message associated with the error.</param>
<param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
<param name="errorCode">The error code associated with the error.</param>
<remarks>
<para>
Handles the error and information about the error condition is passed as
a parameter.
</para>
</remarks>
</member>
<member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
<summary>
Prints the error message passed as a parameter.
</summary>
<param name="message">The message associated with the error.</param>
<param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
<remarks>
<para>
See <see cref="M:Error(string,Exception,ErrorCode)"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.IErrorHandler.Error(System.String)">
<summary>
Prints the error message passed as a parameter.
</summary>
<param name="message">The message associated with the error.</param>
<remarks>
<para>
See <see cref="M:Error(string,Exception,ErrorCode)"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Core.IFixingRequired">
<summary>
Interface for objects that require fixing.
</summary>
<remarks>
<para>
Interface that indicates that the object requires fixing before it
can be taken outside the context of the appender's
<see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
</para>
<para>
When objects that implement this interface are stored
in the context properties maps <see cref="T:log4net.GlobalContext"/>
<see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
<see cref="P:log4net.ThreadContext.Properties"/> are fixed
(see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
method will be called.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Core.IFixingRequired.GetFixedObject">
<summary>
Get a portable version of this object
</summary>
<returns>the portable instance of this object</returns>
<remarks>
<para>
Get a portable instance object that represents the current
state of this object. The portable object can be stored
and logged from any thread with identical results.
</para>
</remarks>
</member>
<member name="T:log4net.Core.ILogger">
<summary>
Interface that all loggers implement
</summary>
<remarks>
<para>
This interface supports logging events and testing if a level
is enabled for logging.
</para>
<para>
These methods will not throw exceptions. Note to implementor, ensure
that the implementation of these methods cannot allow an exception
to be thrown to the caller.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
<summary>
This generic form is intended to be used by wrappers.
</summary>
<param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
the stack boundary into the logging system for this call.</param>
<param name="level">The level of the message to be logged.</param>
<param name="message">The message object to log.</param>
<param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
<remarks>
<para>
Generates a logging event for the specified <paramref name="level"/> using
the <paramref name="message"/> and <paramref name="exception"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
<summary>
This is the most generic printing method that is intended to be used
by wrappers.
</summary>
<param name="logEvent">The event being logged.</param>
<remarks>
<para>
Logs the specified logging event through this logger.
</para>
</remarks>
</member>
<member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
<summary>
Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
</summary>
<param name="level">The level to check.</param>
<returns>
<c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
</returns>
<remarks>
<para>
Test if this logger is going to log events of the specified <paramref name="level"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Core.ILogger.Name">
<summary>
Gets the name of the logger.
</summary>
<value>
The name of the logger.
</value>
<remarks>
<para>
The name of this logger
</para>
</remarks>
</member>
<member name="P:log4net.Core.ILogger.Repository">
<summary>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
<c>Logger</c> instance is attached to.
</summary>
<value>
The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
</value>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
<c>Logger</c> instance is attached to.
</para>
</remarks>
</member>
<member name="T:log4net.Core.ILoggerWrapper">
<summary>
Base interface for all wrappers
</summary>
<remarks>
<para>
Base interface for all wrappers.
</para>
<para>
All wrappers must implement this interface.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="P:log4net.Core.ILoggerWrapper.Logger">
<summary>
Get the implementation behind this wrapper object.
</summary>
<value>
The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
</value>
<remarks>
<para>
The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
object. The <c>Logger</c> object may not
be the same object as this object because of logger decorators.
This gets the actual underlying objects that is used to process
the log events.
</para>
</remarks>
</member>
<member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
<summary>
Delegate used to handle logger repository creation event notifications
</summary>
<param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
<param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
<remarks>
<para>
Delegate used to handle logger repository creation event notifications.
</para>
</remarks>
</member>
<member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
<summary>
Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
</summary>
<remarks>
<para>
A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
<summary>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created
</summary>
</member>
<member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
<summary>
Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
</summary>
<param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
<remarks>
<para>
Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
<summary>
The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
</summary>
<value>
The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
</value>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
</para>
</remarks>
</member>
<member name="T:log4net.Core.Level">
<summary>
Defines the default set of levels recognized by the system.
</summary>
<remarks>
<para>
Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
</para>
<para>
Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
are deemed to be equivalent.
</para>
<para>
The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
and each repository can have different levels defined. The levels are stored
in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
</para>
<para>
When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
<see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
</para>
<para>
Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
<see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
the display name is the same as the level name, but this can be used to alias levels
or to localize the log output.
</para>
<para>
Some of the predefined levels recognized by the system are:
</para>
<list type="bullet">
<item>
<description><see cref="F:log4net.Core.Level.Off"/>.</description>
</item>
<item>
<description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
</item>
<item>
<description><see cref="F:log4net.Core.Level.Error"/>.</description>
</item>
<item>
<description><see cref="F:log4net.Core.Level.Warn"/>.</description>
</item>
<item>
<description><see cref="F:log4net.Core.Level.Info"/>.</description>
</item>
<item>
<description><see cref="F:log4net.Core.Level.Debug"/>.</description>
</item>
<item>
<description><see cref="F:log4net.Core.Level.All"/>.</description>
</item>
</list>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
<summary>
Constructor
</summary>
<param name="level">Integer value for this level, higher values represent more severe levels.</param>
<param name="levelName">The string name of this level.</param>
<param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
the specified level name and value.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
<summary>
Constructor
</summary>
<param name="level">Integer value for this level, higher values represent more severe levels.</param>
<param name="levelName">The string name of this level.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
the specified level name and value.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.ToString">
<summary>
Returns the <see cref="T:System.String"/> representation of the current
<see cref="T:log4net.Core.Level"/>.
</summary>
<returns>
A <see cref="T:System.String"/> representation of the current <see cref="T:log4net.Core.Level"/>.
</returns>
<remarks>
<para>
Returns the level <see cref="P:log4net.Core.Level.Name"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.Equals(System.Object)">
<summary>
Compares levels.
</summary>
<param name="o">The object to compare against.</param>
<returns><c>true</c> if the objects are equal.</returns>
<remarks>
<para>
Compares the levels of <see cref="T:log4net.Core.Level"/> instances, and
defers to base class if the target object is not a <see cref="T:log4net.Core.Level"/>
instance.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.GetHashCode">
<summary>
Returns a hash code
</summary>
<returns>A hash code for the current <see cref="T:log4net.Core.Level"/>.</returns>
<remarks>
<para>
Returns a hash code suitable for use in hashing algorithms and data
structures like a hash table.
</para>
<para>
Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.CompareTo(System.Object)">
<summary>
Compares this instance to a specified object and returns an
indication of their relative values.
</summary>
<param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null"/> to compare with this instance.</param>
<returns>
A 32-bit signed integer that indicates the relative order of the
values compared. The return value has these meanings:
<list type="table">
<listheader>
<term>Value</term>
<description>Meaning</description>
</listheader>
<item>
<term>Less than zero</term>
<description>This instance is less than <paramref name="r"/>.</description>
</item>
<item>
<term>Zero</term>
<description>This instance is equal to <paramref name="r"/>.</description>
</item>
<item>
<term>Greater than zero</term>
<description>
<para>This instance is greater than <paramref name="r"/>.</para>
<para>-or-</para>
<para><paramref name="r"/> is <see langword="null"/>.</para>
</description>
</item>
</list>
</returns>
<remarks>
<para>
<paramref name="r"/> must be an instance of <see cref="T:log4net.Core.Level"/>
or <see langword="null"/>; otherwise, an exception is thrown.
</para>
</remarks>
<exception cref="T:System.ArgumentException"><paramref name="r"/> is not a <see cref="T:log4net.Core.Level"/>.</exception>
</member>
<member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
<summary>
Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
is greater than another specified <see cref="T:log4net.Core.Level"/>.
</summary>
<param name="l">A <see cref="T:log4net.Core.Level"/></param>
<param name="r">A <see cref="T:log4net.Core.Level"/></param>
<returns>
<c>true</c> if <paramref name="l"/> is greater than
<paramref name="r"/>; otherwise, <c>false</c>.
</returns>
<remarks>
<para>
Compares two levels.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
<summary>
Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
is less than another specified <see cref="T:log4net.Core.Level"/>.
</summary>
<param name="l">A <see cref="T:log4net.Core.Level"/></param>
<param name="r">A <see cref="T:log4net.Core.Level"/></param>
<returns>
<c>true</c> if <paramref name="l"/> is less than
<paramref name="r"/>; otherwise, <c>false</c>.
</returns>
<remarks>
<para>
Compares two levels.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
<summary>
Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
is greater than or equal to another specified <see cref="T:log4net.Core.Level"/>.
</summary>
<param name="l">A <see cref="T:log4net.Core.Level"/></param>
<param name="r">A <see cref="T:log4net.Core.Level"/></param>
<returns>
<c>true</c> if <paramref name="l"/> is greater than or equal to
<paramref name="r"/>; otherwise, <c>false</c>.
</returns>
<remarks>
<para>
Compares two levels.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
<summary>
Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
is less than or equal to another specified <see cref="T:log4net.Core.Level"/>.
</summary>
<param name="l">A <see cref="T:log4net.Core.Level"/></param>
<param name="r">A <see cref="T:log4net.Core.Level"/></param>
<returns>
<c>true</c> if <paramref name="l"/> is less than or equal to
<paramref name="r"/>; otherwise, <c>false</c>.
</returns>
<remarks>
<para>
Compares two levels.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
<summary>
Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
objects have the same value.
</summary>
<param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
<param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
<returns>
<c>true</c> if the value of <paramref name="l"/> is the same as the
value of <paramref name="r"/>; otherwise, <c>false</c>.
</returns>
<remarks>
<para>
Compares two levels.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
<summary>
Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
objects have different values.
</summary>
<param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
<param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
<returns>
<c>true</c> if the value of <paramref name="l"/> is different from
the value of <paramref name="r"/>; otherwise, <c>false</c>.
</returns>
<remarks>
<para>
Compares two levels.
</para>
</remarks>
</member>
<member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
<summary>
Compares two specified <see cref="T:log4net.Core.Level"/> instances.
</summary>
<param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
<param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
<returns>
A 32-bit signed integer that indicates the relative order of the
two values compared. The return value has these meanings:
<list type="table">
<listheader>
<term>Value</term>
<description>Meaning</description>
</listheader>
<item>
<term>Less than zero</term>
<description><paramref name="l"/> is less than <paramref name="r"/>.</description>
</item>
<item>
<term>Zero</term>
<description><paramref name="l"/> is equal to <paramref name="r"/>.</description>
</item>
<item>
<term>Greater than zero</term>
<description><paramref name="l"/> is greater than <paramref name="r"/>.</description>
</item>
</list>
</returns>
<remarks>
<para>
Compares two levels.
</para>
</remarks>
</member>
<member name="F:log4net.Core.Level.Off">
<summary>
The <see cref="F:log4net.Core.Level.Off"/> level designates a higher level than all the rest.
</summary>
</member>
<member name="F:log4net.Core.Level.Log4Net_Debug">
<summary>
The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
System unusable, emergencies.
</summary>
</member>
<member name="F:log4net.Core.Level.Emergency">
<summary>
The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
System unusable, emergencies.
</summary>
</member>
<member name="F:log4net.Core.Level.Fatal">
<summary>
The <see cref="F:log4net.Core.Level.Fatal"/> level designates very severe error events
that will presumably lead the application to abort.
</summary>
</member>
<member name="F:log4net.Core.Level.Alert">
<summary>
The <see cref="F:log4net.Core.Level.Alert"/> level designates very severe error events.
Take immediate action, alerts.
</summary>
</member>
<member name="F:log4net.Core.Level.Critical">
<summary>
The <see cref="F:log4net.Core.Level.Critical"/> level designates very severe error events.
Critical condition, critical.
</summary>
</member>
<member name="F:log4net.Core.Level.Severe">
<summary>
The <see cref="F:log4net.Core.Level.Severe"/> level designates very severe error events.
</summary>
</member>
<member name="F:log4net.Core.Level.Error">
<summary>
The <see cref="F:log4net.Core.Level.Error"/> level designates error events that might
still allow the application to continue running.
</summary>
</member>
<member name="F:log4net.Core.Level.Warn">
<summary>
The <see cref="F:log4net.Core.Level.Warn"/> level designates potentially harmful
situations.
</summary>
</member>
<member name="F:log4net.Core.Level.Notice">
<summary>
The <see cref="F:log4net.Core.Level.Notice"/> level designates informational messages
that highlight the progress of the application at the highest level.
</summary>
</member>
<member name="F:log4net.Core.Level.Info">
<summary>
The <see cref="F:log4net.Core.Level.Info"/> level designates informational messages that
highlight the progress of the application at coarse-grained level.
</summary>
</member>
<member name="F:log4net.Core.Level.Debug">
<summary>
The <see cref="F:log4net.Core.Level.Debug"/> level designates fine-grained informational
events that are most useful to debug an application.
</summary>
</member>
<member name="F:log4net.Core.Level.Fine">
<summary>
The <see cref="F:log4net.Core.Level.Fine"/> level designates fine-grained informational
events that are most useful to debug an application.
</summary>
</member>
<member name="F:log4net.Core.Level.Trace">
<summary>
The <see cref="F:log4net.Core.Level.Trace"/> level designates fine-grained informational
events that are most useful to debug an application.
</summary>
</member>
<member name="F:log4net.Core.Level.Finer">
<summary>
The <see cref="F:log4net.Core.Level.Finer"/> level designates fine-grained informational
events that are most useful to debug an application.
</summary>
</member>
<member name="F:log4net.Core.Level.Verbose">
<summary>
The <see cref="F:log4net.Core.Level.Verbose"/> level designates fine-grained informational
events that are most useful to debug an application.
</summary>
</member>
<member name="F:log4net.Core.Level.Finest">
<summary>
The <see cref="F:log4net.Core.Level.Finest"/> level designates fine-grained informational
events that are most useful to debug an application.
</summary>
</member>
<member name="F:log4net.Core.Level.All">
<summary>
The <see cref="F:log4net.Core.Level.All"/> level designates the lowest level possible.
</summary>
</member>
<member name="P:log4net.Core.Level.Name">
<summary>
Gets the name of this level.
</summary>
<value>
The name of this level.
</value>
<remarks>
<para>
Gets the name of this level.
</para>
</remarks>
</member>
<member name="P:log4net.Core.Level.Value">
<summary>
Gets the value of this level.
</summary>
<value>
The value of this level.
</value>
<remarks>
<para>
Gets the value of this level.
</para>
</remarks>
</member>
<member name="P:log4net.Core.Level.DisplayName">
<summary>
Gets the display name of this level.
</summary>
<value>
The display name of this level.
</value>
<remarks>
<para>
Gets the display name of this level.
</para>
</remarks>
</member>
<member name="T:log4net.Core.LevelCollection">
<summary>
A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects.
</summary>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)">
<summary>
Creates a read-only wrapper for a <c>LevelCollection</c> instance.
</summary>
<param name="list">list to create a readonly wrapper arround</param>
<returns>
A <c>LevelCollection</c> wrapper that is read-only.
</returns>
</member>
<member name="M:log4net.Core.LevelCollection.#ctor">
<summary>
Initializes a new instance of the <c>LevelCollection</c> class
that is empty and has the default initial capacity.
</summary>
</member>
<member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)">
<summary>
Initializes a new instance of the <c>LevelCollection</c> class
that has the specified initial capacity.
</summary>
<param name="capacity">
The number of elements that the new <c>LevelCollection</c> is initially capable of storing.
</param>
</member>
<member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)">
<summary>
Initializes a new instance of the <c>LevelCollection</c> class
that contains elements copied from the specified <c>LevelCollection</c>.
</summary>
<param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param>
</member>
<member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])">
<summary>
Initializes a new instance of the <c>LevelCollection</c> class
that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array.
</summary>
<param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param>
</member>
<member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)">
<summary>
Initializes a new instance of the <c>LevelCollection</c> class
that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection.
</summary>
<param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param>
</member>
<member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)">
<summary>
Allow subclasses to avoid our default constructors
</summary>
<param name="tag"></param>
</member>
<member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])">
<summary>
Copies the entire <c>LevelCollection</c> to a one-dimensional
<see cref="T:log4net.Core.Level"/> array.
</summary>
<param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
</member>
<member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)">
<summary>
Copies the entire <c>LevelCollection</c> to a one-dimensional
<see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
<param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)">
<summary>
Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param>
<returns>The index at which the value has been added.</returns>
</member>
<member name="M:log4net.Core.LevelCollection.Clear">
<summary>
Removes all elements from the <c>LevelCollection</c>.
</summary>
</member>
<member name="M:log4net.Core.LevelCollection.Clone">
<summary>
Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>.
</summary>
<returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns>
</member>
<member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)">
<summary>
Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param>
<returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)">
<summary>
Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/>
in the <c>LevelCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param>
<returns>
The zero-based index of the first occurrence of <paramref name="item"/>
in the entire <c>LevelCollection</c>, if found; otherwise, -1.
</returns>
</member>
<member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)">
<summary>
Inserts an element into the <c>LevelCollection</c> at the specified index.
</summary>
<param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
<param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="index"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
</exception>
</member>
<member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)">
<summary>
Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param>
<exception cref="T:System.ArgumentException">
The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>.
</exception>
</member>
<member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)">
<summary>
Removes the element at the specified index of the <c>LevelCollection</c>.
</summary>
<param name="index">The zero-based index of the element to remove.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="index"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
</exception>
</member>
<member name="M:log4net.Core.LevelCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the <c>LevelCollection</c>.
</summary>
<returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns>
</member>
<member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)">
<summary>
Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>.
</summary>
<param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param>
<returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
</member>
<member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])">
<summary>
Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>.
</summary>
<param name="x">The <see cref="T:log4net.Core.Level"/> array whose elements should be added to the end of the <c>LevelCollection</c>.</param>
<returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
</member>
<member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)">
<summary>
Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>.
</summary>
<param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements should be added to the end of the <c>LevelCollection</c>.</param>
<returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
</member>
<member name="M:log4net.Core.LevelCollection.TrimToSize">
<summary>
Sets the capacity to the actual number of elements.
</summary>
</member>
<member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)">
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="i"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
</exception>
</member>
<member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)">
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="i"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
</exception>
</member>
<member name="P:log4net.Core.LevelCollection.Count">
<summary>
Gets the number of elements actually contained in the <c>LevelCollection</c>.
</summary>
</member>
<member name="P:log4net.Core.LevelCollection.IsSynchronized">
<summary>
Gets a value indicating whether access to the collection is synchronized (thread-safe).
</summary>
<value>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</value>
</member>
<member name="P:log4net.Core.LevelCollection.SyncRoot">
<summary>
Gets an object that can be used to synchronize access to the collection.
</summary>
</member>
<member name="P:log4net.Core.LevelCollection.Item(System.Int32)">
<summary>
Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="index"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
</exception>
</member>
<member name="P:log4net.Core.LevelCollection.IsFixedSize">
<summary>
Gets a value indicating whether the collection has a fixed size.
</summary>
<value>true if the collection has a fixed size; otherwise, false. The default is false</value>
</member>
<member name="P:log4net.Core.LevelCollection.IsReadOnly">
<summary>
Gets a value indicating whether the IList is read-only.
</summary>
<value>true if the collection is read-only; otherwise, false. The default is false</value>
</member>
<member name="P:log4net.Core.LevelCollection.Capacity">
<summary>
Gets or sets the number of elements the <c>LevelCollection</c> can contain.
</summary>
</member>
<member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator">
<summary>
Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
</summary>
</member>
<member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element in the collection.
</summary>
<returns>
<c>true</c> if the enumerator was successfully advanced to the next element;
<c>false</c> if the enumerator has passed the end of the collection.
</returns>
<exception cref="T:System.InvalidOperationException">
The collection was modified after the enumerator was created.
</exception>
</member>
<member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, before the first element in the collection.
</summary>
</member>
<member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
</member>
<member name="T:log4net.Core.LevelCollection.Tag">
<summary>
Type visible only to our subclasses
Used to access protected constructor
</summary>
</member>
<member name="F:log4net.Core.LevelCollection.Tag.Default">
<summary>
A value
</summary>
</member>
<member name="T:log4net.Core.LevelCollection.Enumerator">
<summary>
Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
</summary>
</member>
<member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)">
<summary>
Initializes a new instance of the <c>Enumerator</c> class.
</summary>
<param name="tc"></param>
</member>
<member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext">
<summary>
Advances the enumerator to the next element in the collection.
</summary>
<returns>
<c>true</c> if the enumerator was successfully advanced to the next element;
<c>false</c> if the enumerator has passed the end of the collection.
</returns>
<exception cref="T:System.InvalidOperationException">
The collection was modified after the enumerator was created.
</exception>
</member>
<member name="M:log4net.Core.LevelCollection.Enumerator.Reset">
<summary>
Sets the enumerator to its initial position, before the first element in the collection.
</summary>
</member>
<member name="P:log4net.Core.LevelCollection.Enumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
</member>
<member name="T:log4net.Core.LevelEvaluator">
<summary>
An evaluator that triggers at a threshold level
</summary>
<remarks>
<para>
This evaluator will trigger if the level of the event
passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
level.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Core.LevelEvaluator.m_threshold">
<summary>
The threshold for triggering
</summary>
</member>
<member name="M:log4net.Core.LevelEvaluator.#ctor">
<summary>
Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
</summary>
<remarks>
<para>
Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
</para>
<para>
This evaluator will trigger if the level of the event
passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
level.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)">
<summary>
Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
</summary>
<param name="threshold">the threshold to trigger at</param>
<remarks>
<para>
Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
</para>
<para>
This evaluator will trigger if the level of the event
passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
level.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
<summary>
Is this <paramref name="loggingEvent"/> the triggering event?
</summary>
<param name="loggingEvent">The event to check</param>
<returns>This method returns <c>true</c>, if the event level
is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>.
Otherwise it returns <c>false</c></returns>
<remarks>
<para>
This evaluator will trigger if the level of the event
passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
level.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LevelEvaluator.Threshold">
<summary>
the threshold to trigger at
</summary>
<value>
The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger
</value>
<remarks>
<para>
This evaluator will trigger if the level of the event
passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
level.
</para>
</remarks>
</member>
<member name="T:log4net.Core.LevelMap">
<summary>
Mapping between string name and Level object
</summary>
<remarks>
<para>
Mapping between string name and <see cref="T:log4net.Core.Level"/> object.
This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>.
The level name is case insensitive.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Core.LevelMap.m_mapName2Level">
<summary>
Mapping from level name to Level object. The
level name is case insensitive
</summary>
</member>
<member name="M:log4net.Core.LevelMap.#ctor">
<summary>
Construct the level map
</summary>
<remarks>
<para>
Construct the level map.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LevelMap.Clear">
<summary>
Clear the internal maps of all levels
</summary>
<remarks>
<para>
Clear the internal maps of all levels
</para>
</remarks>
</member>
<member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)">
<summary>
Create a new Level and add it to the map
</summary>
<param name="name">the string to display for the Level</param>
<param name="value">the level value to give to the Level</param>
<remarks>
<para>
Create a new Level and add it to the map
</para>
</remarks>
<seealso cref="M:Add(string,int,string)"/>
</member>
<member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)">
<summary>
Create a new Level and add it to the map
</summary>
<param name="name">the string to display for the Level</param>
<param name="value">the level value to give to the Level</param>
<param name="displayName">the display name to give to the Level</param>
<remarks>
<para>
Create a new Level and add it to the map
</para>
</remarks>
</member>
<member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)">
<summary>
Add a Level to the map
</summary>
<param name="level">the Level to add</param>
<remarks>
<para>
Add a Level to the map
</para>
</remarks>
</member>
<member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)">
<summary>
Lookup a named level from the map
</summary>
<param name="defaultLevel">the name of the level to lookup is taken from this level.
If the level is not set on the map then this level is added</param>
<returns>the level in the map with the name specified</returns>
<remarks>
<para>
Lookup a named level from the map. The name of the level to lookup is taken
from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/>
argument.
</para>
<para>
If no level with the specified name is found then the
<paramref name="defaultLevel"/> argument is added to the level map
and returned.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LevelMap.Item(System.String)">
<summary>
Lookup a <see cref="T:log4net.Core.Level"/> by name
</summary>
<param name="name">The name of the Level to lookup</param>
<returns>a Level from the map with the name specified</returns>
<remarks>
<para>
Returns the <see cref="T:log4net.Core.Level"/> from the
map with the name specified. If the no level is
found then <c>null</c> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LevelMap.AllLevels">
<summary>
Return all possible levels as a list of Level objects.
</summary>
<returns>all possible levels as a list of Level objects</returns>
<remarks>
<para>
Return all possible levels as a list of Level objects.
</para>
</remarks>
</member>
<member name="T:log4net.Core.LocationInfo">
<summary>
The internal representation of caller location information.
</summary>
<remarks>
<para>
This class uses the <c>System.Diagnostics.StackTrace</c> class to generate
a call stack. The caller's information is then extracted from this stack.
</para>
<para>
The <c>System.Diagnostics.StackTrace</c> class is not supported on the
.NET Compact Framework 1.0 therefore caller location information is not
available on that framework.
</para>
<para>
The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
</para>
<para>
"StackTrace information will be most informative with Debug build configurations.
By default, Debug builds include debug symbols, while Release builds do not. The
debug symbols contain most of the file, method name, line number, and column
information used in constructing StackFrame and StackTrace objects. StackTrace
might not report as many method calls as expected, due to code transformations
that occur during optimization."
</para>
<para>
This means that in a Release build the caller information may be incomplete or may
not exist at all! Therefore caller location information cannot be relied upon in a Release build.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Core.LocationInfo.NA">
<summary>
When location information is not available the constant
<c>NA</c> is returned. Current value of this string
constant is <b>?</b>.
</summary>
</member>
<member name="M:log4net.Core.LocationInfo.#ctor(System.Type)">
<summary>
Constructor
</summary>
<param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
the stack boundary into the logging system for this call.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
class based on the current thread.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)">
<summary>
Constructor
</summary>
<param name="className">The fully qualified class name.</param>
<param name="methodName">The method name.</param>
<param name="fileName">The file name.</param>
<param name="lineNumber">The line number of the method within the file.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
class with the specified data.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LocationInfo.declaringType">
<summary>
The fully qualified type of the LocationInfo class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Core.LocationInfo.ClassName">
<summary>
Gets the fully qualified class name of the caller making the logging
request.
</summary>
<value>
The fully qualified class name of the caller making the logging
request.
</value>
<remarks>
<para>
Gets the fully qualified class name of the caller making the logging
request.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LocationInfo.FileName">
<summary>
Gets the file name of the caller.
</summary>
<value>
The file name of the caller.
</value>
<remarks>
<para>
Gets the file name of the caller.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LocationInfo.LineNumber">
<summary>
Gets the line number of the caller.
</summary>
<value>
The line number of the caller.
</value>
<remarks>
<para>
Gets the line number of the caller.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LocationInfo.MethodName">
<summary>
Gets the method name of the caller.
</summary>
<value>
The method name of the caller.
</value>
<remarks>
<para>
Gets the method name of the caller.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LocationInfo.FullInfo">
<summary>
Gets all available caller information
</summary>
<value>
All available caller information, in the format
<c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
</value>
<remarks>
<para>
Gets all available caller information, in the format
<c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
</para>
</remarks>
</member>
<member name="P:log4net.Core.LocationInfo.StackFrames">
<summary>
Gets the stack frames from the stack trace of the caller making the log request
</summary>
</member>
<member name="T:log4net.Core.LoggerManager">
<summary>
Static manager that controls the creation of repositories
</summary>
<remarks>
<para>
Static manager that controls the creation of repositories
</para>
<para>
This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
</para>
<para>
This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
lookup and create repositories. The selector can be set either programmatically using
the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
AppSetting in the applications config file to the fully qualified type name of the
selector to use.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.LoggerManager.#ctor">
<summary>
Private constructor to prevent instances. Only static methods should be used.
</summary>
<remarks>
<para>
Private constructor to prevent instances. Only static methods should be used.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.#cctor">
<summary>
Hook the shutdown event
</summary>
<remarks>
<para>
On the full .NET runtime, the static constructor hooks up the
<c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events.
These are used to shutdown the log4net system as the application exits.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents">
<summary>
Register for ProcessExit and DomainUnload events on the AppDomain
</summary>
<remarks>
<para>
This needs to be in a separate method because the events make
a LinkDemand for the ControlAppDomain SecurityPermission. Because
this is a LinkDemand it is demanded at JIT time. Therefore we cannot
catch the exception in the method itself, we have to catch it in the
caller.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)">
<summary>
Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<param name="repository">the repository to lookup in</param>
<returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
by the <paramref name="repository"/> argument.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)">
<summary>
Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
</member>
<member name="M:log4net.Core.LoggerManager.GetRepository(System.String)">
<summary>
Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<param name="repository">the repository to lookup in</param>
<returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
by the <paramref name="repository"/> argument.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)">
<summary>
Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
<remarks>
<para>
Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)">
<summary>
Returns the named logger if it exists.
</summary>
<param name="repository">The repository to lookup in.</param>
<param name="name">The fully qualified logger name to look for.</param>
<returns>
The logger found, or <c>null</c> if the named logger does not exist in the
specified repository.
</returns>
<remarks>
<para>
If the named logger exists (in the specified repository) then it
returns a reference to the logger, otherwise it returns
<c>null</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)">
<summary>
Returns the named logger if it exists.
</summary>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<param name="name">The fully qualified logger name to look for.</param>
<returns>
The logger found, or <c>null</c> if the named logger does not exist in the
specified assembly's repository.
</returns>
<remarks>
<para>
If the named logger exists (in the specified assembly's repository) then it
returns a reference to the logger, otherwise it returns
<c>null</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)">
<summary>
Returns all the currently defined loggers in the specified repository.
</summary>
<param name="repository">The repository to lookup in.</param>
<returns>All the defined loggers.</returns>
<remarks>
<para>
The root logger is <b>not</b> included in the returned array.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)">
<summary>
Returns all the currently defined loggers in the specified assembly's repository.
</summary>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<returns>All the defined loggers.</returns>
<remarks>
<para>
The root logger is <b>not</b> included in the returned array.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)">
<summary>
Retrieves or creates a named logger.
</summary>
<param name="repository">The repository to lookup in.</param>
<param name="name">The name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
<remarks>
<para>
Retrieves a logger named as the <paramref name="name"/>
parameter. If the named logger already exists, then the
existing instance will be returned. Otherwise, a new instance is
created.
</para>
<para>
By default, loggers do not have a set level but inherit
it from the hierarchy. This is one of the central features of
log4net.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)">
<summary>
Retrieves or creates a named logger.
</summary>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<param name="name">The name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
<remarks>
<para>
Retrieves a logger named as the <paramref name="name"/>
parameter. If the named logger already exists, then the
existing instance will be returned. Otherwise, a new instance is
created.
</para>
<para>
By default, loggers do not have a set level but inherit
it from the hierarchy. This is one of the central features of
log4net.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)">
<summary>
Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
</summary>
<param name="repository">The repository to lookup in.</param>
<param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
<remarks>
<para>
Gets the logger for the fully qualified name of the type specified.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)">
<summary>
Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
</summary>
<param name="repositoryAssembly">the assembly to use to lookup the repository</param>
<param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
<remarks>
<para>
Gets the logger for the fully qualified name of the type specified.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.Shutdown">
<summary>
Shuts down the log4net system.
</summary>
<remarks>
<para>
Calling this method will <b>safely</b> close and remove all
appenders in all the loggers including root contained in all the
default repositories.
</para>
<para>
Some appenders need to be closed before the application exists.
Otherwise, pending logging events might be lost.
</para>
<para>
The <c>shutdown</c> method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)">
<summary>
Shuts down the repository for the repository specified.
</summary>
<param name="repository">The repository to shutdown.</param>
<remarks>
<para>
Calling this method will <b>safely</b> close and remove all
appenders in all the loggers including root contained in the
repository for the <paramref name="repository"/> specified.
</para>
<para>
Some appenders need to be closed before the application exists.
Otherwise, pending logging events might be lost.
</para>
<para>
The <c>shutdown</c> method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)">
<summary>
Shuts down the repository for the repository specified.
</summary>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<remarks>
<para>
Calling this method will <b>safely</b> close and remove all
appenders in all the loggers including root contained in the
repository for the repository. The repository is looked up using
the <paramref name="repositoryAssembly"/> specified.
</para>
<para>
Some appenders need to be closed before the application exists.
Otherwise, pending logging events might be lost.
</para>
<para>
The <c>shutdown</c> method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)">
<summary>
Resets all values contained in this repository instance to their defaults.
</summary>
<param name="repository">The repository to reset.</param>
<remarks>
<para>
Resets all values contained in the repository instance to their
defaults. This removes all appenders from all loggers, sets
the level of all non-root loggers to <c>null</c>,
sets their additivity flag to <c>true</c> and sets the level
of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
message disabling is set its default "off" value.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)">
<summary>
Resets all values contained in this repository instance to their defaults.
</summary>
<param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
<remarks>
<para>
Resets all values contained in the repository instance to their
defaults. This removes all appenders from all loggers, sets
the level of all non-root loggers to <c>null</c>,
sets their additivity flag to <c>true</c> and sets the level
of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
message disabling is set its default "off" value.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)">
<summary>
Creates a repository with the specified name.
</summary>
<param name="repository">The name of the repository, this must be unique amongst repositories.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<remarks>
<para>
<b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
</para>
<para>
Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
<see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
</para>
<para>
The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
</para>
</remarks>
<exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
</member>
<member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)">
<summary>
Creates a repository with the specified name.
</summary>
<param name="repository">The name of the repository, this must be unique amongst repositories.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<remarks>
<para>
Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
<see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
</para>
<para>
The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
</para>
</remarks>
<exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
</member>
<member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)">
<summary>
Creates a repository with the specified name and repository type.
</summary>
<param name="repository">The name of the repository, this must be unique to the repository.</param>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<remarks>
<para>
<b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
</para>
<para>
The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
An Exception will be thrown if the repository already exists.
</para>
</remarks>
<exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
</member>
<member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)">
<summary>
Creates a repository with the specified name and repository type.
</summary>
<param name="repository">The name of the repository, this must be unique to the repository.</param>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<remarks>
<para>
The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
An Exception will be thrown if the repository already exists.
</para>
</remarks>
<exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
</member>
<member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)">
<summary>
Creates a repository for the specified assembly and repository type.
</summary>
<param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<remarks>
<para>
<b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
</para>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
same assembly specified will return the same repository instance.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)">
<summary>
Creates a repository for the specified assembly and repository type.
</summary>
<param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
same assembly specified will return the same repository instance.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetAllRepositories">
<summary>
Gets an array of all currently defined repositories.
</summary>
<returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
<remarks>
<para>
Gets an array of all currently defined repositories.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.GetVersionInfo">
<summary>
Internal method to get pertinent version info.
</summary>
<returns>A string of version info.</returns>
</member>
<member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
<summary>
Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires
</summary>
<param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
<param name="e">null</param>
<remarks>
<para>
Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires.
</para>
<para>
When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
<summary>
Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires
</summary>
<param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
<param name="e">null</param>
<remarks>
<para>
Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires.
</para>
<para>
When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggerManager.declaringType">
<summary>
The fully qualified type of the LoggerManager class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="F:log4net.Core.LoggerManager.s_repositorySelector">
<summary>
Initialize the default repository selector
</summary>
</member>
<member name="P:log4net.Core.LoggerManager.RepositorySelector">
<summary>
Gets or sets the repository selector used by the <see cref="T:log4net.LogManager"/>.
</summary>
<value>
The repository selector used by the <see cref="T:log4net.LogManager"/>.
</value>
<remarks>
<para>
The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by
the <see cref="T:log4net.LogManager"/> to create and select repositories
(<see cref="T:log4net.Repository.ILoggerRepository"/>).
</para>
<para>
The caller to <see cref="T:log4net.LogManager"/> supplies either a string name
or an assembly (if not supplied the assembly is inferred using
<see cref="M:Assembly.GetCallingAssembly()"/>).
</para>
<para>
This context is used by the selector to lookup a specific repository.
</para>
<para>
For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>;
for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default
repository.
</para>
</remarks>
</member>
<member name="T:log4net.Core.LoggerWrapperImpl">
<summary>
Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface.
</summary>
<remarks>
<para>
This class should be used as the base for all wrapper implementations.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)">
<summary>
Constructs a new wrapper for the specified logger.
</summary>
<param name="logger">The logger to wrap.</param>
<remarks>
<para>
Constructs a new wrapper for the specified logger.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggerWrapperImpl.m_logger">
<summary>
The logger that this object is wrapping
</summary>
</member>
<member name="P:log4net.Core.LoggerWrapperImpl.Logger">
<summary>
Gets the implementation behind this wrapper object.
</summary>
<value>
The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing.
</value>
<remarks>
<para>
The <c>Logger</c> object may not be the same object as this object
because of logger decorators.
</para>
<para>
This gets the actual underlying objects that is used to process
the log events.
</para>
</remarks>
</member>
<member name="T:log4net.Core.LoggingEventData">
<summary>
Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
</summary>
<remarks>
<para>
Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Core.LoggingEventData.LoggerName">
<summary>
The logger name.
</summary>
<remarks>
<para>
The logger name.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.Level">
<summary>
Level of logging event.
</summary>
<remarks>
<para>
Level of logging event. Level cannot be Serializable
because it is a flyweight. Due to its special serialization it
cannot be declared final either.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.Message">
<summary>
The application supplied message.
</summary>
<remarks>
<para>
The application supplied message of logging event.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.ThreadName">
<summary>
The name of thread
</summary>
<remarks>
<para>
The name of thread in which this logging event was generated
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.TimeStamp">
<summary>
The time the event was logged
</summary>
<remarks>
<para>
The TimeStamp is stored in the local time zone for this computer.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.LocationInfo">
<summary>
Location information for the caller.
</summary>
<remarks>
<para>
Location information for the caller.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.UserName">
<summary>
String representation of the user
</summary>
<remarks>
<para>
String representation of the user's windows name,
like DOMAIN\username
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.Identity">
<summary>
String representation of the identity.
</summary>
<remarks>
<para>
String representation of the current thread's principal identity.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.ExceptionString">
<summary>
The string representation of the exception
</summary>
<remarks>
<para>
The string representation of the exception
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.Domain">
<summary>
String representation of the AppDomain.
</summary>
<remarks>
<para>
String representation of the AppDomain.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEventData.Properties">
<summary>
Additional event specific properties
</summary>
<remarks>
<para>
A logger or an appender may attach additional
properties to specific events. These properties
have a string key and an object value.
</para>
</remarks>
</member>
<member name="T:log4net.Core.FixFlags">
<summary>
Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
</summary>
<remarks>
<para>
Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Core.FixFlags.Mdc">
<summary>
Fix the MDC
</summary>
</member>
<member name="F:log4net.Core.FixFlags.Ndc">
<summary>
Fix the NDC
</summary>
</member>
<member name="F:log4net.Core.FixFlags.Message">
<summary>
Fix the rendered message
</summary>
</member>
<member name="F:log4net.Core.FixFlags.ThreadName">
<summary>
Fix the thread name
</summary>
</member>
<member name="F:log4net.Core.FixFlags.LocationInfo">
<summary>
Fix the callers location information
</summary>
<remarks>
CAUTION: Very slow to generate
</remarks>
</member>
<member name="F:log4net.Core.FixFlags.UserName">
<summary>
Fix the callers windows user name
</summary>
<remarks>
CAUTION: Slow to generate
</remarks>
</member>
<member name="F:log4net.Core.FixFlags.Domain">
<summary>
Fix the domain friendly name
</summary>
</member>
<member name="F:log4net.Core.FixFlags.Identity">
<summary>
Fix the callers principal name
</summary>
<remarks>
CAUTION: May be slow to generate
</remarks>
</member>
<member name="F:log4net.Core.FixFlags.Exception">
<summary>
Fix the exception text
</summary>
</member>
<member name="F:log4net.Core.FixFlags.Properties">
<summary>
Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing.
</summary>
</member>
<member name="F:log4net.Core.FixFlags.None">
<summary>
No fields fixed
</summary>
</member>
<member name="F:log4net.Core.FixFlags.All">
<summary>
All fields fixed
</summary>
</member>
<member name="F:log4net.Core.FixFlags.Partial">
<summary>
Partial fields fixed
</summary>
<remarks>
<para>
This set of partial fields gives good performance. The following fields are fixed:
</para>
<list type="bullet">
<item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item>
<item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item>
<item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item>
<item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item>
<item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item>
</list>
</remarks>
</member>
<member name="T:log4net.Core.LoggingEvent">
<summary>
The internal representation of logging events.
</summary>
<remarks>
<para>
When an affirmative decision is made to log then a
<see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance
is passed around to the different log4net components.
</para>
<para>
This class is of concern to those wishing to extend log4net.
</para>
<para>
Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
are considered volatile, that is the values are correct at the
time the event is delivered to appenders, but will not be consistent
at any time afterwards. If an event is to be stored and then processed
at a later time these volatile values must be fixed by calling
<see cref="M:FixVolatileData()"/>. There is a performance penalty
for incurred by calling <see cref="M:FixVolatileData()"/> but it
is essential to maintaining data consistency.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Douglas de la Torre</author>
<author>Daniel Cazzulino</author>
</member>
<member name="F:log4net.Core.LoggingEvent.HostNameProperty">
<summary>
The key into the Properties map for the host name value.
</summary>
</member>
<member name="F:log4net.Core.LoggingEvent.IdentityProperty">
<summary>
The key into the Properties map for the thread identity value.
</summary>
</member>
<member name="F:log4net.Core.LoggingEvent.UserNameProperty">
<summary>
The key into the Properties map for the user name value.
</summary>
</member>
<member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
from the supplied parameters.
</summary>
<param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
the stack boundary into the logging system for this call.</param>
<param name="repository">The repository this event is logged in.</param>
<param name="loggerName">The name of the logger of this event.</param>
<param name="level">The level of this event.</param>
<param name="message">The message of this event.</param>
<param name="exception">The exception for this event.</param>
<remarks>
<para>
Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>,
all fields of <c>LoggingEvent</c> are filled when actually needed. Call
<see cref="M:FixVolatileData()"/> to cache all data locally
to prevent inconsistencies.
</para>
<para>This method is called by the log4net framework
to create a logging event.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
using specific data.
</summary>
<param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
the stack boundary into the logging system for this call.</param>
<param name="repository">The repository this event is logged in.</param>
<param name="data">Data used to initialize the logging event.</param>
<param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
<remarks>
<para>
This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
to be created independently of the log4net framework. This can
be useful if you require a custom serialization scheme.
</para>
<para>
Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
</para>
<para>
The <paramref name="fixedData"/> parameter should be used to specify which fields in the
<paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
will be captured from the environment if requested or fixed.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
using specific data.
</summary>
<param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
the stack boundary into the logging system for this call.</param>
<param name="repository">The repository this event is logged in.</param>
<param name="data">Data used to initialize the logging event.</param>
<remarks>
<para>
This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
to be created independently of the log4net framework. This can
be useful if you require a custom serialization scheme.
</para>
<para>
Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
</para>
<para>
This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
parameter and no other data should be captured from the environment.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
using specific data.
</summary>
<param name="data">Data used to initialize the logging event.</param>
<remarks>
<para>
This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
to be created independently of the log4net framework. This can
be useful if you require a custom serialization scheme.
</para>
<para>
Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
</para>
<para>
This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
parameter and no other data should be captured from the environment.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Serialization constructor
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
with serialized data.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)">
<summary>
Ensure that the repository is set.
</summary>
<param name="repository">the value for the repository</param>
</member>
<member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)">
<summary>
Write the rendered message to a TextWriter
</summary>
<param name="writer">the writer to write the message to</param>
<remarks>
<para>
Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method
does store the message data in the internal cache. Therefore
if called only once this method should be faster than the
<see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is
to be accessed multiple times then the property will be more efficient.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
<param name="context">The destination for this serialization.</param>
<remarks>
<para>
The data in this event must be fixed before it can be serialized.
</para>
<para>
The <see cref="M:FixVolatileData()"/> method must be called during the
<see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event
is to be used outside that method.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.GetLoggingEventData">
<summary>
Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
</summary>
<returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
<remarks>
<para>
A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
<see cref="T:log4net.Core.LoggingEventData"/> instance.
</para>
<para>
Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data
in the logging event before returning the event data.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)">
<summary>
Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
</summary>
<param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param>
<returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
<remarks>
<para>
A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
<see cref="T:log4net.Core.LoggingEventData"/> instance.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep">
<summary>
Returns this event's exception's rendered using the
<see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
</summary>
<returns>
This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
</returns>
<remarks>
<para>
<b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b>
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.GetExceptionString">
<summary>
Returns this event's exception's rendered using the
<see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
</summary>
<returns>
This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
</returns>
<remarks>
<para>
Returns this event's exception's rendered using the
<see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.FixVolatileData">
<summary>
Fix instance fields that hold volatile data.
</summary>
<remarks>
<para>
Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
are considered volatile, that is the values are correct at the
time the event is delivered to appenders, but will not be consistent
at any time afterwards. If an event is to be stored and then processed
at a later time these volatile values must be fixed by calling
<see cref="M:FixVolatileData()"/>. There is a performance penalty
incurred by calling <see cref="M:FixVolatileData()"/> but it
is essential to maintaining data consistency.
</para>
<para>
Calling <see cref="M:FixVolatileData()"/> is equivalent to
calling <see cref="M:FixVolatileData(bool)"/> passing the parameter
<c>false</c>.
</para>
<para>
See <see cref="M:FixVolatileData(bool)"/> for more
information.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)">
<summary>
Fixes instance fields that hold volatile data.
</summary>
<param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param>
<remarks>
<para>
Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
are considered volatile, that is the values are correct at the
time the event is delivered to appenders, but will not be consistent
at any time afterwards. If an event is to be stored and then processed
at a later time these volatile values must be fixed by calling
<see cref="M:FixVolatileData()"/>. There is a performance penalty
for incurred by calling <see cref="M:FixVolatileData()"/> but it
is essential to maintaining data consistency.
</para>
<para>
The <paramref name="fastButLoose"/> param controls the data that
is fixed. Some of the data that can be fixed takes a long time to
generate, therefore if you do not require those settings to be fixed
they can be ignored by setting the <paramref name="fastButLoose"/> param
to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/>
and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings.
</para>
<para>
Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all
settings are fixed.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)">
<summary>
Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter
</summary>
<param name="flags">the fields to fix</param>
<remarks>
<para>
Only fields specified in the <paramref name="flags"/> will be fixed.
Fields will not be fixed if they have previously been fixed.
It is not possible to 'unfix' a field.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)">
<summary>
Lookup a composite property in this event
</summary>
<param name="key">the key for the property to lookup</param>
<returns>the value for the property</returns>
<remarks>
<para>
This event has composite properties that combine together properties from
several different contexts in the following order:
<list type="definition">
<item>
<term>this events properties</term>
<description>
This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
properties are specific to this event only.
</description>
</item>
<item>
<term>the thread properties</term>
<description>
The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
thread. These properties are shared by all events logged on this thread.
</description>
</item>
<item>
<term>the global properties</term>
<description>
The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
properties are shared by all the threads in the AppDomain.
</description>
</item>
</list>
</para>
</remarks>
</member>
<member name="M:log4net.Core.LoggingEvent.GetProperties">
<summary>
Get all the composite properties in this event
</summary>
<returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns>
<remarks>
<para>
See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties
stored by the event.
</para>
<para>
This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the
properties defined for this event.
</para>
</remarks>
</member>
<member name="F:log4net.Core.LoggingEvent.m_data">
<summary>
The internal logging event data.
</summary>
</member>
<member name="F:log4net.Core.LoggingEvent.m_compositeProperties">
<summary>
The internal logging event data.
</summary>
</member>
<member name="F:log4net.Core.LoggingEvent.m_eventProperties">
<summary>
The internal logging event data.
</summary>
</member>
<member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType">
<summary>
The fully qualified Type of the calling
logger class in the stack frame (i.e. the declaring type of the method).
</summary>
</member>
<member name="F:log4net.Core.LoggingEvent.m_message">
<summary>
The application supplied message of logging event.
</summary>
</member>
<member name="F:log4net.Core.LoggingEvent.m_thrownException">
<summary>
The exception that was thrown.
</summary>
<remarks>
This is not serialized. The string representation
is serialized instead.
</remarks>
</member>
<member name="F:log4net.Core.LoggingEvent.m_repository">
<summary>
The repository that generated the logging event
</summary>
<remarks>
This is not serialized.
</remarks>
</member>
<member name="F:log4net.Core.LoggingEvent.m_fixFlags">
<summary>
The fix state for this event
</summary>
<remarks>
These flags indicate which fields have been fixed.
Not serialized.
</remarks>
</member>
<member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
<summary>
Indicated that the internal cache is updateable (ie not fixed)
</summary>
<remarks>
This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
changes in the caching strategy.
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.StartTime">
<summary>
Gets the time when the current process started.
</summary>
<value>
This is the time when this process started.
</value>
<remarks>
<para>
The TimeStamp is stored in the local time zone for this computer.
</para>
<para>
Tries to get the start time for the current process.
Failing that it returns the time of the first call to
this property.
</para>
<para>
Note that AppDomains may be loaded and unloaded within the
same process without the process terminating and therefore
without the process start time being reset.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.Level">
<summary>
Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
</summary>
<value>
The <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
</value>
<remarks>
<para>
Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.TimeStamp">
<summary>
Gets the time of the logging event.
</summary>
<value>
The time of the logging event.
</value>
<remarks>
<para>
The TimeStamp is stored in the local time zone for this computer.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.LoggerName">
<summary>
Gets the name of the logger that logged the event.
</summary>
<value>
The name of the logger that logged the event.
</value>
<remarks>
<para>
Gets the name of the logger that logged the event.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.LocationInformation">
<summary>
Gets the location information for this logging event.
</summary>
<value>
The location information for this logging event.
</value>
<remarks>
<para>
The collected information is cached for future use.
</para>
<para>
See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on
supported frameworks and the different behavior in Debug and
Release builds.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.MessageObject">
<summary>
Gets the message object used to initialize this event.
</summary>
<value>
The message object used to initialize this event.
</value>
<remarks>
<para>
Gets the message object used to initialize this event.
Note that this event may not have a valid message object.
If the event is serialized the message object will not
be transferred. To get the text of the message the
<see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used
not this property.
</para>
<para>
If there is no defined message object for this event then
null will be returned.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.ExceptionObject">
<summary>
Gets the exception object used to initialize this event.
</summary>
<value>
The exception object used to initialize this event.
</value>
<remarks>
<para>
Gets the exception object used to initialize this event.
Note that this event may not have a valid exception object.
If the event is serialized the exception object will not
be transferred. To get the text of the exception the
<see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used
not this property.
</para>
<para>
If there is no defined exception object for this event then
null will be returned.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.Repository">
<summary>
The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
</summary>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.RenderedMessage">
<summary>
Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
</summary>
<value>
The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
</value>
<remarks>
<para>
The collected information is cached for future use.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.ThreadName">
<summary>
Gets the name of the current thread.
</summary>
<value>
The name of the current thread, or the thread ID when
the name is not available.
</value>
<remarks>
<para>
The collected information is cached for future use.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.UserName">
<summary>
Gets the name of the current user.
</summary>
<value>
The name of the current user, or <c>NOT AVAILABLE</c> when the
underlying runtime has no support for retrieving the name of the
current user.
</value>
<remarks>
<para>
Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of
the current windows user.
</para>
<para>
To improve performance, we could cache the string representation of
the name, and reuse that as long as the identity stayed constant.
Once the identity changed, we would need to re-assign and re-render
the string.
</para>
<para>
However, the <c>WindowsIdentity.GetCurrent()</c> call seems to
return different objects every time, so the current implementation
doesn't do this type of caching.
</para>
<para>
Timing for these operations:
</para>
<list type="table">
<listheader>
<term>Method</term>
<description>Results</description>
</listheader>
<item>
<term><c>WindowsIdentity.GetCurrent()</c></term>
<description>10000 loops, 00:00:00.2031250 seconds</description>
</item>
<item>
<term><c>WindowsIdentity.GetCurrent().Name</c></term>
<description>10000 loops, 00:00:08.0468750 seconds</description>
</item>
</list>
<para>
This means we could speed things up almost 40 times by caching the
value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since
this takes (8.04-0.20) = 7.84375 seconds.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.Identity">
<summary>
Gets the identity of the current thread principal.
</summary>
<value>
The string name of the identity of the current thread principal.
</value>
<remarks>
<para>
Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get
the name of the current thread principal.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.Domain">
<summary>
Gets the AppDomain friendly name.
</summary>
<value>
The AppDomain friendly name.
</value>
<remarks>
<para>
Gets the AppDomain friendly name.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.Properties">
<summary>
Additional event specific properties.
</summary>
<value>
Additional event specific properties.
</value>
<remarks>
<para>
A logger or an appender may attach additional
properties to specific events. These properties
have a string key and an object value.
</para>
<para>
This property is for events that have been added directly to
this event. The aggregate properties (which include these
event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/>
and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>.
</para>
<para>
Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property
returns the combined cached properties. This ensures that updates to
this property are always reflected in the underlying storage. When
returning the combined properties there may be more keys in the
Dictionary than expected.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LoggingEvent.Fix">
<summary>
The fixed fields in this event
</summary>
<value>
The set of fields that are fixed in this event
</value>
<remarks>
<para>
Fields will not be fixed if they have previously been fixed.
It is not possible to 'unfix' a field.
</para>
</remarks>
</member>
<member name="T:log4net.Core.LogImpl">
<summary>
Implementation of <see cref="T:log4net.ILog"/> wrapper interface.
</summary>
<remarks>
<para>
This implementation of the <see cref="T:log4net.ILog"/> interface
forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class.
</para>
<para>
This logger has methods to allow the caller to log at the following
levels:
</para>
<list type="definition">
<item>
<term>DEBUG</term>
<description>
The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages
at the <c>DEBUG</c> level. That is the level with that name defined in the
repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
property tests if this level is enabled for logging.
</description>
</item>
<item>
<term>INFO</term>
<description>
The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages
at the <c>INFO</c> level. That is the level with that name defined in the
repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/>
property tests if this level is enabled for logging.
</description>
</item>
<item>
<term>WARN</term>
<description>
The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages
at the <c>WARN</c> level. That is the level with that name defined in the
repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/>
property tests if this level is enabled for logging.
</description>
</item>
<item>
<term>ERROR</term>
<description>
The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages
at the <c>ERROR</c> level. That is the level with that name defined in the
repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/>
property tests if this level is enabled for logging.
</description>
</item>
<item>
<term>FATAL</term>
<description>
The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages
at the <c>FATAL</c> level. That is the level with that name defined in the
repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/>
property tests if this level is enabled for logging.
</description>
</item>
</list>
<para>
The values for these levels and their semantic meanings can be changed by
configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.ILog">
<summary>
The ILog interface is use by application to log messages into
the log4net framework.
</summary>
<remarks>
<para>
Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/>
static method is used to get logger instances.
</para>
<para>
This class contains methods for logging at different levels and also
has properties for determining if those logging levels are
enabled in the current configuration.
</para>
<para>
This interface can be implemented in different ways. This documentation
specifies reasonable behavior that a caller can expect from the actual
implementation, however different implementations reserve the right to
do things differently.
</para>
</remarks>
<example>Simple example of logging messages
<code lang="C#">
ILog log = LogManager.GetLogger("application-log");
log.Info("Application Start");
log.Debug("This is a debug message");
if (log.IsDebugEnabled)
{
log.Debug("This is another debug message");
}
</code>
</example>
<seealso cref="T:log4net.LogManager"/>
<seealso cref="M:LogManager.GetLogger(Assembly, Type)"/>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.ILog.Debug(System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>DEBUG</c>
enabled by comparing the level of this logger with the
<see cref="F:log4net.Core.Level.Debug"/> level. If this logger is
<c>DEBUG</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:Debug(object,Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:Debug(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.ILog.Debug(System.Object,System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:Debug(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Debug(object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])">
<overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Debug(object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Debug(object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Debug(object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Debug(object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Debug(object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.ILog.Info(System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
<summary>
Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<remarks>
<para>
This method first checks if this logger is <c>INFO</c>
enabled by comparing the level of this logger with the
<see cref="F:log4net.Core.Level.Info"/> level. If this logger is
<c>INFO</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of the
additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:Info(object,Exception)"/> form instead.
</para>
</remarks>
<param name="message">The message object to log.</param>
<seealso cref="M:Info(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.ILog.Info(System.Object,System.Exception)">
<summary>
Logs a message object with the <c>INFO</c> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:Info(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Info(object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
<overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Info(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Info(object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Info(object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Info(object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Info(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.ILog.Warn(System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<remarks>
<para>
This method first checks if this logger is <c>WARN</c>
enabled by comparing the level of this logger with the
<see cref="F:log4net.Core.Level.Warn"/> level. If this logger is
<c>WARN</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of the
additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:Warn(object,Exception)"/> form instead.
</para>
</remarks>
<param name="message">The message object to log.</param>
<seealso cref="M:Warn(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.ILog.Warn(System.Object,System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:Warn(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Warn(object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])">
<overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Warn(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Warn(object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Warn(object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Warn(object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Warn(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.ILog.Error(System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
<summary>
Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>ERROR</c>
enabled by comparing the level of this logger with the
<see cref="F:log4net.Core.Level.Error"/> level. If this logger is
<c>ERROR</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of the
additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:Error(object,Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:Error(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.ILog.Error(System.Object,System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:Error(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Error(object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])">
<overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Error(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Error(object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Error(object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Error(object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Error(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.ILog.Fatal(System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<remarks>
<para>
This method first checks if this logger is <c>FATAL</c>
enabled by comparing the level of this logger with the
<see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is
<c>FATAL</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of the
additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:Fatal(object,Exception)"/> form instead.
</para>
</remarks>
<param name="message">The message object to log.</param>
<seealso cref="M:Fatal(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.ILog.Fatal(System.Object,System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:Fatal(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Fatal(object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])">
<overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Fatal(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Fatal(object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Fatal(object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Fatal(object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:Fatal(object,Exception)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="P:log4net.ILog.IsDebugEnabled">
<summary>
Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<value>
<c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise.
</value>
<remarks>
<para>
This function is intended to lessen the computational cost of
disabled log debug statements.
</para>
<para> For some ILog interface <c>log</c>, when you write:</para>
<code lang="C#">
log.Debug("This is entry number: " + i );
</code>
<para>
You incur the cost constructing the message, string construction and concatenation in
this case, regardless of whether the message is logged or not.
</para>
<para>
If you are worried about speed (who isn't), then you should write:
</para>
<code lang="C#">
if (log.IsDebugEnabled)
{
log.Debug("This is entry number: " + i );
}
</code>
<para>
This way you will not incur the cost of parameter
construction if debugging is disabled for <c>log</c>. On
the other hand, if the <c>log</c> is debug enabled, you
will incur the cost of evaluating whether the logger is debug
enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in
the <see cref="M:Debug(object)"/>. This is an insignificant overhead
since evaluating a logger takes about 1% of the time it
takes to actually log. This is the preferred style of logging.
</para>
<para>Alternatively if your logger is available statically then the is debug
enabled state can be stored in a static variable like this:
</para>
<code lang="C#">
private static readonly bool isDebugEnabled = log.IsDebugEnabled;
</code>
<para>
Then when you come to log you can write:
</para>
<code lang="C#">
if (isDebugEnabled)
{
log.Debug("This is entry number: " + i );
}
</code>
<para>
This way the debug enabled state is only queried once
when the class is loaded. Using a <c>private static readonly</c>
variable is the most efficient because it is a run time constant
and can be heavily optimized by the JIT compiler.
</para>
<para>
Of course if you use a static readonly variable to
hold the enabled state of the logger then you cannot
change the enabled state at runtime to vary the logging
that is produced. You have to decide if you need absolute
speed or runtime flexibility.
</para>
</remarks>
<seealso cref="M:Debug(object)"/>
<seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/>
</member>
<member name="P:log4net.ILog.IsInfoEnabled">
<summary>
Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<value>
<c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise.
</value>
<remarks>
For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
</remarks>
<seealso cref="M:Info(object)"/>
<seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="P:log4net.ILog.IsWarnEnabled">
<summary>
Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<value>
<c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise.
</value>
<remarks>
For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
</remarks>
<seealso cref="M:Warn(object)"/>
<seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="P:log4net.ILog.IsErrorEnabled">
<summary>
Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<value>
<c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise.
</value>
<remarks>
For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
</remarks>
<seealso cref="M:Error(object)"/>
<seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="P:log4net.ILog.IsFatalEnabled">
<summary>
Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<value>
<c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise.
</value>
<remarks>
For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
</remarks>
<seealso cref="M:Fatal(object)"/>
<seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
<summary>
Construct a new wrapper for the specified logger.
</summary>
<param name="logger">The logger to wrap.</param>
<remarks>
<para>
Construct a new wrapper for the specified logger.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)">
<summary>
Virtual method called when the configuration of the repository changes
</summary>
<param name="repository">the repository holding the levels</param>
<remarks>
<para>
Virtual method called when the configuration of the repository changes
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Debug(System.Object)">
<summary>
Logs a message object with the <c>DEBUG</c> level.
</summary>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>DEBUG</c>
enabled by comparing the level of this logger with the
<c>DEBUG</c> level. If this logger is
<c>DEBUG</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of the
additivity flag.
</para>
<para>
<b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:Debug(object,Exception)"/> form instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)">
<summary>
Logs a message object with the <c>DEBUG</c> level
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
Logs a message object with the <c>DEBUG</c> level including
the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed
as a parameter.
</para>
<para>
See the <see cref="M:Debug(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Debug(object)"/>
</member>
<member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>DEBUG</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <c>DEBUG</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>DEBUG</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>DEBUG</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>DEBUG</c> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Info(System.Object)">
<summary>
Logs a message object with the <c>INFO</c> level.
</summary>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>INFO</c>
enabled by comparing the level of this logger with the
<c>INFO</c> level. If this logger is
<c>INFO</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para>
<b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:Info(object,Exception)"/> form instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)">
<summary>
Logs a message object with the <c>INFO</c> level.
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
Logs a message object with the <c>INFO</c> level including
the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
passed as a parameter.
</para>
<para>
See the <see cref="M:Info(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Info(object)"/>
</member>
<member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>INFO</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <c>INFO</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>INFO</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>INFO</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>INFO</c> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Warn(System.Object)">
<summary>
Logs a message object with the <c>WARN</c> level.
</summary>
<param name="message">the message object to log</param>
<remarks>
<para>
This method first checks if this logger is <c>WARN</c>
enabled by comparing the level of this logger with the
<c>WARN</c> level. If this logger is
<c>WARN</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger and
also higher in the hierarchy depending on the value of the
additivity flag.
</para>
<para>
<b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
method will print the name of the <see cref="T:System.Exception"/> but no
stack trace. To print a stack trace use the
<see cref="M:Warn(object,Exception)"/> form instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)">
<summary>
Logs a message object with the <c>WARN</c> level
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
Logs a message object with the <c>WARN</c> level including
the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
passed as a parameter.
</para>
<para>
See the <see cref="M:Warn(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Warn(object)"/>
</member>
<member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>WARN</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <c>WARN</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>WARN</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>WARN</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>WARN</c> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Error(System.Object)">
<summary>
Logs a message object with the <c>ERROR</c> level.
</summary>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>ERROR</c>
enabled by comparing the level of this logger with the
<c>ERROR</c> level. If this logger is
<c>ERROR</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger and
also higher in the hierarchy depending on the value of the
additivity flag.
</para>
<para>
<b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
method will print the name of the <see cref="T:System.Exception"/> but no
stack trace. To print a stack trace use the
<see cref="M:Error(object,Exception)"/> form instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)">
<summary>
Logs a message object with the <c>ERROR</c> level
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
Logs a message object with the <c>ERROR</c> level including
the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
passed as a parameter.
</para>
<para>
See the <see cref="M:Error(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Error(object)"/>
</member>
<member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>ERROR</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <c>ERROR</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>ERROR</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>ERROR</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>ERROR</c> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Fatal(System.Object)">
<summary>
Logs a message object with the <c>FATAL</c> level.
</summary>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>FATAL</c>
enabled by comparing the level of this logger with the
<c>FATAL</c> level. If this logger is
<c>FATAL</c> enabled, then it converts the message object
(passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger and
also higher in the hierarchy depending on the value of the
additivity flag.
</para>
<para>
<b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
method will print the name of the <see cref="T:System.Exception"/> but no
stack trace. To print a stack trace use the
<see cref="M:Fatal(object,Exception)"/> form instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)">
<summary>
Logs a message object with the <c>FATAL</c> level
</summary>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
Logs a message object with the <c>FATAL</c> level including
the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
passed as a parameter.
</para>
<para>
See the <see cref="M:Fatal(object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:Fatal(object)"/>
</member>
<member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>FATAL</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
<summary>
Logs a formatted message string with the <c>FATAL</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>FATAL</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <c>FATAL</c> level.
</summary>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
format provider. To specify a localized provider use the
<see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <c>FATAL</c> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
<c>String.Format</c> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
methods instead.
</para>
</remarks>
</member>
<member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)">
<summary>
Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event
</summary>
<param name="sender">the repository</param>
<param name="e">Empty</param>
</member>
<member name="F:log4net.Core.LogImpl.ThisDeclaringType">
<summary>
The fully qualified name of this declaring type not the type of any subclass.
</summary>
</member>
<member name="P:log4net.Core.LogImpl.IsDebugEnabled">
<summary>
Checks if this logger is enabled for the <c>DEBUG</c>
level.
</summary>
<value>
<c>true</c> if this logger is enabled for <c>DEBUG</c> events,
<c>false</c> otherwise.
</value>
<remarks>
<para>
This function is intended to lessen the computational cost of
disabled log debug statements.
</para>
<para>
For some <c>log</c> Logger object, when you write:
</para>
<code lang="C#">
log.Debug("This is entry number: " + i );
</code>
<para>
You incur the cost constructing the message, concatenation in
this case, regardless of whether the message is logged or not.
</para>
<para>
If you are worried about speed, then you should write:
</para>
<code lang="C#">
if (log.IsDebugEnabled())
{
log.Debug("This is entry number: " + i );
}
</code>
<para>
This way you will not incur the cost of parameter
construction if debugging is disabled for <c>log</c>. On
the other hand, if the <c>log</c> is debug enabled, you
will incur the cost of evaluating whether the logger is debug
enabled twice. Once in <c>IsDebugEnabled</c> and once in
the <c>Debug</c>. This is an insignificant overhead
since evaluating a logger takes about 1% of the time it
takes to actually log.
</para>
</remarks>
</member>
<member name="P:log4net.Core.LogImpl.IsInfoEnabled">
<summary>
Checks if this logger is enabled for the <c>INFO</c> level.
</summary>
<value>
<c>true</c> if this logger is enabled for <c>INFO</c> events,
<c>false</c> otherwise.
</value>
<remarks>
<para>
See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
of using this method.
</para>
</remarks>
<seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
</member>
<member name="P:log4net.Core.LogImpl.IsWarnEnabled">
<summary>
Checks if this logger is enabled for the <c>WARN</c> level.
</summary>
<value>
<c>true</c> if this logger is enabled for <c>WARN</c> events,
<c>false</c> otherwise.
</value>
<remarks>
<para>
See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
of using this method.
</para>
</remarks>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="P:log4net.Core.LogImpl.IsErrorEnabled">
<summary>
Checks if this logger is enabled for the <c>ERROR</c> level.
</summary>
<value>
<c>true</c> if this logger is enabled for <c>ERROR</c> events,
<c>false</c> otherwise.
</value>
<remarks>
<para>
See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
</para>
</remarks>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="P:log4net.Core.LogImpl.IsFatalEnabled">
<summary>
Checks if this logger is enabled for the <c>FATAL</c> level.
</summary>
<value>
<c>true</c> if this logger is enabled for <c>FATAL</c> events,
<c>false</c> otherwise.
</value>
<remarks>
<para>
See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
</para>
</remarks>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="T:log4net.Core.MethodItem">
<summary>
provides method information without actually referencing a System.Reflection.MethodBase
as that would require that the containing assembly is loaded.
</summary>
</member>
<member name="F:log4net.Core.MethodItem.NA">
<summary>
When location information is not available the constant
<c>NA</c> is returned. Current value of this string
constant is <b>?</b>.
</summary>
</member>
<member name="M:log4net.Core.MethodItem.#ctor">
<summary>
constructs a method item for an unknown method.
</summary>
</member>
<member name="M:log4net.Core.MethodItem.#ctor(System.String)">
<summary>
constructs a method item from the name of the method.
</summary>
<param name="name"></param>
</member>
<member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])">
<summary>
constructs a method item from the name of the method and its parameters.
</summary>
<param name="name"></param>
<param name="parameters"></param>
</member>
<member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)">
<summary>
constructs a method item from a method base by determining the method name and its parameters.
</summary>
<param name="methodBase"></param>
</member>
<member name="F:log4net.Core.MethodItem.declaringType">
<summary>
The fully qualified type of the StackFrameItem class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Core.MethodItem.Name">
<summary>
Gets the method name of the caller making the logging
request.
</summary>
<value>
The method name of the caller making the logging
request.
</value>
<remarks>
<para>
Gets the method name of the caller making the logging
request.
</para>
</remarks>
</member>
<member name="P:log4net.Core.MethodItem.Parameters">
<summary>
Gets the method parameters of the caller making
the logging request.
</summary>
<value>
The method parameters of the caller making
the logging request
</value>
<remarks>
<para>
Gets the method parameters of the caller making
the logging request.
</para>
</remarks>
</member>
<member name="T:log4net.Core.SecurityContext">
<summary>
A SecurityContext used by log4net when interacting with protected resources
</summary>
<remarks>
<para>
A SecurityContext used by log4net when interacting with protected resources
for example with operating system services. This can be used to impersonate
a principal that has been granted privileges on the system resources.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)">
<summary>
Impersonate this SecurityContext
</summary>
<param name="state">State supplied by the caller</param>
<returns>An <see cref="T:System.IDisposable"/> instance that will
revoke the impersonation of this SecurityContext, or <c>null</c></returns>
<remarks>
<para>
Impersonate this security context. Further calls on the current
thread should now be made in the security context provided
by this object. When the <see cref="T:System.IDisposable"/> result
<see cref="M:System.IDisposable.Dispose"/> method is called the security
context of the thread should be reverted to the state it was in
before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called.
</para>
</remarks>
</member>
<member name="T:log4net.Core.SecurityContextProvider">
<summary>
The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances.
</summary>
<remarks>
<para>
A configured component that interacts with potentially protected system
resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated
privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has
been not been explicitly provided to the component then the component
will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>.
</para>
<para>
By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is
an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only
<see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default
where the privileges required are not know by the system.
</para>
<para>
This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/>
and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return
the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider
can be replaced by programmatically setting the value of the
<see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property.
</para>
<para>
An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c>
This attribute can be applied to an assembly in the same way as the
<c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes
the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider">
<summary>
The default provider
</summary>
</member>
<member name="M:log4net.Core.SecurityContextProvider.#ctor">
<summary>
Protected default constructor to allow subclassing
</summary>
<remarks>
<para>
Protected default constructor to allow subclassing
</para>
</remarks>
</member>
<member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)">
<summary>
Create a SecurityContext for a consumer
</summary>
<param name="consumer">The consumer requesting the SecurityContext</param>
<returns>An impersonation context</returns>
<remarks>
<para>
The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>.
</para>
<para>
Subclasses should override this method to provide their own
behavior.
</para>
</remarks>
</member>
<member name="P:log4net.Core.SecurityContextProvider.DefaultProvider">
<summary>
Gets or sets the default SecurityContextProvider
</summary>
<value>
The default SecurityContextProvider
</value>
<remarks>
<para>
The default provider is used by configured components that
require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one
given to them.
</para>
<para>
By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/>
that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects.
</para>
<para>
The default provider can be set programmatically by setting
the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/>
that has the desired behavior.
</para>
</remarks>
</member>
<member name="T:log4net.Core.StackFrameItem">
<summary>
provides stack frame information without actually referencing a System.Diagnostics.StackFrame
as that would require that the containing assembly is loaded.
</summary>
</member>
<member name="F:log4net.Core.StackFrameItem.NA">
<summary>
When location information is not available the constant
<c>NA</c> is returned. Current value of this string
constant is <b>?</b>.
</summary>
</member>
<member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)">
<summary>
returns a stack frame item from a stack frame. This
</summary>
<param name="frame"></param>
<returns></returns>
</member>
<member name="F:log4net.Core.StackFrameItem.declaringType">
<summary>
The fully qualified type of the StackFrameItem class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Core.StackFrameItem.ClassName">
<summary>
Gets the fully qualified class name of the caller making the logging
request.
</summary>
<value>
The fully qualified class name of the caller making the logging
request.
</value>
<remarks>
<para>
Gets the fully qualified class name of the caller making the logging
request.
</para>
</remarks>
</member>
<member name="P:log4net.Core.StackFrameItem.FileName">
<summary>
Gets the file name of the caller.
</summary>
<value>
The file name of the caller.
</value>
<remarks>
<para>
Gets the file name of the caller.
</para>
</remarks>
</member>
<member name="P:log4net.Core.StackFrameItem.LineNumber">
<summary>
Gets the line number of the caller.
</summary>
<value>
The line number of the caller.
</value>
<remarks>
<para>
Gets the line number of the caller.
</para>
</remarks>
</member>
<member name="P:log4net.Core.StackFrameItem.Method">
<summary>
Gets the method name of the caller.
</summary>
<value>
The method name of the caller.
</value>
<remarks>
<para>
Gets the method name of the caller.
</para>
</remarks>
</member>
<member name="P:log4net.Core.StackFrameItem.FullInfo">
<summary>
Gets all available caller information
</summary>
<value>
All available caller information, in the format
<c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
</value>
<remarks>
<para>
Gets all available caller information, in the format
<c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
</para>
</remarks>
</member>
<member name="T:log4net.Core.TimeEvaluator">
<summary>
An evaluator that triggers after specified number of seconds.
</summary>
<remarks>
<para>
This evaluator will trigger if the specified time period
<see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
</para>
</remarks>
<author>Robert Sevcik</author>
</member>
<member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL">
<summary>
The default time threshold for triggering in seconds. Zero means it won't trigger at all.
</summary>
</member>
<member name="F:log4net.Core.TimeEvaluator.m_interval">
<summary>
The time threshold for triggering in seconds. Zero means it won't trigger at all.
</summary>
</member>
<member name="F:log4net.Core.TimeEvaluator.m_lasttime">
<summary>
The time of last check. This gets updated when the object is created and when the evaluator triggers.
</summary>
</member>
<member name="M:log4net.Core.TimeEvaluator.#ctor">
<summary>
Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
</summary>
<remarks>
<para>
Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
</para>
<para>
This evaluator will trigger if the specified time period
<see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
</para>
</remarks>
</member>
<member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)">
<summary>
Create a new evaluator using the specified time threshold in seconds.
</summary>
<param name="interval">
The time threshold in seconds to trigger after.
Zero means it won't trigger at all.
</param>
<remarks>
<para>
Create a new evaluator using the specified time threshold in seconds.
</para>
<para>
This evaluator will trigger if the specified time period
<see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
</para>
</remarks>
</member>
<member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
<summary>
Is this <paramref name="loggingEvent"/> the triggering event?
</summary>
<param name="loggingEvent">The event to check</param>
<returns>This method returns <c>true</c>, if the specified time period
<see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check..
Otherwise it returns <c>false</c></returns>
<remarks>
<para>
This evaluator will trigger if the specified time period
<see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
</para>
</remarks>
</member>
<member name="P:log4net.Core.TimeEvaluator.Interval">
<summary>
The time threshold in seconds to trigger after
</summary>
<value>
The time threshold in seconds to trigger after.
Zero means it won't trigger at all.
</value>
<remarks>
<para>
This evaluator will trigger if the specified time period
<see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
</para>
</remarks>
</member>
<member name="T:log4net.Core.WrapperCreationHandler">
<summary>
Delegate used to handle creation of new wrappers.
</summary>
<param name="logger">The logger to wrap in a wrapper.</param>
<remarks>
<para>
Delegate used to handle creation of new wrappers. This delegate
is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
method to construct the wrapper for the specified logger.
</para>
<para>
The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/>
constructor.
</para>
</remarks>
</member>
<member name="T:log4net.Core.WrapperMap">
<summary>
Maps between logger objects and wrapper objects.
</summary>
<remarks>
<para>
This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and
<see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to
lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>.
</para>
<para>
New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
method. The default behavior is for this method to delegate construction
of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied
to the constructor. This allows specialization of the behavior without
requiring subclassing of this type.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/>
</summary>
<param name="createWrapperHandler">The handler to use to create the wrapper objects.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/> class with
the specified handler to create the wrapper objects.
</para>
</remarks>
</member>
<member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)">
<summary>
Gets the wrapper object for the specified logger.
</summary>
<returns>The wrapper object for the specified logger</returns>
<remarks>
<para>
If the logger is null then the corresponding wrapper is null.
</para>
<para>
Looks up the wrapper it it has previously been requested and
returns it. If the wrapper has never been requested before then
the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is
called.
</para>
</remarks>
</member>
<member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)">
<summary>
Creates the wrapper object for the specified logger.
</summary>
<param name="logger">The logger to wrap in a wrapper.</param>
<returns>The wrapper object for the logger.</returns>
<remarks>
<para>
This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/>
passed to the constructor to create the wrapper. This method
can be overridden in a subclass.
</para>
</remarks>
</member>
<member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)">
<summary>
Called when a monitored repository shutdown event is received.
</summary>
<param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param>
<remarks>
<para>
This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this
<see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown
event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default
behavior of this method is to release the references to the loggers
and their wrappers generated for this repository.
</para>
</remarks>
</member>
<member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)">
<summary>
Event handler for repository shutdown event.
</summary>
<param name="sender">The sender of the event.</param>
<param name="e">The event args.</param>
</member>
<member name="F:log4net.Core.WrapperMap.m_repositories">
<summary>
Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings
</summary>
</member>
<member name="F:log4net.Core.WrapperMap.m_createWrapperHandler">
<summary>
The handler to use to create the extension wrapper objects.
</summary>
</member>
<member name="F:log4net.Core.WrapperMap.m_shutdownHandler">
<summary>
Internal reference to the delegate used to register for repository shutdown events.
</summary>
</member>
<member name="P:log4net.Core.WrapperMap.Repositories">
<summary>
Gets the map of logger repositories.
</summary>
<value>
Map of logger repositories.
</value>
<remarks>
<para>
Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The
values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the
value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>.
</para>
</remarks>
</member>
<member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter">
<summary>
Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>.
</summary>
<remarks>
<para>
Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.DateFormatter.IDateFormatter">
<summary>
Render a <see cref="T:System.DateTime"/> as a string.
</summary>
<remarks>
<para>
Interface to abstract the rendering of a <see cref="T:System.DateTime"/>
instance into a string.
</para>
<para>
The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the
date to a text writer.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
<summary>
Formats the specified date as a string.
</summary>
<param name="dateToFormat">The date to format.</param>
<param name="writer">The writer to write to.</param>
<remarks>
<para>
Format the <see cref="T:System.DateTime"/> as a string and write it
to the <see cref="T:System.IO.TextWriter"/> provided.
</para>
</remarks>
</member>
<member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat">
<summary>
String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>.
</summary>
</member>
<member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat">
<summary>
String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>.
</summary>
</member>
<member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat">
<summary>
String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>.
</summary>
</member>
<member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
<summary>
Renders the date into a string. Format is <c>"HH:mm:ss"</c>.
</summary>
<param name="dateToFormat">The date to render into a string.</param>
<param name="buffer">The string builder to write to.</param>
<remarks>
<para>
Subclasses should override this method to render the date
into a string using a precision up to the second. This method
will be called at most once per second and the result will be
reused if it is needed again during the same second.
</para>
</remarks>
</member>
<member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
<summary>
Renders the date into a string. Format is "HH:mm:ss,fff".
</summary>
<param name="dateToFormat">The date to render into a string.</param>
<param name="writer">The writer to write to.</param>
<remarks>
<para>
Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the
time string up to the seconds and then appends the current
milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are
cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once
per second.
</para>
<para>
Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/>
rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>.
</para>
</remarks>
</member>
<member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond">
<summary>
Last stored time with precision up to the second.
</summary>
</member>
<member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf">
<summary>
Last stored time with precision up to the second, formatted
as a string.
</summary>
</member>
<member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings">
<summary>
Last stored time with precision up to the second, formatted
as a string.
</summary>
</member>
<member name="T:log4net.DateFormatter.DateTimeDateFormatter">
<summary>
Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c>
</summary>
<remarks>
<para>
Formats a <see cref="T:System.DateTime"/> in the format
<c>"dd MMM yyyy HH:mm:ss,fff"</c> for example,
<c>"06 Nov 1994 15:49:37,459"</c>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Angelika Schnagl</author>
</member>
<member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor">
<summary>
Default constructor.
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
<summary>
Formats the date without the milliseconds part
</summary>
<param name="dateToFormat">The date to format.</param>
<param name="buffer">The string builder to write to.</param>
<remarks>
<para>
Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c>
for example, <c>"06 Nov 1994 15:49:37"</c>.
</para>
<para>
The base class will append the <c>",fff"</c> milliseconds section.
This method will only be called at most once per second.
</para>
</remarks>
</member>
<member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo">
<summary>
The format info for the invariant culture.
</summary>
</member>
<member name="T:log4net.DateFormatter.Iso8601DateFormatter">
<summary>
Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
</summary>
<remarks>
<para>
Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
<summary>
Formats the date without the milliseconds part
</summary>
<param name="dateToFormat">The date to format.</param>
<param name="buffer">The string builder to write to.</param>
<remarks>
<para>
Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>.
</para>
<para>
The base class will append the <c>",fff"</c> milliseconds section.
This method will only be called at most once per second.
</para>
</remarks>
</member>
<member name="T:log4net.DateFormatter.SimpleDateFormatter">
<summary>
Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
</summary>
<remarks>
<para>
Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="format">The format string.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> class
with the specified format string.
</para>
<para>
The format string must be compatible with the options
that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
</para>
</remarks>
</member>
<member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
<summary>
Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
</summary>
<param name="dateToFormat">The date to convert to a string.</param>
<param name="writer">The writer to write to.</param>
<remarks>
<para>
Uses the date format string supplied to the constructor to call
the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date.
</para>
</remarks>
</member>
<member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString">
<summary>
The format string used to format the <see cref="T:System.DateTime"/>.
</summary>
<remarks>
<para>
The format string must be compatible with the options
that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Filter.DenyAllFilter">
<summary>
This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>.
</summary>
<remarks>
<para>
You can add this filter to the end of a filter chain to
switch from the default "accept all unless instructed otherwise"
filtering behavior to a "deny all unless instructed otherwise"
behavior.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Filter.FilterSkeleton">
<summary>
Subclass this type to implement customized logging event filtering
</summary>
<remarks>
<para>
Users should extend this class to implement customized logging
event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
<see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
appenders, have built-in filtering rules. It is suggested that you
first use and understand the built-in rules before rushing to write
your own custom filters.
</para>
<para>
This abstract class assumes and also imposes that filters be
organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/>
method of each filter is called sequentially, in the order of their
addition to the chain.
</para>
<para>
The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one
of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
<see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
</para>
<para>
If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
immediately without consulting with the remaining filters.
</para>
<para>
If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
in the chain is consulted. If there are no more filters in the
chain, then the log event is logged. Thus, in the presence of no
filters, the default behavior is to log all logging events.
</para>
<para>
If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
event is logged without consulting the remaining filters.
</para>
<para>
The philosophy of log4net filters is largely inspired from the
Linux ipchains.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Filter.IFilter">
<summary>
Implement this interface to provide customized logging event filtering
</summary>
<remarks>
<para>
Users should implement this interface to implement customized logging
event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
<see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
appenders, have built-in filtering rules. It is suggested that you
first use and understand the built-in rules before rushing to write
your own custom filters.
</para>
<para>
This abstract class assumes and also imposes that filters be
organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
method of each filter is called sequentially, in the order of their
addition to the chain.
</para>
<para>
The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one
of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
<see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
</para>
<para>
If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
immediately without consulting with the remaining filters.
</para>
<para>
If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
in the chain is consulted. If there are no more filters in the
chain, then the log event is logged. Thus, in the presence of no
filters, the default behavior is to log all logging events.
</para>
<para>
If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
event is logged without consulting the remaining filters.
</para>
<para>
The philosophy of log4net filters is largely inspired from the
Linux ipchains.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)">
<summary>
Decide if the logging event should be logged through an appender.
</summary>
<param name="loggingEvent">The LoggingEvent to decide upon</param>
<returns>The decision of the filter</returns>
<remarks>
<para>
If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
the event will be logged without consulting with other filters in
the chain.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.IFilter.Next">
<summary>
Property to get and set the next filter
</summary>
<value>
The next filter in the chain
</value>
<remarks>
<para>
Filters are typically composed into chains. This property allows the next filter in
the chain to be accessed.
</para>
</remarks>
</member>
<member name="F:log4net.Filter.FilterSkeleton.m_next">
<summary>
Points to the next filter in the filter chain.
</summary>
<remarks>
<para>
See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information.
</para>
</remarks>
</member>
<member name="M:log4net.Filter.FilterSkeleton.ActivateOptions">
<summary>
Initialize the filter with the options set
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again.
</para>
<para>
Typically filter's options become active immediately on set,
however this method must still be called.
</para>
</remarks>
</member>
<member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)">
<summary>
Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender.
</summary>
<param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param>
<returns>The decision of the filter</returns>
<remarks>
<para>
If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
the event will be logged without consulting with other filters in
the chain.
</para>
<para>
This method is marked <c>abstract</c> and must be implemented
in a subclass.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.FilterSkeleton.Next">
<summary>
Property to get and set the next filter
</summary>
<value>
The next filter in the chain
</value>
<remarks>
<para>
Filters are typically composed into chains. This property allows the next filter in
the chain to be accessed.
</para>
</remarks>
</member>
<member name="M:log4net.Filter.DenyAllFilter.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)">
<summary>
Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/>
</summary>
<param name="loggingEvent">the LoggingEvent to filter</param>
<returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns>
<remarks>
<para>
Ignores the event being logged and just returns
<see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter
chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter
should only be used as the last filter in the chain
as any further filters will be ignored!
</para>
</remarks>
</member>
<member name="T:log4net.Filter.FilterDecision">
<summary>
The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
</summary>
<remarks>
<para>
The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
</para>
</remarks>
</member>
<member name="F:log4net.Filter.FilterDecision.Deny">
<summary>
The log event must be dropped immediately without
consulting with the remaining filters, if any, in the chain.
</summary>
</member>
<member name="F:log4net.Filter.FilterDecision.Neutral">
<summary>
This filter is neutral with respect to the log event.
The remaining filters, if any, should be consulted for a final decision.
</summary>
</member>
<member name="F:log4net.Filter.FilterDecision.Accept">
<summary>
The log event must be logged immediately without
consulting with the remaining filters, if any, in the chain.
</summary>
</member>
<member name="T:log4net.Filter.LevelMatchFilter">
<summary>
This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching.
</summary>
<remarks>
<para>
The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and
<see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value
of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the
<see cref="T:log4net.Core.LoggingEvent"/>, then the <see cref="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
to <c>true</c>, if it is <c>false</c> then
<see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch">
<summary>
flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match
</summary>
</member>
<member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch">
<summary>
the <see cref="T:log4net.Core.Level"/> to match against
</summary>
</member>
<member name="M:log4net.Filter.LevelMatchFilter.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)">
<summary>
Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter
</summary>
<param name="loggingEvent">the event to filter</param>
<returns>see remarks</returns>
<remarks>
<para>
If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the
filter then the result of the function depends on the
value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch">
<summary>
<see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/>
</summary>
<remarks>
<para>
The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines
the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
</para>
<para>
The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch">
<summary>
The <see cref="T:log4net.Core.Level"/> that the filter will match
</summary>
<remarks>
<para>
The level that this filter will attempt to match against the
<see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Filter.LevelRangeFilter">
<summary>
This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching.
</summary>
<remarks>
<para>
The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
that determine the range of priorities that are matched, and
<see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range
of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the
<see cref="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in case the <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>
option value is set to <c>true</c>, if it is <c>false</c>
then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch">
<summary>
Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/>
</summary>
</member>
<member name="F:log4net.Filter.LevelRangeFilter.m_levelMin">
<summary>
the minimum <see cref="T:log4net.Core.Level"/> value to match
</summary>
</member>
<member name="F:log4net.Filter.LevelRangeFilter.m_levelMax">
<summary>
the maximum <see cref="T:log4net.Core.Level"/> value to match
</summary>
</member>
<member name="M:log4net.Filter.LevelRangeFilter.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)">
<summary>
Check if the event should be logged.
</summary>
<param name="loggingEvent">the logging event to check</param>
<returns>see remarks</returns>
<remarks>
<para>
If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range
matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/>
is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of
<see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then
<see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise
<see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch">
<summary>
<see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
</summary>
<remarks>
<para>
The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines
the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
</para>
<para>
The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.LevelRangeFilter.LevelMin">
<summary>
Set the minimum matched <see cref="T:log4net.Core.Level"/>
</summary>
<remarks>
<para>
The minimum level that this filter will attempt to match against the
<see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.LevelRangeFilter.LevelMax">
<summary>
Sets the maximum matched <see cref="T:log4net.Core.Level"/>
</summary>
<remarks>
<para>
The maximum level that this filter will attempt to match against the
<see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Filter.LoggerMatchFilter">
<summary>
Simple filter to match a string in the event's logger name.
</summary>
<remarks>
<para>
The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two
options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the
<see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts
with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the
<see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>,
if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
</para>
</remarks>
<author>Daniel Cazzulino</author>
</member>
<member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch">
<summary>
Flag to indicate the behavior when we have a match
</summary>
</member>
<member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch">
<summary>
The logger name string to substring match against the event
</summary>
</member>
<member name="M:log4net.Filter.LoggerMatchFilter.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)">
<summary>
Check if this filter should allow the event to be logged
</summary>
<param name="loggingEvent">the event being logged</param>
<returns>see remarks</returns>
<remarks>
<para>
The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>.
If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of
the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>)
then a match will have occurred. If no match occurs
this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
allowing other filters to check the event. If a match occurs then
the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is
true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
<see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch">
<summary>
<see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>
</summary>
<remarks>
<para>
The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines
the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
</para>
<para>
The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch">
<summary>
The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match
</summary>
<remarks>
<para>
This filter will attempt to match this value against logger name in
the following way. The match will be done against the beginning of the
logger name (using <see cref="M:String.StartsWith(string)"/>). The match is
case sensitive. If a match is found then
the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Filter.MdcFilter">
<summary>
Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
</summary>
<remarks>
<para>
Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
</para>
<para>
As the MDC has been replaced with layered properties the
<see cref="T:log4net.Filter.PropertyFilter"/> should be used instead.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Filter.PropertyFilter">
<summary>
Simple filter to match a string an event property
</summary>
<remarks>
<para>
Simple filter to match a string in the value for a
specific event property
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="T:log4net.Filter.StringMatchFilter">
<summary>
Simple filter to match a string in the rendered message
</summary>
<remarks>
<para>
Simple filter to match a string in the rendered message
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch">
<summary>
Flag to indicate the behavior when we have a match
</summary>
</member>
<member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch">
<summary>
The string to substring match against the message
</summary>
</member>
<member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch">
<summary>
A string regex to match
</summary>
</member>
<member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch">
<summary>
A regex object to match (generated from m_stringRegexToMatch)
</summary>
</member>
<member name="M:log4net.Filter.StringMatchFilter.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:log4net.Filter.StringMatchFilter.ActivateOptions">
<summary>
Initialize and precompile the Regex if required
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)">
<summary>
Check if this filter should allow the event to be logged
</summary>
<param name="loggingEvent">the event being logged</param>
<returns>see remarks</returns>
<remarks>
<para>
The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
the message then a match will have occurred. If no match occurs
this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
allowing other filters to check the event. If a match occurs then
the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
<see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch">
<summary>
<see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
</summary>
<remarks>
<para>
The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines
the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
</para>
<para>
The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.StringMatchFilter.StringToMatch">
<summary>
Sets the static string to match
</summary>
<remarks>
<para>
The string that will be substring matched against
the rendered message. If the message contains this
string then the filter will match. If a match is found then
the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
</para>
<para>
One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
must be specified.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.StringMatchFilter.RegexToMatch">
<summary>
Sets the regular expression to match
</summary>
<remarks>
<para>
The regular expression pattern that will be matched against
the rendered message. If the message matches this
pattern then the filter will match. If a match is found then
the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
</para>
<para>
One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
must be specified.
</para>
</remarks>
</member>
<member name="F:log4net.Filter.PropertyFilter.m_key">
<summary>
The key to use to lookup the string from the event properties
</summary>
</member>
<member name="M:log4net.Filter.PropertyFilter.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)">
<summary>
Check if this filter should allow the event to be logged
</summary>
<param name="loggingEvent">the event being logged</param>
<returns>see remarks</returns>
<remarks>
<para>
The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against
the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
the property value then a match will have occurred. If no match occurs
this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
allowing other filters to check the event. If a match occurs then
the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
<see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Filter.PropertyFilter.Key">
<summary>
The key to lookup in the event properties and then match against.
</summary>
<remarks>
<para>
The key name to use to lookup in the properties map of the
<see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against
the value of this property if it exists.
</para>
</remarks>
</member>
<member name="T:log4net.Filter.NdcFilter">
<summary>
Simple filter to match a string in the <see cref="T:log4net.NDC"/>
</summary>
<remarks>
<para>
Simple filter to match a string in the <see cref="T:log4net.NDC"/>
</para>
<para>
As the MDC has been replaced with named stacks stored in the
properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should
be used instead.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Filter.NdcFilter.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.AppDomainPatternConverter">
<summary>
Write the event appdomain name to the output
</summary>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer.
</para>
</remarks>
<author>Daniel Cazzulino</author>
<author>Nicko Cadell</author>
</member>
<member name="T:log4net.Layout.Pattern.PatternLayoutConverter">
<summary>
Abstract class that provides the formatting functionality that
derived classes need.
</summary>
<remarks>
Conversion specifiers in a conversion patterns are parsed to
individual PatternConverters. Each of which is responsible for
converting a logging event in a converter specific manner.
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="T:log4net.Util.PatternConverter">
<summary>
Abstract class that provides the formatting functionality that
derived classes need.
</summary>
<remarks>
<para>
Conversion specifiers in a conversion patterns are parsed to
individual PatternConverters. Each of which is responsible for
converting a logging event in a converter specific manner.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Util.PatternConverter.c_renderBufferSize">
<summary>
Initial buffer size
</summary>
</member>
<member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity">
<summary>
Maximum buffer size before it is recycled
</summary>
</member>
<member name="M:log4net.Util.PatternConverter.#ctor">
<summary>
Protected constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Evaluate this pattern converter and write the output to a writer.
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="state">The state object on which the pattern converter should be executed.</param>
<remarks>
<para>
Derived pattern converters must override this method in order to
convert conversion specifiers in the appropriate way.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)">
<summary>
Set the next pattern converter in the chains
</summary>
<param name="patternConverter">the pattern converter that should follow this converter in the chain</param>
<returns>the next converter</returns>
<remarks>
<para>
The PatternConverter can merge with its neighbor during this method (or a sub class).
Therefore the return value may or may not be the value of the argument passed in.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)">
<summary>
Write the pattern converter to the writer with appropriate formatting
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="state">The state object on which the pattern converter should be executed.</param>
<remarks>
<para>
This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform
appropriate conversion of the pattern converter. If formatting options have
been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will
apply those formattings before writing the output.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)">
<summary>
Fast space padding method.
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> to which the spaces will be appended.</param>
<param name="length">The number of spaces to be padded.</param>
<remarks>
<para>
Fast space padding method.
</para>
</remarks>
</member>
<member name="F:log4net.Util.PatternConverter.m_option">
<summary>
The option string to the converter
</summary>
</member>
<member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)">
<summary>
Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
</summary>
<param name="writer">the writer to write to</param>
<param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
<param name="value">the value to write to the writer</param>
<remarks>
<para>
Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form:
</para>
<code>
{key1=value1, key2=value2, key3=value3}
</code>
<para>
If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
is not null then it is used to render the key and value to text, otherwise
the object's ToString method is called.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)">
<summary>
Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
</summary>
<param name="writer">the writer to write to</param>
<param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
<param name="value">the value to write to the writer</param>
<remarks>
<para>
Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form:
</para>
<code>
{key1=value1, key2=value2, key3=value3}
</code>
<para>
If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
is not null then it is used to render the key and value to text, otherwise
the object's ToString method is called.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)">
<summary>
Write an object to a <see cref="T:System.IO.TextWriter"/>
</summary>
<param name="writer">the writer to write to</param>
<param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
<param name="value">the value to write to the writer</param>
<remarks>
<para>
Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
is not null then it is used to render the object to text, otherwise
the object's ToString method is called.
</para>
</remarks>
</member>
<member name="P:log4net.Util.PatternConverter.Next">
<summary>
Get the next pattern converter in the chain
</summary>
<value>
the next pattern converter in the chain
</value>
<remarks>
<para>
Get the next pattern converter in the chain
</para>
</remarks>
</member>
<member name="P:log4net.Util.PatternConverter.FormattingInfo">
<summary>
Gets or sets the formatting info for this converter
</summary>
<value>
The formatting info for this converter
</value>
<remarks>
<para>
Gets or sets the formatting info for this converter
</para>
</remarks>
</member>
<member name="P:log4net.Util.PatternConverter.Option">
<summary>
Gets or sets the option value for this converter
</summary>
<summary>
The option for this converter
</summary>
<remarks>
<para>
Gets or sets the option value for this converter
</para>
</remarks>
</member>
<member name="P:log4net.Util.PatternConverter.Properties">
<summary>
</summary>
</member>
<member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter"/> class.
</summary>
</member>
<member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Derived pattern converters must override this method in order to
convert conversion specifiers in the correct way.
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
</member>
<member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Derived pattern converters must override this method in order to
convert conversion specifiers in the correct way.
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="state">The state object on which the pattern converter should be executed.</param>
</member>
<member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException">
<summary>
Flag indicating if this converter handles exceptions
</summary>
<remarks>
<c>false</c> if this converter handles exceptions
</remarks>
</member>
<member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException">
<summary>
Flag indicating if this converter handles the logging event exception
</summary>
<value><c>false</c> if this converter handles the logging event exception</value>
<remarks>
<para>
If this converter handles the exception object contained within
<see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to
<c>false</c>. Otherwise, if the layout ignores the exception
object, then the property should be set to <c>true</c>.
</para>
<para>
Set this value to override a this default setting. The default
value is <c>true</c>, this converter does not handle the exception.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the event appdomain name to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.AspNetCachePatternConverter">
<summary>
Converter for items in the ASP.Net Cache.
</summary>
<remarks>
<para>
Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
</para>
</remarks>
<author>Ron Grabowski</author>
</member>
<member name="T:log4net.Layout.Pattern.AspNetPatternLayoutConverter">
<summary>
Abstract class that provides access to the current HttpContext (<see cref="P:System.Web.HttpContext.Current"/>) that
derived classes need.
</summary>
<remarks>
This class handles the case when HttpContext.Current is null by writing
<see cref="P:log4net.Util.SystemInfo.NotAvailableText"/> to the writer.
</remarks>
<author>Ron Grabowski</author>
</member>
<member name="M:log4net.Layout.Pattern.AspNetPatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
<summary>
Derived pattern converters must override this method in order to
convert conversion specifiers in the correct way.
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
<param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
</member>
<member name="M:log4net.Layout.Pattern.AspNetCachePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
<summary>
Write the ASP.Net Cache item to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
<param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
<remarks>
<para>
Writes out the value of a named property. The property name
should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
property. If no property has been set, all key value pairs from the Cache will
be written to the output.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.AspNetContextPatternConverter">
<summary>
Converter for items in the <see cref="T:System.Web.HttpContext"/>.
</summary>
<remarks>
<para>
Outputs an item from the <see cref="T:System.Web.HttpContext"/>.
</para>
</remarks>
<author>Ron Grabowski</author>
</member>
<member name="M:log4net.Layout.Pattern.AspNetContextPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
<summary>
Write the ASP.Net HttpContext item to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
<param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
<remarks>
<para>
Writes out the value of a named property. The property name
should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
property.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.AspNetRequestPatternConverter">
<summary>
Converter for items in the ASP.Net Cache.
</summary>
<remarks>
<para>
Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
</para>
</remarks>
<author>Ron Grabowski</author>
</member>
<member name="M:log4net.Layout.Pattern.AspNetRequestPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
<summary>
Write the ASP.Net Cache item to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
<param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
<remarks>
<para>
Writes out the value of a named property. The property name
should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
property.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.AspNetSessionPatternConverter">
<summary>
Converter for items in the ASP.Net Cache.
</summary>
<remarks>
<para>
Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
</para>
</remarks>
<author>Ron Grabowski</author>
</member>
<member name="M:log4net.Layout.Pattern.AspNetSessionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
<summary>
Write the ASP.Net Cache item to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
<param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
<remarks>
<para>
Writes out the value of a named property. The property name
should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
property. If no property has been set, all key value pairs from the Session will
be written to the output.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.DatePatternConverter">
<summary>
Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
</summary>
<remarks>
<para>
Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string.
</para>
<para>
The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
the formatting of the date. The following values are allowed:
<list type="definition">
<listheader>
<term>Option value</term>
<description>Output</description>
</listheader>
<item>
<term>ISO8601</term>
<description>
Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
</description>
</item>
<item>
<term>DATE</term>
<description>
Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
</description>
</item>
<item>
<term>ABSOLUTE</term>
<description>
Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>.
</description>
</item>
<item>
<term>other</term>
<description>
Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
<see cref="M:DateTime.ToString(string)"/> method.
For details on valid patterns see
<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
</description>
</item>
</list>
</para>
<para>
The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone.
To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter">
<summary>
The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
</summary>
<remarks>
<para>
The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
</para>
</remarks>
</member>
<member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions">
<summary>
Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Convert the pattern into the rendered message
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
for it to render it to the writer.
</para>
<para>
The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType">
<summary>
The fully qualified type of the DatePatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.ExceptionPatternConverter">
<summary>
Write the exception text to the output
</summary>
<remarks>
<para>
If an exception object is stored in the logging event
it will be rendered into the pattern output with a
trailing newline.
</para>
<para>
If there is no exception then nothing will be output
and no trailing newline will be appended.
It is typical to put a newline before the exception
and to have the exception as the last data in the pattern.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the exception text to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
If an exception object is stored in the logging event
it will be rendered into the pattern output with a
trailing newline.
</para>
<para>
If there is no exception or the exception property specified
by the Option value does not exist then nothing will be output
and no trailing newline will be appended.
It is typical to put a newline before the exception
and to have the exception as the last data in the pattern.
</para>
<para>
Recognized values for the Option parameter are:
</para>
<list type="bullet">
<item>
<description>Message</description>
</item>
<item>
<description>Source</description>
</item>
<item>
<description>StackTrace</description>
</item>
<item>
<description>TargetSite</description>
</item>
<item>
<description>HelpLink</description>
</item>
</list>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.FileLocationPatternConverter">
<summary>
Writes the caller location file name to the output
</summary>
<remarks>
<para>
Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
the event to the output writer.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the caller location file name to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.FullLocationPatternConverter">
<summary>
Write the caller location info to the output
</summary>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the caller location info to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.IdentityPatternConverter">
<summary>
Writes the event identity to the output
</summary>
<remarks>
<para>
Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
the output writer.
</para>
</remarks>
<author>Daniel Cazzulino</author>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Writes the event identity to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes the value of the <paramref name="loggingEvent"/>
<see cref="P:log4net.Core.LoggingEvent.Identity"/> to
the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.LevelPatternConverter">
<summary>
Write the event level to the output
</summary>
<remarks>
<para>
Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/>
to the writer.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the event level to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/>
to the <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.LineLocationPatternConverter">
<summary>
Write the caller location line number to the output
</summary>
<remarks>
<para>
Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
the event to the output writer.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the caller location line number to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.LoggerPatternConverter">
<summary>
Converter for logger name
</summary>
<remarks>
<para>
Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="T:log4net.Layout.Pattern.NamedPatternConverter">
<summary>
Converter to output and truncate <c>'.'</c> separated strings
</summary>
<remarks>
<para>
This abstract class supports truncating a <c>'.'</c> separated string
to show a specified number of elements from the right hand side.
This is used to truncate class names that are fully qualified.
</para>
<para>
Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to
return the fully qualified string.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions">
<summary>
Initialize the converter
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
<summary>
Get the fully qualified string data
</summary>
<param name="loggingEvent">the event being logged</param>
<returns>the fully qualified name</returns>
<remarks>
<para>
Overridden by subclasses to get the fully qualified name before the
precision is applied to it.
</para>
<para>
Return the fully qualified <c>'.'</c> (dot/period) separated string.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Convert the pattern to the rendered message
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision
specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
</remarks>
</member>
<member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType">
<summary>
The fully qualified type of the NamedPatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
<summary>
Gets the fully qualified name of the logger
</summary>
<param name="loggingEvent">the event being logged</param>
<returns>The fully qualified logger name</returns>
<remarks>
<para>
Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.MessagePatternConverter">
<summary>
Writes the event message to the output
</summary>
<remarks>
<para>
Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
to write out the event message.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Writes the event message to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
to write out the event message.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter">
<summary>
Write the method name to the output
</summary>
<remarks>
<para>
Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
the output.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the method name to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
the output.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.NdcPatternConverter">
<summary>
Converter to include event NDC
</summary>
<remarks>
<para>
Outputs the value of the event property named <c>NDC</c>.
</para>
<para>
The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the event NDC to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
As the thread context stacks are now stored in named event properties
this converter simply looks up the value of the <c>NDC</c> property.
</para>
<para>
The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.PropertyPatternConverter">
<summary>
Property pattern converter
</summary>
<remarks>
<para>
Writes out the value of a named property. The property name
should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
property.
</para>
<para>
If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
then all the properties are written as key value pairs.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the property value to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes out the value of a named property. The property name
should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
property.
</para>
<para>
If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
then all the properties are written as key value pairs.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter">
<summary>
Converter to output the relative time of the event
</summary>
<remarks>
<para>
Converter to output the time of the event relative to the start of the program.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the relative time to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes out the relative time of the event in milliseconds.
That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)">
<summary>
Helper method to get the time difference between two DateTime objects
</summary>
<param name="start">start time (in the current local time zone)</param>
<param name="end">end time (in the current local time zone)</param>
<returns>the time difference in milliseconds</returns>
</member>
<member name="T:log4net.Layout.Pattern.StackTraceDetailPatternConverter">
<summary>
Write the caller stack frames to the output
</summary>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
</para>
</remarks>
<author>Adam Davies</author>
</member>
<member name="T:log4net.Layout.Pattern.StackTracePatternConverter">
<summary>
Write the caller stack frames to the output
</summary>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
</para>
</remarks>
<author>Michael Cromwell</author>
</member>
<member name="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions">
<summary>
Initialize the converter
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.Pattern.StackTracePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the strack frames to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.Pattern.StackTracePatternConverter.GetMethodInformation(log4net.Core.MethodItem)">
<summary>
Returns the Name of the method
</summary>
<param name="method"></param>
<remarks>This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter</remarks>
<returns>string</returns>
</member>
<member name="F:log4net.Layout.Pattern.StackTracePatternConverter.declaringType">
<summary>
The fully qualified type of the StackTracePatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="F:log4net.Layout.Pattern.StackTraceDetailPatternConverter.declaringType">
<summary>
The fully qualified type of the StackTraceDetailPatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.ThreadPatternConverter">
<summary>
Converter to include event thread name
</summary>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the ThreadName to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.TypeNamePatternConverter">
<summary>
Pattern converter for the class name
</summary>
<remarks>
<para>
Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
<summary>
Gets the fully qualified name of the class
</summary>
<param name="loggingEvent">the event being logged</param>
<returns>The fully qualified type name for the caller location</returns>
<remarks>
<para>
Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Pattern.UserNamePatternConverter">
<summary>
Converter to include event user name
</summary>
<author>Douglas de la Torre</author>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Convert the pattern to the rendered message
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
</member>
<member name="T:log4net.Layout.Pattern.UtcDatePatternConverter">
<summary>
Write the TimeStamp to the output
</summary>
<remarks>
<para>
Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
</para>
<para>
Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
in Universal time.
</para>
<para>
See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax.
</para>
</remarks>
<seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Write the TimeStamp to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
for it to render it to the writer.
</para>
<para>
The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted
to Universal time before it is rendered.
</para>
</remarks>
<seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
</member>
<member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType">
<summary>
The fully qualified type of the UtcDatePatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Layout.DynamicPatternLayout">
<summary>
A flexible layout configurable with pattern string that re-evaluates on each call.
</summary>
<remarks>
<para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the
features and capabilities of PatternLayout. PatternLayout is a 'static' class
in that its layout is done once at configuration time. This class will recreate
the layout on each reference.</para>
<para>One important difference between PatternLayout and DynamicPatternLayout is the
treatment of the Header and Footer parameters in the configuration. The Header and Footer
parameters for DynamicPatternLayout must be syntactically in the form of a PatternString,
but should not be marked as type log4net.Util.PatternString. Doing so causes the
pattern to be statically converted at configuration time and causes DynamicPatternLayout
to perform the same as PatternLayout.</para>
<para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para>
<example>
<layout type="log4net.Layout.DynamicPatternLayout">
<param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" />
<param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" />
</layout>
</example>
</remarks>
</member>
<member name="T:log4net.Layout.PatternLayout">
<summary>
A flexible layout configurable with pattern string.
</summary>
<remarks>
<para>
The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a
<see cref="T:log4net.Core.LoggingEvent"/> as a string. The results
depend on the <i>conversion pattern</i>.
</para>
<para>
The conversion pattern is closely related to the conversion
pattern of the printf function in C. A conversion pattern is
composed of literal text and format control expressions called
<i>conversion specifiers</i>.
</para>
<para>
<i>You are free to insert any literal text within the conversion
pattern.</i>
</para>
<para>
Each conversion specifier starts with a percent sign (%) and is
followed by optional <i>format modifiers</i> and a <i>conversion
pattern name</i>. The conversion pattern name specifies the type of
data, e.g. logger, level, date, thread name. The format
modifiers control such things as field width, padding, left and
right justification. The following is a simple example.
</para>
<para>
Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume
that the log4net environment was set to use a PatternLayout. Then the
statements
</para>
<code lang="C#">
ILog log = LogManager.GetLogger(typeof(TestApp));
log.Debug("Message 1");
log.Warn("Message 2");
</code>
<para>would yield the output</para>
<code>
DEBUG [main]: Message 1
WARN [main]: Message 2
</code>
<para>
Note that there is no explicit separator between text and
conversion specifiers. The pattern parser knows when it has reached
the end of a conversion specifier when it reads a conversion
character. In the example above the conversion specifier
<b>%-5level</b> means the level of the logging event should be left
justified to a width of five characters.
</para>
<para>
The recognized conversion pattern names are:
</para>
<list type="table">
<listheader>
<term>Conversion Pattern Name</term>
<description>Effect</description>
</listheader>
<item>
<term>a</term>
<description>Equivalent to <b>appdomain</b></description>
</item>
<item>
<term>appdomain</term>
<description>
Used to output the friendly name of the AppDomain where the
logging event was generated.
</description>
</item>
<item>
<term>aspnet-cache</term>
<description>
<para>
Used to output all cache items in the case of <b>%aspnet-cache</b> or just one named item if used as <b>%aspnet-cache{key}</b>
</para>
<para>
This pattern is not available for Compact Framework or Client Profile assemblies.
</para>
</description>
</item>
<item>
<term>aspnet-context</term>
<description>
<para>
Used to output all context items in the case of <b>%aspnet-context</b> or just one named item if used as <b>%aspnet-context{key}</b>
</para>
<para>
This pattern is not available for Compact Framework or Client Profile assemblies.
</para>
</description>
</item>
<item>
<term>aspnet-request</term>
<description>
<para>
Used to output all request parameters in the case of <b>%aspnet-request</b> or just one named param if used as <b>%aspnet-request{key}</b>
</para>
<para>
This pattern is not available for Compact Framework or Client Profile assemblies.
</para>
</description>
</item>
<item>
<term>aspnet-session</term>
<description>
<para>
Used to output all session items in the case of <b>%aspnet-session</b> or just one named item if used as <b>%aspnet-session{key}</b>
</para>
<para>
This pattern is not available for Compact Framework or Client Profile assemblies.
</para>
</description>
</item>
<item>
<term>c</term>
<description>Equivalent to <b>logger</b></description>
</item>
<item>
<term>C</term>
<description>Equivalent to <b>type</b></description>
</item>
<item>
<term>class</term>
<description>Equivalent to <b>type</b></description>
</item>
<item>
<term>d</term>
<description>Equivalent to <b>date</b></description>
</item>
<item>
<term>date</term>
<description>
<para>
Used to output the date of the logging event in the local time zone.
To output the date in universal time use the <c>%utcdate</c> pattern.
The date conversion
specifier may be followed by a <i>date format specifier</i> enclosed
between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
<b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
given then ISO8601 format is
assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
</para>
<para>
The date format specifier admits the same syntax as the
time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
</para>
<para>
For better results it is recommended to use the log4net date
formatters. These can be specified using one of the strings
"ABSOLUTE", "DATE" and "ISO8601" for specifying
<see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
<see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
<b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
</para>
<para>
These dedicated date formatters perform significantly
better than <see cref="M:DateTime.ToString(string)"/>.
</para>
</description>
</item>
<item>
<term>exception</term>
<description>
<para>
Used to output the exception passed in with the log message.
</para>
<para>
If an exception object is stored in the logging event
it will be rendered into the pattern output with a
trailing newline.
If there is no exception then nothing will be output
and no trailing newline will be appended.
It is typical to put a newline before the exception
and to have the exception as the last data in the pattern.
</para>
</description>
</item>
<item>
<term>F</term>
<description>Equivalent to <b>file</b></description>
</item>
<item>
<term>file</term>
<description>
<para>
Used to output the file name where the logging request was
issued.
</para>
<para>
<b>WARNING</b> Generating caller location information is
extremely slow. Its use should be avoided unless execution speed
is not an issue.
</para>
<para>
See the note below on the availability of caller location information.
</para>
</description>
</item>
<item>
<term>identity</term>
<description>
<para>
Used to output the user name for the currently active user
(Principal.Identity.Name).
</para>
<para>
<b>WARNING</b> Generating caller information is
extremely slow. Its use should be avoided unless execution speed
is not an issue.
</para>
</description>
</item>
<item>
<term>l</term>
<description>Equivalent to <b>location</b></description>
</item>
<item>
<term>L</term>
<description>Equivalent to <b>line</b></description>
</item>
<item>
<term>location</term>
<description>
<para>
Used to output location information of the caller which generated
the logging event.
</para>
<para>
The location information depends on the CLI implementation but
usually consists of the fully qualified name of the calling
method followed by the callers source the file name and line
number between parentheses.
</para>
<para>
The location information can be very useful. However, its
generation is <b>extremely</b> slow. Its use should be avoided
unless execution speed is not an issue.
</para>
<para>
See the note below on the availability of caller location information.
</para>
</description>
</item>
<item>
<term>level</term>
<description>
<para>
Used to output the level of the logging event.
</para>
</description>
</item>
<item>
<term>line</term>
<description>
<para>
Used to output the line number from where the logging request
was issued.
</para>
<para>
<b>WARNING</b> Generating caller location information is
extremely slow. Its use should be avoided unless execution speed
is not an issue.
</para>
<para>
See the note below on the availability of caller location information.
</para>
</description>
</item>
<item>
<term>logger</term>
<description>
<para>
Used to output the logger of the logging event. The
logger conversion specifier can be optionally followed by
<i>precision specifier</i>, that is a decimal constant in
brackets.
</para>
<para>
If a precision specifier is given, then only the corresponding
number of right most components of the logger name will be
printed. By default the logger name is printed in full.
</para>
<para>
For example, for the logger name "a.b.c" the pattern
<b>%logger{2}</b> will output "b.c".
</para>
</description>
</item>
<item>
<term>m</term>
<description>Equivalent to <b>message</b></description>
</item>
<item>
<term>M</term>
<description>Equivalent to <b>method</b></description>
</item>
<item>
<term>message</term>
<description>
<para>
Used to output the application supplied message associated with
the logging event.
</para>
</description>
</item>
<item>
<term>mdc</term>
<description>
<para>
The MDC (old name for the ThreadContext.Properties) is now part of the
combined event properties. This pattern is supported for compatibility
but is equivalent to <b>property</b>.
</para>
</description>
</item>
<item>
<term>method</term>
<description>
<para>
Used to output the method name where the logging request was
issued.
</para>
<para>
<b>WARNING</b> Generating caller location information is
extremely slow. Its use should be avoided unless execution speed
is not an issue.
</para>
<para>
See the note below on the availability of caller location information.
</para>
</description>
</item>
<item>
<term>n</term>
<description>Equivalent to <b>newline</b></description>
</item>
<item>
<term>newline</term>
<description>
<para>
Outputs the platform dependent line separator character or
characters.
</para>
<para>
This conversion pattern offers the same performance as using
non-portable line separator strings such as "\n", or "\r\n".
Thus, it is the preferred way of specifying a line separator.
</para>
</description>
</item>
<item>
<term>ndc</term>
<description>
<para>
Used to output the NDC (nested diagnostic context) associated
with the thread that generated the logging event.
</para>
</description>
</item>
<item>
<term>p</term>
<description>Equivalent to <b>level</b></description>
</item>
<item>
<term>P</term>
<description>Equivalent to <b>property</b></description>
</item>
<item>
<term>properties</term>
<description>Equivalent to <b>property</b></description>
</item>
<item>
<term>property</term>
<description>
<para>
Used to output the an event specific property. The key to
lookup must be specified within braces and directly following the
pattern specifier, e.g. <b>%property{user}</b> would include the value
from the property that is keyed by the string 'user'. Each property value
that is to be included in the log must be specified separately.
Properties are added to events by loggers or appenders. By default
the <c>log4net:HostName</c> property is set to the name of machine on
which the event was originally logged.
</para>
<para>
If no key is specified, e.g. <b>%property</b> then all the keys and their
values are printed in a comma separated list.
</para>
<para>
The properties of an event are combined from a number of different
contexts. These are listed below in the order in which they are searched.
</para>
<list type="definition">
<item>
<term>the event properties</term>
<description>
The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
properties are specific to this event only.
</description>
</item>
<item>
<term>the thread properties</term>
<description>
The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
thread. These properties are shared by all events logged on this thread.
</description>
</item>
<item>
<term>the global properties</term>
<description>
The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
properties are shared by all the threads in the AppDomain.
</description>
</item>
</list>
</description>
</item>
<item>
<term>r</term>
<description>Equivalent to <b>timestamp</b></description>
</item>
<item>
<term>stacktrace</term>
<description>
<para>
Used to output the stack trace of the logging event
The stack trace level specifier may be enclosed
between braces. For example, <b>%stacktrace{level}</b>.
If no stack trace level specifier is given then 1 is assumed
</para>
<para>
Output uses the format:
type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
</para>
<para>
This pattern is not available for Compact Framework assemblies.
</para>
</description>
</item>
<item>
<term>stacktracedetail</term>
<description>
<para>
Used to output the stack trace of the logging event
The stack trace level specifier may be enclosed
between braces. For example, <b>%stacktracedetail{level}</b>.
If no stack trace level specifier is given then 1 is assumed
</para>
<para>
Output uses the format:
type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
</para>
<para>
This pattern is not available for Compact Framework assemblies.
</para>
</description>
</item>
<item>
<term>t</term>
<description>Equivalent to <b>thread</b></description>
</item>
<item>
<term>timestamp</term>
<description>
<para>
Used to output the number of milliseconds elapsed since the start
of the application until the creation of the logging event.
</para>
</description>
</item>
<item>
<term>thread</term>
<description>
<para>
Used to output the name of the thread that generated the
logging event. Uses the thread number if no name is available.
</para>
</description>
</item>
<item>
<term>type</term>
<description>
<para>
Used to output the fully qualified type name of the caller
issuing the logging request. This conversion specifier
can be optionally followed by <i>precision specifier</i>, that
is a decimal constant in brackets.
</para>
<para>
If a precision specifier is given, then only the corresponding
number of right most components of the class name will be
printed. By default the class name is output in fully qualified form.
</para>
<para>
For example, for the class name "log4net.Layout.PatternLayout", the
pattern <b>%type{1}</b> will output "PatternLayout".
</para>
<para>
<b>WARNING</b> Generating the caller class information is
slow. Thus, its use should be avoided unless execution speed is
not an issue.
</para>
<para>
See the note below on the availability of caller location information.
</para>
</description>
</item>
<item>
<term>u</term>
<description>Equivalent to <b>identity</b></description>
</item>
<item>
<term>username</term>
<description>
<para>
Used to output the WindowsIdentity for the currently
active user.
</para>
<para>
<b>WARNING</b> Generating caller WindowsIdentity information is
extremely slow. Its use should be avoided unless execution speed
is not an issue.
</para>
</description>
</item>
<item>
<term>utcdate</term>
<description>
<para>
Used to output the date of the logging event in universal time.
The date conversion
specifier may be followed by a <i>date format specifier</i> enclosed
between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
<b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
given then ISO8601 format is
assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
</para>
<para>
The date format specifier admits the same syntax as the
time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
</para>
<para>
For better results it is recommended to use the log4net date
formatters. These can be specified using one of the strings
"ABSOLUTE", "DATE" and "ISO8601" for specifying
<see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
<see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
<b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
</para>
<para>
These dedicated date formatters perform significantly
better than <see cref="M:DateTime.ToString(string)"/>.
</para>
</description>
</item>
<item>
<term>w</term>
<description>Equivalent to <b>username</b></description>
</item>
<item>
<term>x</term>
<description>Equivalent to <b>ndc</b></description>
</item>
<item>
<term>X</term>
<description>Equivalent to <b>mdc</b></description>
</item>
<item>
<term>%</term>
<description>
<para>
The sequence %% outputs a single percent sign.
</para>
</description>
</item>
</list>
<para>
The single letter patterns are deprecated in favor of the
longer more descriptive pattern names.
</para>
<para>
By default the relevant information is output as is. However,
with the aid of format modifiers it is possible to change the
minimum field width, the maximum field width and justification.
</para>
<para>
The optional format modifier is placed between the percent sign
and the conversion pattern name.
</para>
<para>
The first optional format modifier is the <i>left justification
flag</i> which is just the minus (-) character. Then comes the
optional <i>minimum field width</i> modifier. This is a decimal
constant that represents the minimum number of characters to
output. If the data item requires fewer characters, it is padded on
either the left or the right until the minimum width is
reached. The default is to pad on the left (right justify) but you
can specify right padding with the left justification flag. The
padding character is space. If the data item is larger than the
minimum field width, the field is expanded to accommodate the
data. The value is never truncated.
</para>
<para>
This behavior can be changed using the <i>maximum field
width</i> modifier which is designated by a period followed by a
decimal constant. If the data item is longer than the maximum
field, then the extra characters are removed from the
<i>beginning</i> of the data item and not from the end. For
example, it the maximum field width is eight and the data item is
ten characters long, then the first two characters of the data item
are dropped. This behavior deviates from the printf function in C
where truncation is done from the end.
</para>
<para>
Below are various format modifier examples for the logger
conversion specifier.
</para>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr>
<th>Format modifier</th>
<th>left justify</th>
<th>minimum width</th>
<th>maximum width</th>
<th>comment</th>
</tr>
<tr>
<td align="center">%20logger</td>
<td align="center">false</td>
<td align="center">20</td>
<td align="center">none</td>
<td>
<para>
Left pad with spaces if the logger name is less than 20
characters long.
</para>
</td>
</tr>
<tr>
<td align="center">%-20logger</td>
<td align="center">true</td>
<td align="center">20</td>
<td align="center">none</td>
<td>
<para>
Right pad with spaces if the logger
name is less than 20 characters long.
</para>
</td>
</tr>
<tr>
<td align="center">%.30logger</td>
<td align="center">NA</td>
<td align="center">none</td>
<td align="center">30</td>
<td>
<para>
Truncate from the beginning if the logger
name is longer than 30 characters.
</para>
</td>
</tr>
<tr>
<td align="center"><nobr>%20.30logger</nobr></td>
<td align="center">false</td>
<td align="center">20</td>
<td align="center">30</td>
<td>
<para>
Left pad with spaces if the logger name is shorter than 20
characters. However, if logger name is longer than 30 characters,
then truncate from the beginning.
</para>
</td>
</tr>
<tr>
<td align="center">%-20.30logger</td>
<td align="center">true</td>
<td align="center">20</td>
<td align="center">30</td>
<td>
<para>
Right pad with spaces if the logger name is shorter than 20
characters. However, if logger name is longer than 30 characters,
then truncate from the beginning.
</para>
</td>
</tr>
</table>
</div>
<para>
<b>Note about caller location information.</b><br/>
The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c>
all generate caller location information.
Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate
a call stack. The caller's information is then extracted from this stack.
</para>
<note type="caution">
<para>
The <c>System.Diagnostics.StackTrace</c> class is not supported on the
.NET Compact Framework 1.0 therefore caller location information is not
available on that framework.
</para>
</note>
<note type="caution">
<para>
The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
</para>
<para>
"StackTrace information will be most informative with Debug build configurations.
By default, Debug builds include debug symbols, while Release builds do not. The
debug symbols contain most of the file, method name, line number, and column
information used in constructing StackFrame and StackTrace objects. StackTrace
might not report as many method calls as expected, due to code transformations
that occur during optimization."
</para>
<para>
This means that in a Release build the caller information may be incomplete or may
not exist at all! Therefore caller location information cannot be relied upon in a Release build.
</para>
</note>
<para>
Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
instance using the <see cref="M:AddConverter(string, Type)"/> method.
</para>
</remarks>
<example>
This is a more detailed pattern.
<code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code>
</example>
<example>
A similar pattern except that the relative time is
right padded if less than 6 digits, thread name is right padded if
less than 15 characters and truncated if longer and the logger
name is left padded if shorter than 30 characters and truncated if
longer.
<code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code>
</example>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Douglas de la Torre</author>
<author>Daniel Cazzulino</author>
</member>
<member name="T:log4net.Layout.LayoutSkeleton">
<summary>
Extend this abstract class to create your own log layout format.
</summary>
<remarks>
<para>
This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/>
interface. Most layout objects should extend this class.
</para>
</remarks>
<remarks>
<note type="inheritinfo">
<para>
Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/>
method.
</para>
<para>
Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default
constructor.
</para>
</note>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Layout.ILayout">
<summary>
Interface implemented by layout objects
</summary>
<remarks>
<para>
An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/>
as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an
appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string.
</para>
<para>
The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
text that is appender before any events and after all the events respectively.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Implement this method to create your own layout format.
</summary>
<param name="writer">The TextWriter to write the formatted event to</param>
<param name="loggingEvent">The event to format</param>
<remarks>
<para>
This method is called by an appender to format
the <paramref name="loggingEvent"/> as text and output to a writer.
</para>
<para>
If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the
event to be formatted as a <see cref="T:System.String"/> then the following
code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>.
</para>
<code lang="C#">
StringWriter writer = new StringWriter();
Layout.Format(writer, loggingEvent);
string formattedEvent = writer.ToString();
</code>
</remarks>
</member>
<member name="P:log4net.Layout.ILayout.ContentType">
<summary>
The content type output by this layout.
</summary>
<value>The content type</value>
<remarks>
<para>
The content type output by this layout.
</para>
<para>
This is a MIME type e.g. <c>"text/plain"</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.ILayout.Header">
<summary>
The header for the layout format.
</summary>
<value>the layout header</value>
<remarks>
<para>
The Header text will be appended before any logging events
are formatted and appended.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.ILayout.Footer">
<summary>
The footer for the layout format.
</summary>
<value>the layout footer</value>
<remarks>
<para>
The Footer text will be appended after all the logging events
have been formatted and appended.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.ILayout.IgnoresException">
<summary>
Flag indicating if this layout handle exceptions
</summary>
<value><c>false</c> if this layout handles exceptions</value>
<remarks>
<para>
If this layout handles the exception object contained within
<see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
<c>false</c>. Otherwise, if the layout ignores the exception
object, then the layout should return <c>true</c>.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.LayoutSkeleton.m_header">
<summary>
The header text
</summary>
<remarks>
<para>
See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.LayoutSkeleton.m_footer">
<summary>
The footer text
</summary>
<remarks>
<para>
See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException">
<summary>
Flag indicating if this layout handles exceptions
</summary>
<remarks>
<para>
<c>false</c> if this layout handles exceptions
</para>
</remarks>
</member>
<member name="M:log4net.Layout.LayoutSkeleton.#ctor">
<summary>
Empty default constructor
</summary>
<remarks>
<para>
Empty default constructor
</para>
</remarks>
</member>
<member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions">
<summary>
Activate component options
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again.
</para>
<para>
This method must be implemented by the subclass.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Implement this method to create your own layout format.
</summary>
<param name="writer">The TextWriter to write the formatted event to</param>
<param name="loggingEvent">The event to format</param>
<remarks>
<para>
This method is called by an appender to format
the <paramref name="loggingEvent"/> as text.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)">
<summary>
Convenience method for easily formatting the logging event into a string variable.
</summary>
<param name="loggingEvent"></param>
<remarks>
Creates a new StringWriter instance to store the formatted logging event.
</remarks>
</member>
<member name="P:log4net.Layout.LayoutSkeleton.ContentType">
<summary>
The content type output by this layout.
</summary>
<value>The content type is <c>"text/plain"</c></value>
<remarks>
<para>
The content type output by this layout.
</para>
<para>
This base class uses the value <c>"text/plain"</c>.
To change this value a subclass must override this
property.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.LayoutSkeleton.Header">
<summary>
The header for the layout format.
</summary>
<value>the layout header</value>
<remarks>
<para>
The Header text will be appended before any logging events
are formatted and appended.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.LayoutSkeleton.Footer">
<summary>
The footer for the layout format.
</summary>
<value>the layout footer</value>
<remarks>
<para>
The Footer text will be appended after all the logging events
have been formatted and appended.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.LayoutSkeleton.IgnoresException">
<summary>
Flag indicating if this layout handles exceptions
</summary>
<value><c>false</c> if this layout handles exceptions</value>
<remarks>
<para>
If this layout handles the exception object contained within
<see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
<c>false</c>. Otherwise, if the layout ignores the exception
object, then the layout should return <c>true</c>.
</para>
<para>
Set this value to override a this default setting. The default
value is <c>true</c>, this layout does not handle the exception.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern">
<summary>
Default pattern string for log output.
</summary>
<remarks>
<para>
Default pattern string for log output.
Currently set to the string <b>"%message%newline"</b>
which just prints the application supplied message.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.PatternLayout.DetailConversionPattern">
<summary>
A detailed conversion pattern
</summary>
<remarks>
<para>
A conversion pattern which includes Time, Thread, Logger, and Nested Context.
Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry">
<summary>
Internal map of converter identifiers to converter types.
</summary>
<remarks>
<para>
This static map is overridden by the m_converterRegistry instance map
</para>
</remarks>
</member>
<member name="F:log4net.Layout.PatternLayout.m_pattern">
<summary>
the pattern
</summary>
</member>
<member name="F:log4net.Layout.PatternLayout.m_head">
<summary>
the head of the pattern converter chain
</summary>
</member>
<member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry">
<summary>
patterns defined on this PatternLayout only
</summary>
</member>
<member name="M:log4net.Layout.PatternLayout.#cctor">
<summary>
Initialize the global registry
</summary>
<remarks>
<para>
Defines the builtin global rules.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.PatternLayout.#ctor">
<summary>
Constructs a PatternLayout using the DefaultConversionPattern
</summary>
<remarks>
<para>
The default pattern just produces the application supplied message.
</para>
<para>
Note to Inheritors: This constructor calls the virtual method
<see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
aware that it will be called before your is called constructor.
</para>
<para>
As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>
method must be called after the properties on this object have been
configured.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.PatternLayout.#ctor(System.String)">
<summary>
Constructs a PatternLayout using the supplied conversion pattern
</summary>
<param name="pattern">the pattern to use</param>
<remarks>
<para>
Note to Inheritors: This constructor calls the virtual method
<see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
aware that it will be called before your is called constructor.
</para>
<para>
When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method
need not be called. This may not be the case when using a subclass.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)">
<summary>
Create the pattern parser instance
</summary>
<param name="pattern">the pattern to parse</param>
<returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns>
<remarks>
<para>
Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the
global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.PatternLayout.ActivateOptions">
<summary>
Initialize layout options
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Produces a formatted string as specified by the conversion pattern.
</summary>
<param name="loggingEvent">the event being logged</param>
<param name="writer">The TextWriter to write the formatted event to</param>
<remarks>
<para>
Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format
specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)">
<summary>
Add a converter to this PatternLayout
</summary>
<param name="converterInfo">the converter info</param>
<remarks>
<para>
This version of the method is used by the configurator.
Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)">
<summary>
Add a converter to this PatternLayout
</summary>
<param name="name">the name of the conversion pattern for this converter</param>
<param name="type">the type of the converter</param>
<remarks>
<para>
Add a named pattern converter to this instance. This
converter will be used in the formatting of the event.
This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>.
</para>
<para>
The <paramref name="type"/> specified must extend the
<see cref="T:log4net.Util.PatternConverter"/> type.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.PatternLayout.ConversionPattern">
<summary>
The pattern formatting string
</summary>
<remarks>
<para>
The <b>ConversionPattern</b> option. This is the string which
controls formatting and consists of a mix of literal content and
conversion specifiers.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString">
<summary>
The header PatternString
</summary>
</member>
<member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString">
<summary>
The footer PatternString
</summary>
</member>
<member name="M:log4net.Layout.DynamicPatternLayout.#ctor">
<summary>
Constructs a DynamicPatternLayout using the DefaultConversionPattern
</summary>
<remarks>
<para>
The default pattern just produces the application supplied message.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)">
<summary>
Constructs a DynamicPatternLayout using the supplied conversion pattern
</summary>
<param name="pattern">the pattern to use</param>
<remarks>
</remarks>
</member>
<member name="P:log4net.Layout.DynamicPatternLayout.Header">
<summary>
The header for the layout format.
</summary>
<value>the layout header</value>
<remarks>
<para>
The Header text will be appended before any logging events
are formatted and appended.
</para>
The pattern will be formatted on each get operation.
</remarks>
</member>
<member name="P:log4net.Layout.DynamicPatternLayout.Footer">
<summary>
The footer for the layout format.
</summary>
<value>the layout footer</value>
<remarks>
<para>
The Footer text will be appended after all the logging events
have been formatted and appended.
</para>
The pattern will be formatted on each get operation.
</remarks>
</member>
<member name="T:log4net.Layout.ExceptionLayout">
<summary>
A Layout that renders only the Exception text from the logging event
</summary>
<remarks>
<para>
A Layout that renders only the Exception text from the logging event.
</para>
<para>
This Layout should only be used with appenders that utilize multiple
layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>).
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Layout.ExceptionLayout.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Constructs a ExceptionLayout
</para>
</remarks>
</member>
<member name="M:log4net.Layout.ExceptionLayout.ActivateOptions">
<summary>
Activate component options
</summary>
<remarks>
<para>
Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation
framework.
</para>
<para>
This method does nothing as options become effective immediately.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Gets the exception text from the logging event
</summary>
<param name="writer">The TextWriter to write the formatted event to</param>
<param name="loggingEvent">the event being logged</param>
<remarks>
<para>
Write the exception string to the <see cref="T:System.IO.TextWriter"/>.
The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.IRawLayout">
<summary>
Interface for raw layout objects
</summary>
<remarks>
<para>
Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/>
to an object.
</para>
<para>
This interface should not be confused with the
<see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in
only certain specialized situations where a raw object is
required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/>
is not generally useful than this interface.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)">
<summary>
Implement this method to create your own layout format.
</summary>
<param name="loggingEvent">The event to format</param>
<returns>returns the formatted event</returns>
<remarks>
<para>
Implement this method to create your own layout format.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.Layout2RawLayoutAdapter">
<summary>
Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/>
</summary>
<remarks>
<para>
Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter
allows a <see cref="T:log4net.Layout.ILayout"/> to be specified.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout">
<summary>
The layout to adapt
</summary>
</member>
<member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)">
<summary>
Construct a new adapter
</summary>
<param name="layout">the layout to adapt</param>
<remarks>
<para>
Create the adapter for the specified <paramref name="layout"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)">
<summary>
Format the logging event as an object.
</summary>
<param name="loggingEvent">The event to format</param>
<returns>returns the formatted event</returns>
<remarks>
<para>
Format the logging event as an object.
</para>
<para>
Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to
the constructor to perform the formatting.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.RawLayoutConverter">
<summary>
Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface
</summary>
<remarks>
<para>
Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface.
Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to
the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Util.TypeConverters.IConvertFrom">
<summary>
Interface supported by type converters
</summary>
<remarks>
<para>
This interface supports conversion from arbitrary types
to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)">
<summary>
Can the source type be converted to the type supported by this object
</summary>
<param name="sourceType">the type to convert</param>
<returns>true if the conversion is possible</returns>
<remarks>
<para>
Test if the <paramref name="sourceType"/> can be converted to the
type supported by this converter.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)">
<summary>
Convert the source object to the type supported by this object
</summary>
<param name="source">the object to convert</param>
<returns>the converted object</returns>
<remarks>
<para>
Converts the <paramref name="source"/> to the type supported
by this converter.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)">
<summary>
Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/>
</summary>
<param name="sourceType">the source to be to be converted</param>
<returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns>
<remarks>
<para>
Test if the <paramref name="sourceType"/> can be converted to a
<see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported
as the <paramref name="sourceType"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)">
<summary>
Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object
</summary>
<param name="source">the value to convert</param>
<returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns>
<remarks>
<para>
Convert the <paramref name="source"/> object to a
<see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object
is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>
is used to adapt between the two interfaces, otherwise an
exception is thrown.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.RawPropertyLayout">
<summary>
Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
</summary>
<remarks>
<para>
Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Layout.RawPropertyLayout.#ctor">
<summary>
Constructs a RawPropertyLayout
</summary>
</member>
<member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)">
<summary>
Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>
</summary>
<param name="loggingEvent">The event to format</param>
<returns>returns property value</returns>
<remarks>
<para>
Looks up and returns the object value of the property
named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined
with than name then <c>null</c> will be returned.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.RawPropertyLayout.Key">
<summary>
The name of the value to lookup in the LoggingEvent Properties collection.
</summary>
<value>
Value to lookup in the LoggingEvent Properties collection
</value>
<remarks>
<para>
String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.RawTimeStampLayout">
<summary>
Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
</summary>
<remarks>
<para>
Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Layout.RawTimeStampLayout.#ctor">
<summary>
Constructs a RawTimeStampLayout
</summary>
</member>
<member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)">
<summary>
Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
</summary>
<param name="loggingEvent">The event to format</param>
<returns>returns the time stamp</returns>
<remarks>
<para>
Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
</para>
<para>
The time stamp is in local time. To format the time stamp
in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.RawUtcTimeStampLayout">
<summary>
Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
</summary>
<remarks>
<para>
Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor">
<summary>
Constructs a RawUtcTimeStampLayout
</summary>
</member>
<member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)">
<summary>
Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
</summary>
<param name="loggingEvent">The event to format</param>
<returns>returns the time stamp</returns>
<remarks>
<para>
Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
</para>
<para>
The time stamp is in universal time. To format the time stamp
in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.SimpleLayout">
<summary>
A very simple layout
</summary>
<remarks>
<para>
SimpleLayout consists of the level of the log statement,
followed by " - " and then the log message itself. For example,
<code>
DEBUG - Hello world
</code>
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Layout.SimpleLayout.#ctor">
<summary>
Constructs a SimpleLayout
</summary>
</member>
<member name="M:log4net.Layout.SimpleLayout.ActivateOptions">
<summary>
Initialize layout options
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Produces a simple formatted output.
</summary>
<param name="loggingEvent">the event being logged</param>
<param name="writer">The TextWriter to write the formatted event to</param>
<remarks>
<para>
Formats the event as the level of the even,
followed by " - " and then the log message itself. The
output is terminated by a newline.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.XmlLayout">
<summary>
Layout that formats the log events as XML elements.
</summary>
<remarks>
<para>
The output of the <see cref="T:log4net.Layout.XmlLayout"/> consists of a series of
log4net:event elements. It does not output a complete well-formed XML
file. The output is designed to be included as an <em>external entity</em>
in a separate file to form a correct XML file.
</para>
<para>
For example, if <c>abc</c> is the name of the file where
the <see cref="T:log4net.Layout.XmlLayout"/> output goes, then a well-formed XML file would
be:
</para>
<code lang="XML">
<?xml version="1.0" ?>
<!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]>
<log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2>
&data;
</log4net:events>
</code>
<para>
This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout"/>
and the appender where it is embedded.
</para>
<para>
The <c>version</c> attribute helps components to correctly
interpret output generated by <see cref="T:log4net.Layout.XmlLayout"/>. The value of
this attribute should be "1.2" for release 1.2 and later.
</para>
<para>
Alternatively the <c>Header</c> and <c>Footer</c> properties can be
configured to output the correct XML header, open tag and close tag.
When setting the <c>Header</c> and <c>Footer</c> properties it is essential
that the underlying data store not be appendable otherwise the data
will become invalid XML.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Layout.XmlLayoutBase">
<summary>
Layout that formats the log events as XML elements.
</summary>
<remarks>
<para>
This is an abstract class that must be subclassed by an implementation
to conform to a specific schema.
</para>
<para>
Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Layout.XmlLayoutBase.#ctor">
<summary>
Protected constructor to support subclasses
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase"/> class
with no location info.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)">
<summary>
Protected constructor to support subclasses
</summary>
<remarks>
<para>
The <paramref name="locationInfo" /> parameter determines whether
location information will be output by the layout. If
<paramref name="locationInfo" /> is set to <c>true</c>, then the
file name and line number of the statement at the origin of the log
statement will be output.
</para>
<para>
If you are embedding this layout within an SMTPAppender
then make sure to set the <b>LocationInfo</b> option of that
appender as well.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions">
<summary>
Initialize layout options
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
<summary>
Produces a formatted string.
</summary>
<param name="loggingEvent">The event being logged.</param>
<param name="writer">The TextWriter to write the formatted event to</param>
<remarks>
<para>
Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
</para>
<para>
This method creates an <see cref="T:System.Xml.XmlTextWriter"/> that writes to the
<paramref name="writer"/>. The <see cref="T:System.Xml.XmlTextWriter"/> is passed
to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
<see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
<summary>
Does the actual writing of the XML.
</summary>
<param name="writer">The writer to use to output the event to.</param>
<param name="loggingEvent">The event to write.</param>
<remarks>
<para>
Subclasses should override this method to format
the <see cref="T:log4net.Core.LoggingEvent"/> as XML.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo">
<summary>
Flag to indicate if location information should be included in
the XML events.
</summary>
</member>
<member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
<summary>
The string to replace invalid chars with
</summary>
</member>
<member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
<summary>
Gets a value indicating whether to include location information in
the XML events.
</summary>
<value>
<c>true</c> if location information should be included in the XML
events; otherwise, <c>false</c>.
</value>
<remarks>
<para>
If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo"/> is set to <c>true</c>, then the file
name and line number of the statement at the origin of the log
statement will be output.
</para>
<para>
If you are embedding this layout within an <c>SMTPAppender</c>
then make sure to set the <b>LocationInfo</b> option of that
appender as well.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
<summary>
The string to replace characters that can not be expressed in XML with.
<remarks>
<para>
Not all characters may be expressed in XML. This property contains the
string to replace those that can not with. This defaults to a ?. Set it
to the empty string to simply remove offending characters. For more
details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
Character replacement will occur in the log message, the property names
and the property values.
</para>
</remarks>
</summary>
</member>
<member name="P:log4net.Layout.XmlLayoutBase.ContentType">
<summary>
Gets the content type output by this layout.
</summary>
<value>
As this is the XML layout, the value is always <c>"text/xml"</c>.
</value>
<remarks>
<para>
As this is the XML layout, the value is always <c>"text/xml"</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.XmlLayout.#ctor">
<summary>
Constructs an XmlLayout
</summary>
</member>
<member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)">
<summary>
Constructs an XmlLayout.
</summary>
<remarks>
<para>
The <b>LocationInfo</b> option takes a boolean value. By
default, it is set to false which means there will be no location
information output by this layout. If the the option is set to
true, then the file name and line number of the statement
at the origin of the log statement will be output.
</para>
<para>
If you are embedding this layout within an SmtpAppender
then make sure to set the <b>LocationInfo</b> option of that
appender as well.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.XmlLayout.ActivateOptions">
<summary>
Initialize layout options
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again.
</para>
<para>
Builds a cache of the element names
</para>
</remarks>
</member>
<member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
<summary>
Does the actual writing of the XML.
</summary>
<param name="writer">The writer to use to output the event to.</param>
<param name="loggingEvent">The event to write.</param>
<remarks>
<para>
Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Layout.XmlLayout.m_prefix">
<summary>
The prefix to use for all generated element names
</summary>
</member>
<member name="P:log4net.Layout.XmlLayout.Prefix">
<summary>
The prefix to use for all element names
</summary>
<remarks>
<para>
The default prefix is <b>log4net</b>. Set this property
to change the prefix. If the prefix is set to an empty string
then no prefix will be written.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
<summary>
Set whether or not to base64 encode the message.
</summary>
<remarks>
<para>
By default the log message will be written as text to the xml
output. This can cause problems when the message contains binary
data. By setting this to true the contents of the message will be
base64 encoded. If this is set then invalid character replacement
(see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
on the log message.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
<summary>
Set whether or not to base64 encode the property values.
</summary>
<remarks>
<para>
By default the properties will be written as text to the xml
output. This can cause problems when one or more properties contain
binary data. By setting this to true the values of the properties
will be base64 encoded. If this is set then invalid character replacement
(see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
on the property values.
</para>
</remarks>
</member>
<member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
<summary>
Layout that formats the log events as XML elements compatible with the log4j schema
</summary>
<remarks>
<para>
Formats the log events according to the http://logging.apache.org/log4j schema.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970">
<summary>
The 1st of January 1970 in UTC
</summary>
</member>
<member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor">
<summary>
Constructs an XMLLayoutSchemaLog4j
</summary>
</member>
<member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)">
<summary>
Constructs an XMLLayoutSchemaLog4j.
</summary>
<remarks>
<para>
The <b>LocationInfo</b> option takes a boolean value. By
default, it is set to false which means there will be no location
information output by this layout. If the the option is set to
true, then the file name and line number of the statement
at the origin of the log statement will be output.
</para>
<para>
If you are embedding this layout within an SMTPAppender
then make sure to set the <b>LocationInfo</b> option of that
appender as well.
</para>
</remarks>
</member>
<member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
<summary>
Actually do the writing of the xml
</summary>
<param name="writer">the writer to use</param>
<param name="loggingEvent">the event to write</param>
<remarks>
<para>
Generate XML that is compatible with the log4j schema.
</para>
</remarks>
</member>
<member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version">
<summary>
The version of the log4j schema to use.
</summary>
<remarks>
<para>
Only version 1.2 of the log4j schema is supported.
</para>
</remarks>
</member>
<member name="T:log4net.ObjectRenderer.DefaultRenderer">
<summary>
The default object Renderer.
</summary>
<remarks>
<para>
The default renderer supports rendering objects and collections to strings.
</para>
<para>
See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.ObjectRenderer.IObjectRenderer">
<summary>
Implement this interface in order to render objects as strings
</summary>
<remarks>
<para>
Certain types require special case conversion to
string form. This conversion is done by an object renderer.
Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>
interface.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
<summary>
Render the object <paramref name="obj"/> to a string
</summary>
<param name="rendererMap">The map used to lookup renderers</param>
<param name="obj">The object to render</param>
<param name="writer">The writer to render to</param>
<remarks>
<para>
Render the object <paramref name="obj"/> to a
string.
</para>
<para>
The <paramref name="rendererMap"/> parameter is
provided to lookup and render other objects. This is
very useful where <paramref name="obj"/> contains
nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/>
method can be used to render these objects.
</para>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Default constructor
</para>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
<summary>
Render the object <paramref name="obj"/> to a string
</summary>
<param name="rendererMap">The map used to lookup renderers</param>
<param name="obj">The object to render</param>
<param name="writer">The writer to render to</param>
<remarks>
<para>
Render the object <paramref name="obj"/> to a string.
</para>
<para>
The <paramref name="rendererMap"/> parameter is
provided to lookup and render other objects. This is
very useful where <paramref name="obj"/> contains
nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/>
method can be used to render these objects.
</para>
<para>
The default renderer supports rendering objects to strings as follows:
</para>
<list type="table">
<listheader>
<term>Value</term>
<description>Rendered String</description>
</listheader>
<item>
<term><c>null</c></term>
<description>
<para>"(null)"</para>
</description>
</item>
<item>
<term><see cref="T:System.Array"/></term>
<description>
<para>
For a one dimensional array this is the
array type name, an open brace, followed by a comma
separated list of the elements (using the appropriate
renderer), followed by a close brace.
</para>
<para>
For example: <c>int[] {1, 2, 3}</c>.
</para>
<para>
If the array is not one dimensional the
<c>Array.ToString()</c> is returned.
</para>
</description>
</item>
<item>
<term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> & <see cref="T:System.Collections.IEnumerator"/></term>
<description>
<para>
Rendered as an open brace, followed by a comma
separated list of the elements (using the appropriate
renderer), followed by a close brace.
</para>
<para>
For example: <c>{a, b, c}</c>.
</para>
<para>
All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
</para>
</description>
</item>
<item>
<term><see cref="T:System.Collections.DictionaryEntry"/></term>
<description>
<para>
Rendered as the key, an equals sign ('='), and the value (using the appropriate
renderer).
</para>
<para>
For example: <c>key=value</c>.
</para>
</description>
</item>
<item>
<term>other</term>
<description>
<para><c>Object.ToString()</c></para>
</description>
</item>
</list>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)">
<summary>
Render the array argument into a string
</summary>
<param name="rendererMap">The map used to lookup renderers</param>
<param name="array">the array to render</param>
<param name="writer">The writer to render to</param>
<remarks>
<para>
For a one dimensional array this is the
array type name, an open brace, followed by a comma
separated list of the elements (using the appropriate
renderer), followed by a close brace. For example:
<c>int[] {1, 2, 3}</c>.
</para>
<para>
If the array is not one dimensional the
<c>Array.ToString()</c> is returned.
</para>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
<summary>
Render the enumerator argument into a string
</summary>
<param name="rendererMap">The map used to lookup renderers</param>
<param name="enumerator">the enumerator to render</param>
<param name="writer">The writer to render to</param>
<remarks>
<para>
Rendered as an open brace, followed by a comma
separated list of the elements (using the appropriate
renderer), followed by a close brace. For example:
<c>{a, b, c}</c>.
</para>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)">
<summary>
Render the DictionaryEntry argument into a string
</summary>
<param name="rendererMap">The map used to lookup renderers</param>
<param name="entry">the DictionaryEntry to render</param>
<param name="writer">The writer to render to</param>
<remarks>
<para>
Render the key, an equals sign ('='), and the value (using the appropriate
renderer). For example: <c>key=value</c>.
</para>
</remarks>
</member>
<member name="T:log4net.ObjectRenderer.RendererMap">
<summary>
Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
</summary>
<remarks>
<para>
Maintains a mapping between types that require special
rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that
is used to render them.
</para>
<para>
The <see cref="M:FindAndRender(object)"/> method is used to render an
<c>object</c> using the appropriate renderers defined in this map.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.ObjectRenderer.RendererMap.#ctor">
<summary>
Default Constructor
</summary>
<remarks>
<para>
Default constructor.
</para>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)">
<summary>
Render <paramref name="obj"/> using the appropriate renderer.
</summary>
<param name="obj">the object to render to a string</param>
<returns>the object rendered as a string</returns>
<remarks>
<para>
This is a convenience method used to render an object to a string.
The alternative method <see cref="M:FindAndRender(object,TextWriter)"/>
should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>.
</para>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)">
<summary>
Render <paramref name="obj"/> using the appropriate renderer.
</summary>
<param name="obj">the object to render to a string</param>
<param name="writer">The writer to render to</param>
<remarks>
<para>
Find the appropriate renderer for the type of the
<paramref name="obj"/> parameter. This is accomplished by calling the
<see cref="M:Get(Type)"/> method. Once a renderer is found, it is
applied on the object <paramref name="obj"/> and the result is returned
as a <see cref="T:System.String"/>.
</para>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)">
<summary>
Gets the renderer for the specified object type
</summary>
<param name="obj">the object to lookup the renderer for</param>
<returns>the renderer for <paramref name="obj"/></returns>
<remarks>
<param>
Gets the renderer for the specified object type.
</param>
<param>
Syntactic sugar method that calls <see cref="M:Get(Type)"/>
with the type of the object parameter.
</param>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)">
<summary>
Gets the renderer for the specified type
</summary>
<param name="type">the type to lookup the renderer for</param>
<returns>the renderer for the specified type</returns>
<remarks>
<para>
Returns the renderer for the specified type.
If no specific renderer has been defined the
<see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned.
</para>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)">
<summary>
Internal function to recursively search interfaces
</summary>
<param name="type">the type to lookup the renderer for</param>
<returns>the renderer for the specified type</returns>
</member>
<member name="M:log4net.ObjectRenderer.RendererMap.Clear">
<summary>
Clear the map of renderers
</summary>
<remarks>
<para>
Clear the custom renderers defined by using
<see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/>
cannot be removed.
</para>
</remarks>
</member>
<member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
<summary>
Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>.
</summary>
<param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param>
<param name="renderer">the renderer for <paramref name="typeToRender"/></param>
<remarks>
<para>
Register an object renderer for a specific source type.
This renderer will be returned from a call to <see cref="M:Get(Type)"/>
specifying the same <paramref name="typeToRender"/> as an argument.
</para>
</remarks>
</member>
<member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer">
<summary>
Get the default renderer instance
</summary>
<value>the default renderer</value>
<remarks>
<para>
Get the default renderer
</para>
</remarks>
</member>
<member name="T:log4net.Plugin.IPlugin">
<summary>
Interface implemented by logger repository plugins.
</summary>
<remarks>
<para>
Plugins define additional behavior that can be associated
with a <see cref="T:log4net.Repository.ILoggerRepository"/>.
The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/>
property is used to store the plugins for a repository.
</para>
<para>
The <c>log4net.Config.PluginAttribute</c> can be used to
attach plugins to repositories created using configuration
attributes.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)">
<summary>
Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
</summary>
<param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
<remarks>
<para>
A plugin may only be attached to a single repository.
</para>
<para>
This method is called when the plugin is attached to the repository.
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.IPlugin.Shutdown">
<summary>
Is called when the plugin is to shutdown.
</summary>
<remarks>
<para>
This method is called to notify the plugin that
it should stop operating and should detach from
the repository.
</para>
</remarks>
</member>
<member name="P:log4net.Plugin.IPlugin.Name">
<summary>
Gets the name of the plugin.
</summary>
<value>
The name of the plugin.
</value>
<remarks>
<para>
Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
keyed by name. Each plugin instance attached to a
repository must be a unique name.
</para>
</remarks>
</member>
<member name="T:log4net.Plugin.PluginCollection">
<summary>
A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects.
</summary>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)">
<summary>
Creates a read-only wrapper for a <c>PluginCollection</c> instance.
</summary>
<param name="list">list to create a readonly wrapper arround</param>
<returns>
A <c>PluginCollection</c> wrapper that is read-only.
</returns>
</member>
<member name="M:log4net.Plugin.PluginCollection.#ctor">
<summary>
Initializes a new instance of the <c>PluginCollection</c> class
that is empty and has the default initial capacity.
</summary>
</member>
<member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)">
<summary>
Initializes a new instance of the <c>PluginCollection</c> class
that has the specified initial capacity.
</summary>
<param name="capacity">
The number of elements that the new <c>PluginCollection</c> is initially capable of storing.
</param>
</member>
<member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)">
<summary>
Initializes a new instance of the <c>PluginCollection</c> class
that contains elements copied from the specified <c>PluginCollection</c>.
</summary>
<param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param>
</member>
<member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])">
<summary>
Initializes a new instance of the <c>PluginCollection</c> class
that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array.
</summary>
<param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param>
</member>
<member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)">
<summary>
Initializes a new instance of the <c>PluginCollection</c> class
that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection.
</summary>
<param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param>
</member>
<member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)">
<summary>
Allow subclasses to avoid our default constructors
</summary>
<param name="tag"></param>
<exclude/>
</member>
<member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])">
<summary>
Copies the entire <c>PluginCollection</c> to a one-dimensional
<see cref="T:log4net.Plugin.IPlugin"/> array.
</summary>
<param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
</member>
<member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)">
<summary>
Copies the entire <c>PluginCollection</c> to a one-dimensional
<see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
<param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)">
<summary>
Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param>
<returns>The index at which the value has been added.</returns>
</member>
<member name="M:log4net.Plugin.PluginCollection.Clear">
<summary>
Removes all elements from the <c>PluginCollection</c>.
</summary>
</member>
<member name="M:log4net.Plugin.PluginCollection.Clone">
<summary>
Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>.
</summary>
<returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns>
</member>
<member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)">
<summary>
Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param>
<returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)">
<summary>
Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/>
in the <c>PluginCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param>
<returns>
The zero-based index of the first occurrence of <paramref name="item"/>
in the entire <c>PluginCollection</c>, if found; otherwise, -1.
</returns>
</member>
<member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)">
<summary>
Inserts an element into the <c>PluginCollection</c> at the specified index.
</summary>
<param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
<param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="index"/> is less than zero</para>
<para>-or-</para>
<para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
</exception>
</member>
<member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)">
<summary>
Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>.
</summary>
<param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param>
<exception cref="T:System.ArgumentException">
The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>.
</exception>
</member>
<member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)">
<summary>
Removes the element at the specified index of the <c>PluginCollection</c>.
</summary>
<param name="index">The zero-based index of the element to remove.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="index"/> is less than zero.</para>
<para>-or-</para>
<para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
</exception>
</member>
<member name="M:log4net.Plugin.PluginCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the <c>PluginCollection</c>.
</summary>
<returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns>
</member>
<member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)">
<summary>
Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>.
</summary>
<param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param>
<returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
</member>
<member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])">
<summary>
Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>.
</summary>
<param name="x">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements should be added to the end of the <c>PluginCollection</c>.</param>
<returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
</member>
<member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)">
<summary>
Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>.
</summary>
<param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements should be added to the end of the <c>PluginCollection</c>.</param>
<returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
</member>
<member name="M:log4net.Plugin.PluginCollection.TrimToSize">
<summary>
Sets the capacity to the actual number of elements.
</summary>
</member>
<member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)">
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="i"/> is less than zero.</para>
<para>-or-</para>
<para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
</exception>
</member>
<member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)">
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="i"/> is less than zero.</para>
<para>-or-</para>
<para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
</exception>
</member>
<member name="P:log4net.Plugin.PluginCollection.Count">
<summary>
Gets the number of elements actually contained in the <c>PluginCollection</c>.
</summary>
</member>
<member name="P:log4net.Plugin.PluginCollection.IsSynchronized">
<summary>
Gets a value indicating whether access to the collection is synchronized (thread-safe).
</summary>
<returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns>
</member>
<member name="P:log4net.Plugin.PluginCollection.SyncRoot">
<summary>
Gets an object that can be used to synchronize access to the collection.
</summary>
<value>
An object that can be used to synchronize access to the collection.
</value>
</member>
<member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)">
<summary>
Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
</summary>
<value>
The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
</value>
<param name="index">The zero-based index of the element to get or set.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<para><paramref name="index"/> is less than zero.</para>
<para>-or-</para>
<para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
</exception>
</member>
<member name="P:log4net.Plugin.PluginCollection.IsFixedSize">
<summary>
Gets a value indicating whether the collection has a fixed size.
</summary>
<value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value>
</member>
<member name="P:log4net.Plugin.PluginCollection.IsReadOnly">
<summary>
Gets a value indicating whether the IList is read-only.
</summary>
<value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value>
</member>
<member name="P:log4net.Plugin.PluginCollection.Capacity">
<summary>
Gets or sets the number of elements the <c>PluginCollection</c> can contain.
</summary>
<value>
The number of elements the <c>PluginCollection</c> can contain.
</value>
</member>
<member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator">
<summary>
Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
</summary>
<exclude/>
</member>
<member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element in the collection.
</summary>
<returns>
<c>true</c> if the enumerator was successfully advanced to the next element;
<c>false</c> if the enumerator has passed the end of the collection.
</returns>
<exception cref="T:System.InvalidOperationException">
The collection was modified after the enumerator was created.
</exception>
</member>
<member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, before the first element in the collection.
</summary>
</member>
<member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
</member>
<member name="T:log4net.Plugin.PluginCollection.Tag">
<summary>
Type visible only to our subclasses
Used to access protected constructor
</summary>
<exclude/>
</member>
<member name="F:log4net.Plugin.PluginCollection.Tag.Default">
<summary>
A value
</summary>
</member>
<member name="T:log4net.Plugin.PluginCollection.Enumerator">
<summary>
Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
</summary>
<exclude/>
</member>
<member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)">
<summary>
Initializes a new instance of the <c>Enumerator</c> class.
</summary>
<param name="tc"></param>
</member>
<member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext">
<summary>
Advances the enumerator to the next element in the collection.
</summary>
<returns>
<c>true</c> if the enumerator was successfully advanced to the next element;
<c>false</c> if the enumerator has passed the end of the collection.
</returns>
<exception cref="T:System.InvalidOperationException">
The collection was modified after the enumerator was created.
</exception>
</member>
<member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset">
<summary>
Sets the enumerator to its initial position, before the first element in the collection.
</summary>
</member>
<member name="P:log4net.Plugin.PluginCollection.Enumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<value>
The current element in the collection.
</value>
</member>
<member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection">
<exclude/>
</member>
<member name="T:log4net.Plugin.PluginMap">
<summary>
Map of repository plugins.
</summary>
<remarks>
<para>
This class is a name keyed map of the plugins that are
attached to a repository.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)">
<summary>
Constructor
</summary>
<param name="repository">The repository that the plugins should be attached to.</param>
<remarks>
<para>
Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap"/> class with a
repository that the plugins should be attached to.
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)">
<summary>
Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the map.
</summary>
<param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to add to the map.</param>
<remarks>
<para>
The <see cref="T:log4net.Plugin.IPlugin"/> will be attached to the repository when added.
</para>
<para>
If there already exists a plugin with the same name
attached to the repository then the old plugin will
be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with
the new plugin.
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)">
<summary>
Removes a <see cref="T:log4net.Plugin.IPlugin"/> from the map.
</summary>
<param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the map.</param>
<remarks>
<para>
Remove a specific plugin from this map.
</para>
</remarks>
</member>
<member name="P:log4net.Plugin.PluginMap.Item(System.String)">
<summary>
Gets a <see cref="T:log4net.Plugin.IPlugin"/> by name.
</summary>
<param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin"/> to lookup.</param>
<returns>
The <see cref="T:log4net.Plugin.IPlugin"/> from the map with the name specified, or
<c>null</c> if no plugin is found.
</returns>
<remarks>
<para>
Lookup a plugin by name. If the plugin is not found <c>null</c>
will be returned.
</para>
</remarks>
</member>
<member name="P:log4net.Plugin.PluginMap.AllPlugins">
<summary>
Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.
</summary>
<value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.</value>
<remarks>
<para>
Get a collection of all the plugins defined in this map.
</para>
</remarks>
</member>
<member name="T:log4net.Plugin.PluginSkeleton">
<summary>
Base implementation of <see cref="T:log4net.Plugin.IPlugin"/>
</summary>
<remarks>
<para>
Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/>
interface. This base class can be used by implementors
of the <see cref="T:log4net.Plugin.IPlugin"/> interface.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="name">the name of the plugin</param>
<remarks>
Initializes a new Plugin with the specified name.
</remarks>
</member>
<member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)">
<summary>
Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
</summary>
<param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
<remarks>
<para>
A plugin may only be attached to a single repository.
</para>
<para>
This method is called when the plugin is attached to the repository.
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.PluginSkeleton.Shutdown">
<summary>
Is called when the plugin is to shutdown.
</summary>
<remarks>
<para>
This method is called to notify the plugin that
it should stop operating and should detach from
the repository.
</para>
</remarks>
</member>
<member name="F:log4net.Plugin.PluginSkeleton.m_name">
<summary>
The name of this plugin.
</summary>
</member>
<member name="F:log4net.Plugin.PluginSkeleton.m_repository">
<summary>
The repository this plugin is attached to.
</summary>
</member>
<member name="P:log4net.Plugin.PluginSkeleton.Name">
<summary>
Gets or sets the name of the plugin.
</summary>
<value>
The name of the plugin.
</value>
<remarks>
<para>
Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
keyed by name. Each plugin instance attached to a
repository must be a unique name.
</para>
<para>
The name of the plugin must not change one the
plugin has been attached to a repository.
</para>
</remarks>
</member>
<member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository">
<summary>
The repository for this plugin
</summary>
<value>
The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is attached to.
</value>
<remarks>
<para>
Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is
attached to.
</para>
</remarks>
</member>
<member name="T:log4net.Plugin.RemoteLoggingServerPlugin">
<summary>
Plugin that listens for events from the <see cref="T:log4net.Appender.RemotingAppender"/>
</summary>
<remarks>
<para>
This plugin publishes an instance of <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
on a specified <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/>. This listens for logging events delivered from
a remote <see cref="T:log4net.Appender.RemotingAppender"/>.
</para>
<para>
When an event is received it is relogged within the attached repository
as if it had been raised locally.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class.
</para>
<para>
The <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> property must be set.
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor(System.String)">
<summary>
Construct with sink Uri.
</summary>
<param name="sinkUri">The name to publish the sink under in the remoting infrastructure.
See <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> for more details.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class
with specified name.
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Attach(log4net.Repository.ILoggerRepository)">
<summary>
Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
</summary>
<param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
<remarks>
<para>
A plugin may only be attached to a single repository.
</para>
<para>
This method is called when the plugin is attached to the repository.
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Shutdown">
<summary>
Is called when the plugin is to shutdown.
</summary>
<remarks>
<para>
When the plugin is shutdown the remote logging
sink is disconnected.
</para>
</remarks>
</member>
<member name="F:log4net.Plugin.RemoteLoggingServerPlugin.declaringType">
<summary>
The fully qualified type of the RemoteLoggingServerPlugin class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri">
<summary>
Gets or sets the URI of this sink.
</summary>
<value>
The URI of this sink.
</value>
<remarks>
<para>
This is the name under which the object is marshaled.
<see cref="M:RemotingServices.Marshal(MarshalByRefObject,String,Type)"/>
</para>
</remarks>
</member>
<member name="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl">
<summary>
Delivers <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
</summary>
<remarks>
<para>
Internal class used to listen for logging events
and deliver them to the local repository.
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.#ctor(log4net.Repository.ILoggerRepository)">
<summary>
Constructor
</summary>
<param name="repository">The repository to log to.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl"/> for the
specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.LogEvents(log4net.Core.LoggingEvent[])">
<summary>
Logs the events to the repository.
</summary>
<param name="events">The events to log.</param>
<remarks>
<para>
The events passed are logged to the <see cref="T:log4net.Repository.ILoggerRepository"/>
</para>
</remarks>
</member>
<member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.InitializeLifetimeService">
<summary>
Obtains a lifetime service object to control the lifetime
policy for this instance.
</summary>
<returns><c>null</c> to indicate that this instance should live forever.</returns>
<remarks>
<para>
Obtains a lifetime service object to control the lifetime
policy for this instance. This object should live forever
therefore this implementation returns <c>null</c>.
</para>
</remarks>
</member>
<member name="F:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.m_repository">
<summary>
The underlying <see cref="T:log4net.Repository.ILoggerRepository"/> that events should
be logged to.
</summary>
</member>
<member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory">
<summary>
Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
</summary>
<remarks>
<para>
This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
interface is used to create the default subclass
of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Repository.Hierarchy.ILoggerFactory">
<summary>
Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances
</summary>
<remarks>
<para>
This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to
create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects.
</para>
<para>
The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called
to create a named <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
</para>
<para>
Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
<summary>
Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
</summary>
<param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
<param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
<returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
<remarks>
<para>
Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
specified name.
</para>
<para>
Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
</para>
<para>
If the <paramref name="name"/> is <c>null</c> then the root logger
must be returned.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
<summary>
Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
</summary>
<param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
<param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
<returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
<remarks>
<para>
Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
specified name.
</para>
<para>
Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
</para>
<para>
If the <paramref name="name"/> is <c>null</c> then the root logger
must be returned.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl">
<summary>
Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/>
</summary>
<remarks>
<para>
This subclass has no additional behavior over the
<see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances
to be created.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.Logger">
<summary>
Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>
</summary>
<remarks>
<para>
Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/>
interface. Applications should use <see cref="T:log4net.LogManager"/> to get
logger instances.
</para>
<para>
This is one of the central classes in the log4net implementation. One of the
distinctive features of log4net are hierarchical loggers and their
evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/>
instances into a rooted tree hierarchy.
</para>
<para>
The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of
<see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Aspi Havewala</author>
<author>Douglas de la Torre</author>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)">
<summary>
This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance and
sets its name.
</summary>
<param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
<remarks>
<para>
This constructor is protected and designed to be used by
a subclass that is not abstract.
</para>
<para>
Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default
logger creator.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)">
<summary>
Add <paramref name="newAppender"/> to the list of appenders of this
Logger instance.
</summary>
<param name="newAppender">An appender to add to this logger</param>
<remarks>
<para>
Add <paramref name="newAppender"/> to the list of appenders of this
Logger instance.
</para>
<para>
If <paramref name="newAppender"/> is already in the list of
appenders, then it won't be added again.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)">
<summary>
Look for the appender named as <c>name</c>
</summary>
<param name="name">The name of the appender to lookup</param>
<returns>The appender with the name specified, or <c>null</c>.</returns>
<remarks>
<para>
Returns the named appender, or null if the appender is not found.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders">
<summary>
Remove all previously added appenders from this Logger instance.
</summary>
<remarks>
<para>
Remove all previously added appenders from this Logger instance.
</para>
<para>
This is useful when re-reading configuration information.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)">
<summary>
Remove the appender passed as parameter form the list of appenders.
</summary>
<param name="appender">The appender to remove</param>
<returns>The appender removed from the list</returns>
<remarks>
<para>
Remove the appender passed as parameter form the list of appenders.
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)">
<summary>
Remove the appender passed as parameter form the list of appenders.
</summary>
<param name="name">The name of the appender to remove</param>
<returns>The appender removed from the list</returns>
<remarks>
<para>
Remove the named appender passed as parameter form the list of appenders.
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
<summary>
This generic form is intended to be used by wrappers.
</summary>
<param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
the stack boundary into the logging system for this call.</param>
<param name="level">The level of the message to be logged.</param>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
Generate a logging event for the specified <paramref name="level"/> using
the <paramref name="message"/> and <paramref name="exception"/>.
</para>
<para>
This method must not throw any exception to the caller.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
<summary>
This is the most generic printing method that is intended to be used
by wrappers.
</summary>
<param name="logEvent">The event being logged.</param>
<remarks>
<para>
Logs the specified logging event through this logger.
</para>
<para>
This method must not throw any exception to the caller.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
<summary>
Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter.
</summary>
<param name="level">The level to check.</param>
<returns>
<c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
</returns>
<remarks>
<para>
Test if this logger is going to log events of the specified <paramref name="level"/>.
</para>
<para>
This method must not throw any exception to the caller.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
<summary>
Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders.
</summary>
<param name="loggingEvent">The event to log.</param>
<remarks>
<para>
Call the appenders in the hierarchy starting at
<c>this</c>. If no appenders could be found, emit a
warning.
</para>
<para>
This method calls all the appenders inherited from the
hierarchy circumventing any evaluation of whether to log or not
to log the particular log request.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders">
<summary>
Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
</summary>
<remarks>
<para>
Used to ensure that the appenders are correctly shutdown.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)">
<summary>
This is the most generic printing method. This generic form is intended to be used by wrappers
</summary>
<param name="level">The level of the message to be logged.</param>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
Generate a logging event for the specified <paramref name="level"/> using
the <paramref name="message"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)">
<summary>
Creates a new logging event and logs the event without further checks.
</summary>
<param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
the stack boundary into the logging system for this call.</param>
<param name="level">The level of the message to be logged.</param>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
Generates a logging event and delivers it to the attached
appenders.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)">
<summary>
Creates a new logging event and logs the event without further checks.
</summary>
<param name="logEvent">The event being logged.</param>
<remarks>
<para>
Delivers the logging event to the attached appenders.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.Hierarchy.Logger.declaringType">
<summary>
The fully qualified type of the Logger class.
</summary>
</member>
<member name="F:log4net.Repository.Hierarchy.Logger.m_name">
<summary>
The name of this logger.
</summary>
</member>
<member name="F:log4net.Repository.Hierarchy.Logger.m_level">
<summary>
The assigned level of this logger.
</summary>
<remarks>
<para>
The <c>level</c> variable need not be
assigned a value in which case it is inherited
form the hierarchy.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.Hierarchy.Logger.m_parent">
<summary>
The parent of this logger.
</summary>
<remarks>
<para>
The parent of this logger.
All loggers have at least one ancestor which is the root logger.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy">
<summary>
Loggers need to know what Hierarchy they are in.
</summary>
<remarks>
<para>
Loggers need to know what Hierarchy they are in.
The hierarchy that this logger is a member of is stored
here.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl">
<summary>
Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
</summary>
</member>
<member name="F:log4net.Repository.Hierarchy.Logger.m_additive">
<summary>
Flag indicating if child loggers inherit their parents appenders
</summary>
<remarks>
<para>
Additivity is set to true by default, that is children inherit
the appenders of their ancestors by default. If this variable is
set to <c>false</c> then the appenders found in the
ancestors of this logger are not used. However, the children
of this logger will inherit its appenders, unless the children
have their additivity flag set to <c>false</c> too. See
the user manual for more details.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock">
<summary>
Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl
</summary>
</member>
<member name="P:log4net.Repository.Hierarchy.Logger.Parent">
<summary>
Gets or sets the parent logger in the hierarchy.
</summary>
<value>
The parent logger in the hierarchy.
</value>
<remarks>
<para>
Part of the Composite pattern that makes the hierarchy.
The hierarchy is parent linked rather than child linked.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Logger.Additivity">
<summary>
Gets or sets a value indicating if child loggers inherit their parent's appenders.
</summary>
<value>
<c>true</c> if child loggers inherit their parent's appenders.
</value>
<remarks>
<para>
Additivity is set to <c>true</c> by default, that is children inherit
the appenders of their ancestors by default. If this variable is
set to <c>false</c> then the appenders found in the
ancestors of this logger are not used. However, the children
of this logger will inherit its appenders, unless the children
have their additivity flag set to <c>false</c> too. See
the user manual for more details.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel">
<summary>
Gets the effective level for this logger.
</summary>
<returns>The nearest level in the logger hierarchy.</returns>
<remarks>
<para>
Starting from this logger, searches the logger hierarchy for a
non-null level and returns it. Otherwise, returns the level of the
root logger.
</para>
<para>The Logger class is designed so that this method executes as
quickly as possible.</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy">
<summary>
Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this
<c>Logger</c> instance is attached to.
</summary>
<value>The hierarchy that this logger belongs to.</value>
<remarks>
<para>
This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Logger.Level">
<summary>
Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger.
</summary>
<value>
The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger.
</value>
<remarks>
<para>
The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Logger.Appenders">
<summary>
Get the appenders contained in this logger as an
<see cref="T:System.Collections.ICollection"/>.
</summary>
<returns>A collection of the appenders in this logger</returns>
<remarks>
<para>
Get the appenders contained in this logger as an
<see cref="T:System.Collections.ICollection"/>. If no appenders
can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Logger.Name">
<summary>
Gets the logger name.
</summary>
<value>
The name of the logger.
</value>
<remarks>
<para>
The name of this logger
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Logger.Repository">
<summary>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
<c>Logger</c> instance is attached to.
</summary>
<value>
The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
</value>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
<c>Logger</c> instance is attached to.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)">
<summary>
Construct a new Logger
</summary>
<param name="name">the name of the logger</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl"/> class
with the specified name.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler">
<summary>
Delegate used to handle logger creation event notifications.
</summary>
<param name="sender">The <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> in which the <see cref="T:log4net.Repository.Hierarchy.Logger"/> has been created.</param>
<param name="e">The <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event args that hold the <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance that has been created.</param>
<remarks>
<para>
Delegate used to handle logger creation event notifications.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs">
<summary>
Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event.
</summary>
<remarks>
<para>
A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a
<see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log">
<summary>
The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created
</summary>
</member>
<member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)">
<summary>
Constructor
</summary>
<param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event argument
class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger">
<summary>
Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
</summary>
<value>
The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
</value>
<remarks>
<para>
The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.Hierarchy">
<summary>
Hierarchical organization of loggers
</summary>
<remarks>
<para>
<i>The casual user should not have to deal with this class
directly.</i>
</para>
<para>
This class is specialized in retrieving loggers by name and
also maintaining the logger hierarchy. Implements the
<see cref="T:log4net.Repository.ILoggerRepository"/> interface.
</para>
<para>
The structure of the logger hierarchy is maintained by the
<see cref="M:GetLogger(string)"/> method. The hierarchy is such that children
link to their parent but parents do not have any references to their
children. Moreover, loggers can be instantiated in any order, in
particular descendant before ancestor.
</para>
<para>
In case a descendant is created before a particular ancestor,
then it creates a provision node for the ancestor and adds itself
to the provision node. Other descendants of the same ancestor add
themselves to the previously created provision node.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Repository.LoggerRepositorySkeleton">
<summary>
Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/>
</summary>
<remarks>
<para>
Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
</para>
<para>
Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Repository.ILoggerRepository">
<summary>
Interface implemented by logger repositories.
</summary>
<remarks>
<para>
This interface is implemented by logger repositories. e.g.
<see cref="N:log4net.Repository.Hierarchy"/>.
</para>
<para>
This interface is used by the <see cref="T:log4net.LogManager"/>
to obtain <see cref="T:log4net.ILog"/> interfaces.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)">
<summary>
Check if the named logger exists in the repository. If so return
its reference, otherwise returns <c>null</c>.
</summary>
<param name="name">The name of the logger to lookup</param>
<returns>The Logger object with the name specified</returns>
<remarks>
<para>
If the names logger exists it is returned, otherwise
<c>null</c> is returned.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers">
<summary>
Returns all the currently defined loggers as an Array.
</summary>
<returns>All the defined loggers</returns>
<remarks>
<para>
Returns all the currently defined loggers as an Array.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)">
<summary>
Returns a named logger instance
</summary>
<param name="name">The name of the logger to retrieve</param>
<returns>The logger object with the name specified</returns>
<remarks>
<para>
Returns a named logger instance.
</para>
<para>
If a logger of that name already exists, then it will be
returned. Otherwise, a new logger will be instantiated and
then linked with its existing ancestors as well as children.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.ILoggerRepository.Shutdown">
<summary>Shutdown the repository</summary>
<remarks>
<para>
Shutting down a repository will <i>safely</i> close and remove
all appenders in all loggers including the root logger.
</para>
<para>
Some appenders need to be closed before the
application exists. Otherwise, pending logging events might be
lost.
</para>
<para>
The <see cref="M:Shutdown()"/> method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration">
<summary>
Reset the repositories configuration to a default state
</summary>
<remarks>
<para>
Reset all values contained in this instance to their
default state.
</para>
<para>
Existing loggers are not removed. They are just reset.
</para>
<para>
This method should be used sparingly and with care as it will
block all logging until it is completed.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)">
<summary>
Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository.
</summary>
<param name="logEvent">the event to log</param>
<remarks>
<para>
This method should not normally be used to log.
The <see cref="T:log4net.ILog"/> interface should be used
for routine logging. This interface can be obtained
using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
</para>
<para>
The <c>logEvent</c> is delivered to the appropriate logger and
that logger is then responsible for logging the event.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.ILoggerRepository.GetAppenders">
<summary>
Returns all the Appenders that are configured as an Array.
</summary>
<returns>All the Appenders</returns>
<remarks>
<para>
Returns all the Appenders that are configured as an Array.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.ILoggerRepository.Name">
<summary>
The name of the repository
</summary>
<value>
The name of the repository
</value>
<remarks>
<para>
The name of the repository.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.ILoggerRepository.RendererMap">
<summary>
RendererMap accesses the object renderer map for this repository.
</summary>
<value>
RendererMap accesses the object renderer map for this repository.
</value>
<remarks>
<para>
RendererMap accesses the object renderer map for this repository.
</para>
<para>
The RendererMap holds a mapping between types and
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.ILoggerRepository.PluginMap">
<summary>
The plugin map for this repository.
</summary>
<value>
The plugin map for this repository.
</value>
<remarks>
<para>
The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
that have been attached to this repository.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.ILoggerRepository.LevelMap">
<summary>
Get the level map for the Repository.
</summary>
<remarks>
<para>
Get the level map for the Repository.
</para>
<para>
The level map defines the mappings between
level names and <see cref="T:log4net.Core.Level"/> objects in
this repository.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.ILoggerRepository.Threshold">
<summary>
The threshold for all events in this repository
</summary>
<value>
The threshold for all events in this repository
</value>
<remarks>
<para>
The threshold for all events in this repository.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.ILoggerRepository.Configured">
<summary>
Flag indicates if this repository has been configured.
</summary>
<value>
Flag indicates if this repository has been configured.
</value>
<remarks>
<para>
Flag indicates if this repository has been configured.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages">
<summary>
Collection of internal messages captured during the most
recent configuration process.
</summary>
</member>
<member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent">
<summary>
Event to notify that the repository has been shutdown.
</summary>
<value>
Event to notify that the repository has been shutdown.
</value>
<remarks>
<para>
Event raised when the repository has been shutdown.
</para>
</remarks>
</member>
<member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset">
<summary>
Event to notify that the repository has had its configuration reset.
</summary>
<value>
Event to notify that the repository has had its configuration reset.
</value>
<remarks>
<para>
Event raised when the repository's configuration has been
reset to default.
</para>
</remarks>
</member>
<member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged">
<summary>
Event to notify that the repository has had its configuration changed.
</summary>
<value>
Event to notify that the repository has had its configuration changed.
</value>
<remarks>
<para>
Event raised when the repository's configuration has been changed.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.ILoggerRepository.Properties">
<summary>
Repository specific properties
</summary>
<value>
Repository specific properties
</value>
<remarks>
<para>
These properties can be specified on a repository specific basis.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor">
<summary>
Default Constructor
</summary>
<remarks>
<para>
Initializes the repository with default (empty) properties.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)">
<summary>
Construct the repository using specific properties
</summary>
<param name="properties">the properties to set for this repository</param>
<remarks>
<para>
Initializes the repository with specified properties.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)">
<summary>
Test if logger exists
</summary>
<param name="name">The name of the logger to lookup</param>
<returns>The Logger object with the name specified</returns>
<remarks>
<para>
Check if the named logger exists in the repository. If so return
its reference, otherwise returns <c>null</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers">
<summary>
Returns all the currently defined loggers in the repository
</summary>
<returns>All the defined loggers</returns>
<remarks>
<para>
Returns all the currently defined loggers in the repository as an Array.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)">
<summary>
Return a new logger instance
</summary>
<param name="name">The name of the logger to retrieve</param>
<returns>The logger object with the name specified</returns>
<remarks>
<para>
Return a new logger instance.
</para>
<para>
If a logger of that name already exists, then it will be
returned. Otherwise, a new logger will be instantiated and
then linked with its existing ancestors as well as children.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown">
<summary>
Shutdown the repository
</summary>
<remarks>
<para>
Shutdown the repository. Can be overridden in a subclass.
This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/>
listeners and all attached plugins of the shutdown event.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration">
<summary>
Reset the repositories configuration to a default state
</summary>
<remarks>
<para>
Reset all values contained in this instance to their
default state.
</para>
<para>
Existing loggers are not removed. They are just reset.
</para>
<para>
This method should be used sparingly and with care as it will
block all logging until it is completed.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)">
<summary>
Log the logEvent through this repository.
</summary>
<param name="logEvent">the event to log</param>
<remarks>
<para>
This method should not normally be used to log.
The <see cref="T:log4net.ILog"/> interface should be used
for routine logging. This interface can be obtained
using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
</para>
<para>
The <c>logEvent</c> is delivered to the appropriate logger and
that logger is then responsible for logging the event.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders">
<summary>
Returns all the Appenders that are configured as an Array.
</summary>
<returns>All the Appenders</returns>
<remarks>
<para>
Returns all the Appenders that are configured as an Array.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType">
<summary>
The fully qualified type of the LoggerRepositorySkeleton class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
<summary>
Adds an object renderer for a specific class.
</summary>
<param name="typeToRender">The type that will be rendered by the renderer supplied.</param>
<param name="rendererInstance">The object renderer used to render the object.</param>
<remarks>
<para>
Adds an object renderer for a specific class.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)">
<summary>
Notify the registered listeners that the repository is shutting down
</summary>
<param name="e">Empty EventArgs</param>
<remarks>
<para>
Notify any listeners that this repository is shutting down.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)">
<summary>
Notify the registered listeners that the repository has had its configuration reset
</summary>
<param name="e">Empty EventArgs</param>
<remarks>
<para>
Notify any listeners that this repository's configuration has been reset.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)">
<summary>
Notify the registered listeners that the repository has had its configuration changed
</summary>
<param name="e">Empty EventArgs</param>
<remarks>
<para>
Notify any listeners that this repository's configuration has changed.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)">
<summary>
Raise a configuration changed event on this repository
</summary>
<param name="e">EventArgs.Empty</param>
<remarks>
<para>
Applications that programmatically change the configuration of the repository should
raise this event notification to notify listeners.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.LoggerRepositorySkeleton.Name">
<summary>
The name of the repository
</summary>
<value>
The string name of the repository
</value>
<remarks>
<para>
The name of this repository. The name is
used to store and lookup the repositories
stored by the <see cref="T:log4net.Core.IRepositorySelector"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold">
<summary>
The threshold for all events in this repository
</summary>
<value>
The threshold for all events in this repository
</value>
<remarks>
<para>
The threshold for all events in this repository
</para>
</remarks>
</member>
<member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap">
<summary>
RendererMap accesses the object renderer map for this repository.
</summary>
<value>
RendererMap accesses the object renderer map for this repository.
</value>
<remarks>
<para>
RendererMap accesses the object renderer map for this repository.
</para>
<para>
The RendererMap holds a mapping between types and
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap">
<summary>
The plugin map for this repository.
</summary>
<value>
The plugin map for this repository.
</value>
<remarks>
<para>
The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
that have been attached to this repository.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap">
<summary>
Get the level map for the Repository.
</summary>
<remarks>
<para>
Get the level map for the Repository.
</para>
<para>
The level map defines the mappings between
level names and <see cref="T:log4net.Core.Level"/> objects in
this repository.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured">
<summary>
Flag indicates if this repository has been configured.
</summary>
<value>
Flag indicates if this repository has been configured.
</value>
<remarks>
<para>
Flag indicates if this repository has been configured.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages">
<summary>
Contains a list of internal messages captures during the
last configuration.
</summary>
</member>
<member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent">
<summary>
Event to notify that the repository has been shutdown.
</summary>
<value>
Event to notify that the repository has been shutdown.
</value>
<remarks>
<para>
Event raised when the repository has been shutdown.
</para>
</remarks>
</member>
<member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset">
<summary>
Event to notify that the repository has had its configuration reset.
</summary>
<value>
Event to notify that the repository has had its configuration reset.
</value>
<remarks>
<para>
Event raised when the repository's configuration has been
reset to default.
</para>
</remarks>
</member>
<member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged">
<summary>
Event to notify that the repository has had its configuration changed.
</summary>
<value>
Event to notify that the repository has had its configuration changed.
</value>
<remarks>
<para>
Event raised when the repository's configuration has been changed.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties">
<summary>
Repository specific properties
</summary>
<value>
Repository specific properties
</value>
<remarks>
These properties can be specified on a repository specific basis
</remarks>
</member>
<member name="T:log4net.Repository.IBasicRepositoryConfigurator">
<summary>
Basic Configurator interface for repositories
</summary>
<remarks>
<para>
Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>
with a default <see cref="T:log4net.Appender.IAppender"/>.
</para>
<para>
A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)">
<summary>
Initialize the repository using the specified appender
</summary>
<param name="appender">the appender to use to log all logging events</param>
<remarks>
<para>
Configure the repository to route all logging events to the
specified appender.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])">
<summary>
Initialize the repository using the specified appenders
</summary>
<param name="appenders">the appenders to use to log all logging events</param>
<remarks>
<para>
Configure the repository to route all logging events to the
specified appenders.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.IXmlRepositoryConfigurator">
<summary>
Configure repository using XML
</summary>
<remarks>
<para>
Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>.
</para>
<para>
A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)">
<summary>
Initialize the repository using the specified config
</summary>
<param name="element">the element containing the root of the config</param>
<remarks>
<para>
The schema for the XML configuration data is defined by
the implementation.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)">
<summary>
Construct with properties
</summary>
<param name="properties">The properties to pass to this repository.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)">
<summary>
Construct with a logger factory
</summary>
<param name="loggerFactory">The factory to use to create new logger instances.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)">
<summary>
Construct with properties and a logger factory
</summary>
<param name="properties">The properties to pass to this repository.</param>
<param name="loggerFactory">The factory to use to create new logger instances.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)">
<summary>
Test if a logger exists
</summary>
<param name="name">The name of the logger to lookup</param>
<returns>The Logger object with the name specified</returns>
<remarks>
<para>
Check if the named logger exists in the hierarchy. If so return
its reference, otherwise returns <c>null</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers">
<summary>
Returns all the currently defined loggers in the hierarchy as an Array
</summary>
<returns>All the defined loggers</returns>
<remarks>
<para>
Returns all the currently defined loggers in the hierarchy as an Array.
The root logger is <b>not</b> included in the returned
enumeration.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)">
<summary>
Return a new logger instance named as the first parameter using
the default factory.
</summary>
<remarks>
<para>
Return a new logger instance named as the first parameter using
the default factory.
</para>
<para>
If a logger of that name already exists, then it will be
returned. Otherwise, a new logger will be instantiated and
then linked with its existing ancestors as well as children.
</para>
</remarks>
<param name="name">The name of the logger to retrieve</param>
<returns>The logger object with the name specified</returns>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown">
<summary>
Shutting down a hierarchy will <i>safely</i> close and remove
all appenders in all loggers including the root logger.
</summary>
<remarks>
<para>
Shutting down a hierarchy will <i>safely</i> close and remove
all appenders in all loggers including the root logger.
</para>
<para>
Some appenders need to be closed before the
application exists. Otherwise, pending logging events might be
lost.
</para>
<para>
The <c>Shutdown</c> method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration">
<summary>
Reset all values contained in this hierarchy instance to their default.
</summary>
<remarks>
<para>
Reset all values contained in this hierarchy instance to their
default. This removes all appenders from all loggers, sets
the level of all non-root loggers to <c>null</c>,
sets their additivity flag to <c>true</c> and sets the level
of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
message disabling is set its default "off" value.
</para>
<para>
Existing loggers are not removed. They are just reset.
</para>
<para>
This method should be used sparingly and with care as it will
block all logging until it is completed.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)">
<summary>
Log the logEvent through this hierarchy.
</summary>
<param name="logEvent">the event to log</param>
<remarks>
<para>
This method should not normally be used to log.
The <see cref="T:log4net.ILog"/> interface should be used
for routine logging. This interface can be obtained
using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
</para>
<para>
The <c>logEvent</c> is delivered to the appropriate logger and
that logger is then responsible for logging the event.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders">
<summary>
Returns all the Appenders that are currently configured
</summary>
<returns>An array containing all the currently configured appenders</returns>
<remarks>
<para>
Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured.
All the loggers are searched for appenders. The appenders may also be containers
for appenders and these are also searched for additional loggers.
</para>
<para>
The list returned is unordered but does not contain duplicates.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)">
<summary>
Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>.
The appender may also be a container.
</summary>
<param name="appenderList"></param>
<param name="appender"></param>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)">
<summary>
Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container
</summary>
<param name="appenderList"></param>
<param name="container"></param>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender)">
<summary>
Initialize the log4net system using the specified appender
</summary>
<param name="appender">the appender to use to log all logging events</param>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender[])">
<summary>
Initialize the log4net system using the specified appenders
</summary>
<param name="appenders">the appenders to use to log all logging events</param>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(log4net.Appender.IAppender[])">
<summary>
Initialize the log4net system using the specified appenders
</summary>
<param name="appenders">the appenders to use to log all logging events</param>
<remarks>
<para>
This method provides the same functionality as the
<see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
on this object, but it is protected and therefore can be called by subclasses.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(System.Xml.XmlElement)">
<summary>
Initialize the log4net system using the specified config
</summary>
<param name="element">the element containing the root of the config</param>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(System.Xml.XmlElement)">
<summary>
Initialize the log4net system using the specified config
</summary>
<param name="element">the element containing the root of the config</param>
<remarks>
<para>
This method provides the same functionality as the
<see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
on this object, but it is protected and therefore can be called by subclasses.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)">
<summary>
Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>.
</summary>
<param name="level">The level to check against.</param>
<returns>
<c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise.
</returns>
<remarks>
<para>
If this hierarchy has not been configured then this method will
always return <c>true</c>.
</para>
<para>
This method will return <c>true</c> if this repository is
disabled for <c>level</c> object passed as parameter and
<c>false</c> otherwise.
</para>
<para>
See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear">
<summary>
Clear all logger definitions from the internal hashtable
</summary>
<remarks>
<para>
This call will clear all logger definitions from the internal
hashtable. Invoking this method will irrevocably mess up the
logger hierarchy.
</para>
<para>
You should <b>really</b> know what you are doing before
invoking this method.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)">
<summary>
Return a new logger instance named as the first parameter using
<paramref name="factory"/>.
</summary>
<param name="name">The name of the logger to retrieve</param>
<param name="factory">The factory that will make the new logger instance</param>
<returns>The logger object with the name specified</returns>
<remarks>
<para>
If a logger of that name already exists, then it will be
returned. Otherwise, a new logger will be instantiated by the
<paramref name="factory"/> parameter and linked with its existing
ancestors as well as children.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)">
<summary>
Sends a logger creation event to all registered listeners
</summary>
<param name="logger">The newly created logger</param>
<remarks>
Raises the logger creation event.
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)">
<summary>
Updates all the parents of the specified logger
</summary>
<param name="log">The logger to update the parents for</param>
<remarks>
<para>
This method loops through all the <i>potential</i> parents of
<paramref name="log"/>. There 3 possible cases:
</para>
<list type="number">
<item>
<term>No entry for the potential parent of <paramref name="log"/> exists</term>
<description>
We create a ProvisionNode for this potential
parent and insert <paramref name="log"/> in that provision node.
</description>
</item>
<item>
<term>The entry is of type Logger for the potential parent.</term>
<description>
The entry is <paramref name="log"/>'s nearest existing parent. We
update <paramref name="log"/>'s parent field with this entry. We also break from
he loop because updating our parent's parent is our parent's
responsibility.
</description>
</item>
<item>
<term>The entry is of type ProvisionNode for this potential parent.</term>
<description>
We add <paramref name="log"/> to the list of children for this
potential parent.
</description>
</item>
</list>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)">
<summary>
Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy.
</summary>
<param name="pn"></param>
<param name="log"></param>
<remarks>
<para>
We update the links for all the children that placed themselves
in the provision node 'pn'. The second argument 'log' is a
reference for the newly created Logger, parent of all the
children in 'pn'.
</para>
<para>
We loop on all the children 'c' in 'pn'.
</para>
<para>
If the child 'c' has been already linked to a child of
'log' then there is no need to update 'c'.
</para>
<para>
Otherwise, we set log's parent field to c's parent and set
c's parent field to log.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)">
<summary>
Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
</summary>
<param name="levelEntry">the level values</param>
<remarks>
<para>
Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
</para>
<para>
Supports setting levels via the configuration file.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)">
<summary>
Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
</summary>
<param name="propertyEntry">the property value</param>
<remarks>
<para>
Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
</para>
<para>
Supports setting property values via the configuration file.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType">
<summary>
The fully qualified type of the Hierarchy class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
<summary>
Event used to notify that a logger has been created.
</summary>
<remarks>
<para>
Event raised when a logger is created.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning">
<summary>
Has no appender warning been emitted
</summary>
<remarks>
<para>
Flag to indicate if we have already issued a warning
about not having an appender warning.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Hierarchy.Root">
<summary>
Get the root of this hierarchy
</summary>
<remarks>
<para>
Get the root of this hierarchy.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory">
<summary>
Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> instance.
</summary>
<value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/></value>
<remarks>
<para>
The logger factory is used to create logger instances.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
<summary>
A class to hold the value, name and display name for a level
</summary>
<remarks>
<para>
A class to hold the value, name and display name for a level
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString">
<summary>
Override <c>Object.ToString</c> to return sensible debug info
</summary>
<returns>string info about this object</returns>
</member>
<member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value">
<summary>
Value of the level
</summary>
<remarks>
<para>
If the value is not set (defaults to -1) the value will be looked
up for the current level with the same name.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name">
<summary>
Name of the level
</summary>
<value>
The name of the level
</value>
<remarks>
<para>
The name of the level.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName">
<summary>
Display name for the level
</summary>
<value>
The display name of the level
</value>
<remarks>
<para>
The display name of the level.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.LoggerKey">
<summary>
Used internally to accelerate hash table searches.
</summary>
<remarks>
<para>
Internal class used to improve performance of
string keyed hashtables.
</para>
<para>
The hashcode of the string is cached for reuse.
The string is stored as an interned value.
When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality
the reference equality of the interned strings is compared.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)">
<summary>
Construct key with string name
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> class
with the specified name.
</para>
<para>
Stores the hashcode of the string and interns
the string key to optimize comparisons.
</para>
<note>
The Compact Framework 1.0 the <see cref="M:System.String.Intern(System.String)"/>
method does not work. On the Compact Framework
the string keys are not interned nor are they
compared by reference.
</note>
</remarks>
<param name="name">The name of the logger.</param>
</member>
<member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode">
<summary>
Returns a hash code for the current instance.
</summary>
<returns>A hash code for the current instance.</returns>
<remarks>
<para>
Returns the cached hashcode.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)">
<summary>
Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> instances
are equal.
</summary>
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>.</param>
<returns>
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>; otherwise, <c>false</c>.
</returns>
<remarks>
<para>
Compares the references of the interned strings.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.ProvisionNode">
<summary>
Provision nodes are used where no logger instance has been specified
</summary>
<remarks>
<para>
<see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the
<see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> when there is no specified
<see cref="T:log4net.Repository.Hierarchy.Logger"/> for that node.
</para>
<para>
A provision node holds a list of child loggers on behalf of
a logger that does not exist.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)">
<summary>
Create a new provision node with child node
</summary>
<param name="log">A child logger to add to this node.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> class
with the specified child logger.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.RootLogger">
<summary>
The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> sits at the root of the logger hierarchy tree.
</summary>
<remarks>
<para>
The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger"/> except
that it provides several guarantees.
</para>
<para>
First, it cannot be assigned a <c>null</c>
level. Second, since the root logger cannot have a parent, the
<see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the
level field without walking the hierarchy.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)">
<summary>
Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/>
</summary>
<param name="level">The level to assign to the root logger.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> class with
the specified logging level.
</para>
<para>
The root logger names itself as "root". However, the root
logger cannot be retrieved by name.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType">
<summary>
The fully qualified type of the RootLogger class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel">
<summary>
Gets the assigned level value without walking the logger hierarchy.
</summary>
<value>The assigned level value without walking the logger hierarchy.</value>
<remarks>
<para>
Because the root logger cannot have a parent and its level
must not be <c>null</c> this property just returns the
value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Repository.Hierarchy.RootLogger.Level">
<summary>
Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger.
</summary>
<value>
The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger.
</value>
<remarks>
<para>
Setting the level of the root logger to a <c>null</c> reference
may have catastrophic results. We prevent this here.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator">
<summary>
Initializes the log4net environment using an XML DOM.
</summary>
<remarks>
<para>
Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)">
<summary>
Construct the configurator for a hierarchy
</summary>
<param name="hierarchy">The hierarchy to build.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator"/> class
with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)">
<summary>
Configure the hierarchy by parsing a DOM tree of XML elements.
</summary>
<param name="element">The root element to parse.</param>
<remarks>
<para>
Configure the hierarchy by parsing a DOM tree of XML elements.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)">
<summary>
Parse appenders by IDREF.
</summary>
<param name="appenderRef">The appender ref element.</param>
<returns>The instance of the appender that the ref refers to.</returns>
<remarks>
<para>
Parse an XML element that represents an appender and return
the appender.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)">
<summary>
Parses an appender element.
</summary>
<param name="appenderElement">The appender element.</param>
<returns>The appender instance or <c>null</c> when parsing failed.</returns>
<remarks>
<para>
Parse an XML element that represents an appender and return
the appender instance.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)">
<summary>
Parses a logger element.
</summary>
<param name="loggerElement">The logger element.</param>
<remarks>
<para>
Parse an XML element that represents a logger.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)">
<summary>
Parses the root logger element.
</summary>
<param name="rootElement">The root element.</param>
<remarks>
<para>
Parse an XML element that represents the root logger.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
<summary>
Parses the children of a logger element.
</summary>
<param name="catElement">The category element.</param>
<param name="log">The logger instance.</param>
<param name="isRoot">Flag to indicate if the logger is the root logger.</param>
<remarks>
<para>
Parse the child elements of a <logger> element.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)">
<summary>
Parses an object renderer.
</summary>
<param name="element">The renderer element.</param>
<remarks>
<para>
Parse an XML element that represents a renderer.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
<summary>
Parses a level element.
</summary>
<param name="element">The level element.</param>
<param name="log">The logger object to set the level on.</param>
<param name="isRoot">Flag to indicate if the logger is the root logger.</param>
<remarks>
<para>
Parse an XML element that represents a level.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)">
<summary>
Sets a parameter on an object.
</summary>
<param name="element">The parameter element.</param>
<param name="target">The object to set the parameter on.</param>
<remarks>
The parameter name must correspond to a writable property
on the object. The value of the parameter is a string,
therefore this function will attempt to set a string
property first. If unable to set a string property it
will inspect the property and its argument type. It will
attempt to call a static method called <c>Parse</c> on the
type of the property. This method will take a single
string argument and return a value that can be used to
set the property.
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
<summary>
Test if an element has no attributes or child elements
</summary>
<param name="element">the element to inspect</param>
<returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
<summary>
Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
</summary>
<param name="type">the type to inspect</param>
<returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
<summary>
Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
</summary>
<param name="targetType">the type that has the method</param>
<param name="name">the name of the method</param>
<returns>the method info found</returns>
<remarks>
<para>
The method must be a public instance method on the <paramref name="targetType"/>.
The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>.
The method must take a single parameter.
</para>
</remarks>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)">
<summary>
Converts a string value to a target type.
</summary>
<param name="type">The type of object to convert the string to.</param>
<param name="value">The string value to use as the value of the object.</param>
<returns>
<para>
An object of type <paramref name="type"/> with value <paramref name="value"/> or
<c>null</c> when the conversion could not be performed.
</para>
</returns>
</member>
<member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)">
<summary>
Creates an object as specified in XML.
</summary>
<param name="element">The XML element that contains the definition of the object.</param>
<param name="defaultTargetType">The object type to use if not explicitly specified.</param>
<param name="typeConstraint">The type that the returned object must be or must inherit from.</param>
<returns>The object or <c>null</c></returns>
<remarks>
<para>
Parse an XML element and create an object instance based on the configuration
data.
</para>
<para>
The type of the instance may be specified in the XML. If not
specified then the <paramref name="defaultTargetType"/> is used
as the type. However the type is specified it must support the
<paramref name="typeConstraint"/> type.
</para>
</remarks>
</member>
<member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag">
<summary>
key: appenderName, value: appender.
</summary>
</member>
<member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy">
<summary>
The Hierarchy being configured.
</summary>
</member>
<member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType">
<summary>
The fully qualified type of the XmlHierarchyConfigurator class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Repository.ConfigurationChangedEventArgs">
<summary>
</summary>
</member>
<member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)">
<summary>
</summary>
<param name="configurationMessages"></param>
</member>
<member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages">
<summary>
</summary>
</member>
<member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler">
<summary>
Delegate used to handle logger repository shutdown event notifications
</summary>
<param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param>
<param name="e">Empty event args</param>
<remarks>
<para>
Delegate used to handle logger repository shutdown event notifications.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler">
<summary>
Delegate used to handle logger repository configuration reset event notifications
</summary>
<param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param>
<param name="e">Empty event args</param>
<remarks>
<para>
Delegate used to handle logger repository configuration reset event notifications.
</para>
</remarks>
</member>
<member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler">
<summary>
Delegate used to handle event notifications for logger repository configuration changes.
</summary>
<param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param>
<param name="e">Empty event arguments.</param>
<remarks>
<para>
Delegate used to handle event notifications for logger repository configuration changes.
</para>
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter">
<summary>
Write the name of the current AppDomain to the output
</summary>
<remarks>
<para>
Write the name of the current AppDomain to the output writer
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write the name of the current AppDomain to the output
</summary>
<param name="writer">the writer to write to</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Writes name of the current AppDomain to the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.DatePatternConverter">
<summary>
Write the current date to the output
</summary>
<remarks>
<para>
Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
the current date and time to the writer as a string.
</para>
<para>
The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
the formatting of the date. The following values are allowed:
<list type="definition">
<listheader>
<term>Option value</term>
<description>Output</description>
</listheader>
<item>
<term>ISO8601</term>
<description>
Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
</description>
</item>
<item>
<term>DATE</term>
<description>
Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
</description>
</item>
<item>
<term>ABSOLUTE</term>
<description>
Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
</description>
</item>
<item>
<term>other</term>
<description>
Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
<see cref="M:DateTime.ToString(string)"/> method.
For details on valid patterns see
<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
</description>
</item>
</list>
</para>
<para>
The date and time is in the local time zone and is rendered in that zone.
To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter">
<summary>
The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
</summary>
<remarks>
<para>
The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions">
<summary>
Initialize the converter options
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write the current date to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
for it to render it to the writer.
</para>
<para>
The date and time passed is in the local time zone.
</para>
</remarks>
</member>
<member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType">
<summary>
The fully qualified type of the DatePatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter">
<summary>
Write an <see cref="T:System.Environment.SpecialFolder"/> folder path to the output
</summary>
<remarks>
<para>
Write an special path environment folder path to the output writer.
The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
the name of the variable to output. <see cref="P:log4net.Util.PatternConverter.Option"/>
should be a value in the <see cref="T:System.Environment.SpecialFolder"/> enumeration.
</para>
</remarks>
<author>Ron Grabowski</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write an special path environment folder path to the output
</summary>
<param name="writer">the writer to write to</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Writes the special path environment folder path to the output <paramref name="writer"/>.
The name of the special path environment folder path to output must be set
using the <see cref="P:log4net.Util.PatternConverter.Option"/>
property.
</para>
</remarks>
</member>
<member name="F:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.declaringType">
<summary>
The fully qualified type of the EnvironmentFolderPathPatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter">
<summary>
Write an environment variable to the output
</summary>
<remarks>
<para>
Write an environment variable to the output writer.
The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
the name of the variable to output.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write an environment variable to the output
</summary>
<param name="writer">the writer to write to</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Writes the environment variable to the output <paramref name="writer"/>.
The name of the environment variable to output must be set
using the <see cref="P:log4net.Util.PatternConverter.Option"/>
property.
</para>
</remarks>
</member>
<member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType">
<summary>
The fully qualified type of the EnvironmentPatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter">
<summary>
Write the current thread identity to the output
</summary>
<remarks>
<para>
Write the current thread identity to the output writer
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write the current thread identity to the output
</summary>
<param name="writer">the writer to write to</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Writes the current thread identity to the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType">
<summary>
The fully qualified type of the IdentityPatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter">
<summary>
Pattern converter for literal string instances in the pattern
</summary>
<remarks>
<para>
Writes the literal string value specified in the
<see cref="P:log4net.Util.PatternConverter.Option"/> property to
the output.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)">
<summary>
Set the next converter in the chain
</summary>
<param name="pc">The next pattern converter in the chain</param>
<returns>The next pattern converter</returns>
<remarks>
<para>
Special case the building of the pattern converter chain
for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent
literals in the pattern can be represented by a single combined
pattern converter. This implementation detects when a
<see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain
after this converter and combines its value with this converter's
literal value.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)">
<summary>
Write the literal to the output
</summary>
<param name="writer">the writer to write to</param>
<param name="state">null, not set</param>
<remarks>
<para>
Override the formatting behavior to ignore the FormattingInfo
because we have a literal instead.
</para>
<para>
Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/>
to the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Convert this pattern into the rendered message
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="state">null, not set</param>
<remarks>
<para>
This method is not used.
</para>
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter">
<summary>
Writes a newline to the output
</summary>
<remarks>
<para>
Writes the system dependent line terminator to the output.
This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>:
</para>
<list type="definition">
<listheader>
<term>Option Value</term>
<description>Output</description>
</listheader>
<item>
<term>DOS</term>
<description>DOS or Windows line terminator <c>"\r\n"</c></description>
</item>
<item>
<term>UNIX</term>
<description>UNIX line terminator <c>"\n"</c></description>
</item>
</list>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions">
<summary>
Initialize the converter
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter">
<summary>
Write the current process ID to the output
</summary>
<remarks>
<para>
Write the current process ID to the output writer
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write the current process ID to the output
</summary>
<param name="writer">the writer to write to</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Write the current process ID to the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType">
<summary>
The fully qualified type of the ProcessIdPatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter">
<summary>
Property pattern converter
</summary>
<remarks>
<para>
This pattern converter reads the thread and global properties.
The thread properties take priority over global properties.
See <see cref="P:log4net.ThreadContext.Properties"/> for details of the
thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for
details of the global properties.
</para>
<para>
If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
then all properties will be dumped as a list of key value pairs.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write the property value to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Writes out the value of a named property. The property name
should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
property.
</para>
<para>
If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
then all the properties are written as key value pairs.
</para>
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter">
<summary>
A Pattern converter that generates a string of random characters
</summary>
<remarks>
<para>
The converter generates a string of random characters. By default
the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>
to the string value of the length required.
</para>
<para>
The random characters in the string are limited to uppercase letters
and numbers only.
</para>
<para>
The random number generator used by this class is not cryptographically secure.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random">
<summary>
Shared random number generator
</summary>
</member>
<member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length">
<summary>
Length of random string to generate. Default length 4.
</summary>
</member>
<member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions">
<summary>
Initialize the converter options
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write a randoim string to the output
</summary>
<param name="writer">the writer to write to</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Write a randoim string to the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType">
<summary>
The fully qualified type of the RandomStringPatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter">
<summary>
Write the current threads username to the output
</summary>
<remarks>
<para>
Write the current threads username to the output writer
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write the current threads username to the output
</summary>
<param name="writer">the writer to write to</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Write the current threads username to the output <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType">
<summary>
The fully qualified type of the UserNamePatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter">
<summary>
Write the UTC date time to the output
</summary>
<remarks>
<para>
Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
the current date and time in Universal time.
</para>
<para>
See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax.
</para>
</remarks>
<seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
<summary>
Write the current date and time to the output
</summary>
<param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
<param name="state">null, state is not set</param>
<remarks>
<para>
Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
for it to render it to the writer.
</para>
<para>
The date is in Universal time when it is rendered.
</para>
</remarks>
<seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
</member>
<member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType">
<summary>
The fully qualified type of the UtcDatePatternConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.TypeConverters.BooleanConverter">
<summary>
Type converter for Boolean.
</summary>
<remarks>
<para>
Supports conversion from string to <c>bool</c> type.
</para>
</remarks>
<seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)">
<summary>
Can the source type be converted to the type supported by this object
</summary>
<param name="sourceType">the type to convert</param>
<returns>true if the conversion is possible</returns>
<remarks>
<para>
Returns <c>true</c> if the <paramref name="sourceType"/> is
the <see cref="T:System.String"/> type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)">
<summary>
Convert the source object to the type supported by this object
</summary>
<param name="source">the object to convert</param>
<returns>the converted object</returns>
<remarks>
<para>
Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the
<see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>.
</para>
</remarks>
<exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
The <paramref name="source"/> object cannot be converted to the
target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/>
method.
</exception>
</member>
<member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
<summary>
Exception base type for conversion errors.
</summary>
<remarks>
<para>
This type extends <see cref="T:System.ApplicationException"/>. It
does not add any new functionality but does differentiate the
type of exception being thrown.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="message">A message to include with the exception.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
with the specified message.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)">
<summary>
Constructor
</summary>
<param name="message">A message to include with the exception.</param>
<param name="innerException">A nested exception to include.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
with the specified message and inner exception.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Serialization constructor
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
with serialized data.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)">
<summary>
Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
</summary>
<param name="destinationType">The conversion destination type.</param>
<param name="sourceValue">The value to convert.</param>
<returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
<remarks>
<para>
Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)">
<summary>
Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
</summary>
<param name="destinationType">The conversion destination type.</param>
<param name="sourceValue">The value to convert.</param>
<param name="innerException">A nested exception to include.</param>
<returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
<remarks>
<para>
Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
</para>
</remarks>
</member>
<member name="T:log4net.Util.TypeConverters.ConverterRegistry">
<summary>
Register of type converters for specific types.
</summary>
<remarks>
<para>
Maintains a registry of type converters used to convert between
types.
</para>
<para>
Use the <see cref="M:AddConverter(Type, object)"/> and
<see cref="M:AddConverter(Type, Type)"/> methods to register new converters.
The <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)"/> and <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)"/> methods
lookup appropriate converters to use.
</para>
</remarks>
<seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor">
<summary>
Private constructor
</summary>
<remarks>
Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> class.
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor">
<summary>
Static constructor.
</summary>
<remarks>
<para>
This constructor defines the intrinsic type converters.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)">
<summary>
Adds a converter for a specific type.
</summary>
<param name="destinationType">The type being converted to.</param>
<param name="converter">The type converter to use to convert to the destination type.</param>
<remarks>
<para>
Adds a converter instance for a specific type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)">
<summary>
Adds a converter for a specific type.
</summary>
<param name="destinationType">The type being converted to.</param>
<param name="converterType">The type of the type converter to use to convert to the destination type.</param>
<remarks>
<para>
Adds a converter <see cref="T:System.Type"/> for a specific type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)">
<summary>
Gets the type converter to use to convert values to the destination type.
</summary>
<param name="sourceType">The type being converted from.</param>
<param name="destinationType">The type being converted to.</param>
<returns>
The type converter instance to use for type conversions or <c>null</c>
if no type converter is found.
</returns>
<remarks>
<para>
Gets the type converter to use to convert values to the destination type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)">
<summary>
Gets the type converter to use to convert values to the destination type.
</summary>
<param name="destinationType">The type being converted to.</param>
<returns>
The type converter instance to use for type conversions or <c>null</c>
if no type converter is found.
</returns>
<remarks>
<para>
Gets the type converter to use to convert values to the destination type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)">
<summary>
Lookups the type converter to use as specified by the attributes on the
destination type.
</summary>
<param name="destinationType">The type being converted to.</param>
<returns>
The type converter instance to use for type conversions or <c>null</c>
if no type converter is found.
</returns>
</member>
<member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)">
<summary>
Creates the instance of the type converter.
</summary>
<param name="converterType">The type of the type converter.</param>
<returns>
The type converter instance to use for type conversions or <c>null</c>
if no type converter is found.
</returns>
<remarks>
<para>
The type specified for the type converter must implement
the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces
and must have a public default (no argument) constructor.
</para>
</remarks>
</member>
<member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType">
<summary>
The fully qualified type of the ConverterRegistry class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter">
<summary>
Mapping from <see cref="T:System.Type"/> to type converter.
</summary>
</member>
<member name="T:log4net.Util.TypeConverters.EncodingConverter">
<summary>
Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
</summary>
<remarks>
<para>
Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
</para>
</remarks>
<seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)">
<summary>
Can the source type be converted to the type supported by this object
</summary>
<param name="sourceType">the type to convert</param>
<returns>true if the conversion is possible</returns>
<remarks>
<para>
Returns <c>true</c> if the <paramref name="sourceType"/> is
the <see cref="T:System.String"/> type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)">
<summary>
Overrides the ConvertFrom method of IConvertFrom.
</summary>
<param name="source">the object to convert to an encoding</param>
<returns>the encoding</returns>
<remarks>
<para>
Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to
convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
</para>
</remarks>
<exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
The <paramref name="source"/> object cannot be converted to the
target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/>
method.
</exception>
</member>
<member name="T:log4net.Util.TypeConverters.IConvertTo">
<summary>
Interface supported by type converters
</summary>
<remarks>
<para>
This interface supports conversion from a single type to arbitrary types.
See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)">
<summary>
Returns whether this converter can convert the object to the specified type
</summary>
<param name="targetType">A Type that represents the type you want to convert to</param>
<returns>true if the conversion is possible</returns>
<remarks>
<para>
Test if the type supported by this converter can be converted to the
<paramref name="targetType"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)">
<summary>
Converts the given value object to the specified type, using the arguments
</summary>
<param name="source">the object to convert</param>
<param name="targetType">The Type to convert the value parameter to</param>
<returns>the converted object</returns>
<remarks>
<para>
Converts the <paramref name="source"/> (which must be of the type supported
by this converter) to the <paramref name="targetType"/> specified..
</para>
</remarks>
</member>
<member name="T:log4net.Util.TypeConverters.IPAddressConverter">
<summary>
Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
</summary>
<remarks>
<para>
Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
</para>
</remarks>
<seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)">
<summary>
Can the source type be converted to the type supported by this object
</summary>
<param name="sourceType">the type to convert</param>
<returns>true if the conversion is possible</returns>
<remarks>
<para>
Returns <c>true</c> if the <paramref name="sourceType"/> is
the <see cref="T:System.String"/> type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)">
<summary>
Overrides the ConvertFrom method of IConvertFrom.
</summary>
<param name="source">the object to convert to an IPAddress</param>
<returns>the IPAddress</returns>
<remarks>
<para>
Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the
<see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>.
If that fails then the string is resolved as a DNS hostname.
</para>
</remarks>
<exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
The <paramref name="source"/> object cannot be converted to the
target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/>
method.
</exception>
</member>
<member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars">
<summary>
Valid characters in an IPv4 or IPv6 address string. (Does not support subnets)
</summary>
</member>
<member name="T:log4net.Util.TypeConverters.PatternLayoutConverter">
<summary>
Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
</summary>
<remarks>
<para>
Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
</para>
<para>
The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>
of the <see cref="T:log4net.Layout.PatternLayout"/>.
</para>
</remarks>
<seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)">
<summary>
Can the source type be converted to the type supported by this object
</summary>
<param name="sourceType">the type to convert</param>
<returns>true if the conversion is possible</returns>
<remarks>
<para>
Returns <c>true</c> if the <paramref name="sourceType"/> is
the <see cref="T:System.String"/> type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)">
<summary>
Overrides the ConvertFrom method of IConvertFrom.
</summary>
<param name="source">the object to convert to a PatternLayout</param>
<returns>the PatternLayout</returns>
<remarks>
<para>
Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using
the <paramref name="source"/> <see cref="T:System.String"/> as the
<see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>.
</para>
</remarks>
<exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
The <paramref name="source"/> object cannot be converted to the
target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/>
method.
</exception>
</member>
<member name="T:log4net.Util.TypeConverters.PatternStringConverter">
<summary>
Convert between string and <see cref="T:log4net.Util.PatternString"/>
</summary>
<remarks>
<para>
Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type,
and from a <see cref="T:log4net.Util.PatternString"/> type to a string.
</para>
<para>
The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/>
of the <see cref="T:log4net.Util.PatternString"/>.
</para>
</remarks>
<seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)">
<summary>
Can the target type be converted to the type supported by this object
</summary>
<param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param>
<returns>true if the conversion is possible</returns>
<remarks>
<para>
Returns <c>true</c> if the <paramref name="targetType"/> is
assignable from a <see cref="T:System.String"/> type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)">
<summary>
Converts the given value object to the specified type, using the arguments
</summary>
<param name="source">the object to convert</param>
<param name="targetType">The Type to convert the value parameter to</param>
<returns>the converted object</returns>
<remarks>
<para>
Uses the <see cref="M:PatternString.Format()"/> method to convert the
<see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
</para>
</remarks>
<exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
The <paramref name="source"/> object cannot be converted to the
<paramref name="targetType"/>. To check for this condition use the
<see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method.
</exception>
</member>
<member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)">
<summary>
Can the source type be converted to the type supported by this object
</summary>
<param name="sourceType">the type to convert</param>
<returns>true if the conversion is possible</returns>
<remarks>
<para>
Returns <c>true</c> if the <paramref name="sourceType"/> is
the <see cref="T:System.String"/> type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)">
<summary>
Overrides the ConvertFrom method of IConvertFrom.
</summary>
<param name="source">the object to convert to a PatternString</param>
<returns>the PatternString</returns>
<remarks>
<para>
Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using
the <paramref name="source"/> <see cref="T:System.String"/> as the
<see cref="P:log4net.Util.PatternString.ConversionPattern"/>.
</para>
</remarks>
<exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
The <paramref name="source"/> object cannot be converted to the
target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/>
method.
</exception>
</member>
<member name="T:log4net.Util.TypeConverters.TypeConverter">
<summary>
Supports conversion from string to <see cref="T:System.Type"/> type.
</summary>
<remarks>
<para>
Supports conversion from string to <see cref="T:System.Type"/> type.
</para>
</remarks>
<seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
<seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)">
<summary>
Can the source type be converted to the type supported by this object
</summary>
<param name="sourceType">the type to convert</param>
<returns>true if the conversion is possible</returns>
<remarks>
<para>
Returns <c>true</c> if the <paramref name="sourceType"/> is
the <see cref="T:System.String"/> type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)">
<summary>
Overrides the ConvertFrom method of IConvertFrom.
</summary>
<param name="source">the object to convert to a Type</param>
<returns>the Type</returns>
<remarks>
<para>
Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the
<see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
Additional effort is made to locate partially specified types
by searching the loaded assemblies.
</para>
</remarks>
<exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
The <paramref name="source"/> object cannot be converted to the
target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/>
method.
</exception>
</member>
<member name="T:log4net.Util.TypeConverters.TypeConverterAttribute">
<summary>
Attribute used to associate a type converter
</summary>
<remarks>
<para>
Class and Interface level attribute that specifies a type converter
to use with the associated type.
</para>
<para>
To associate a type converter with a target type apply a
<c>TypeConverterAttribute</c> to the target type. Specify the
type of the type converter on the attribute.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName">
<summary>
The string type name of the type converter
</summary>
</member>
<member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Default constructor
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)">
<summary>
Create a new type converter attribute for the specified type name
</summary>
<param name="typeName">The string type name of the type converter</param>
<remarks>
<para>
The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)">
<summary>
Create a new type converter attribute for the specified type
</summary>
<param name="converterType">The type of the type converter</param>
<remarks>
<para>
The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
</para>
</remarks>
</member>
<member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName">
<summary>
The string type name of the type converter
</summary>
<value>
The string type name of the type converter
</value>
<remarks>
<para>
The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
</para>
</remarks>
</member>
<member name="T:log4net.Util.AppenderAttachedImpl">
<summary>
A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
</summary>
<remarks>
<para>
This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/>
interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
should aggregate an instance of this type.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.AppenderAttachedImpl.#ctor">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)">
<summary>
Append on on all attached appenders.
</summary>
<param name="loggingEvent">The event being logged.</param>
<returns>The number of appenders called.</returns>
<remarks>
<para>
Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
attached appenders.
</para>
</remarks>
</member>
<member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
<summary>
Append on on all attached appenders.
</summary>
<param name="loggingEvents">The array of events being logged.</param>
<returns>The number of appenders called.</returns>
<remarks>
<para>
Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
attached appenders.
</para>
</remarks>
</member>
<member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
<summary>
Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
</summary>
<param name="appender">The appender</param>
<param name="loggingEvents">The events</param>
<remarks>
<para>
If the <paramref name="appender"/> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
interface then the <paramref name="loggingEvents"/> will be passed
through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
objects in the array will be passed one at a time.
</para>
</remarks>
</member>
<member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
<summary>
Attaches an appender.
</summary>
<param name="newAppender">The appender to add.</param>
<remarks>
<para>
If the appender is already in the list it won't be added again.
</para>
</remarks>
</member>
<member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)">
<summary>
Gets an attached appender with the specified name.
</summary>
<param name="name">The name of the appender to get.</param>
<returns>
The appender with the name specified, or <c>null</c> if no appender with the
specified name is found.
</returns>
<remarks>
<para>
Lookup an attached appender by name.
</para>
</remarks>
</member>
<member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders">
<summary>
Removes all attached appenders.
</summary>
<remarks>
<para>
Removes and closes all attached appenders
</para>
</remarks>
</member>
<member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)">
<summary>
Removes the specified appender from the list of attached appenders.
</summary>
<param name="appender">The appender to remove.</param>
<returns>The appender removed from the list</returns>
<remarks>
<para>
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</para>
</remarks>
</member>
<member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)">
<summary>
Removes the appender with the specified name from the list of appenders.
</summary>
<param name="name">The name of the appender to remove.</param>
<returns>The appender removed from the list</returns>
<remarks>
<para>
The appender removed is not closed.
If you are discarding the appender you must call
<see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
</para>
</remarks>
</member>
<member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList">
<summary>
List of appenders
</summary>
</member>
<member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray">
<summary>
Array of appenders, used to cache the m_appenderList
</summary>
</member>
<member name="F:log4net.Util.AppenderAttachedImpl.declaringType">
<summary>
The fully qualified type of the AppenderAttachedImpl class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Util.AppenderAttachedImpl.Appenders">
<summary>
Gets all attached appenders.
</summary>
<returns>
A collection of attached appenders, or <c>null</c> if there
are no attached appenders.
</returns>
<remarks>
<para>
The read only collection of all currently attached appenders.
</para>
</remarks>
</member>
<member name="T:log4net.Util.CompositeProperties">
<summary>
This class aggregates several PropertiesDictionary collections together.
</summary>
<remarks>
<para>
Provides a dictionary style lookup over an ordered list of
<see cref="T:log4net.Util.PropertiesDictionary"/> collections.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.CompositeProperties.#ctor">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)">
<summary>
Add a Properties Dictionary to this composite collection
</summary>
<param name="properties">the properties to add</param>
<remarks>
<para>
Properties dictionaries added first take precedence over dictionaries added
later.
</para>
</remarks>
</member>
<member name="M:log4net.Util.CompositeProperties.Flatten">
<summary>
Flatten this composite collection into a single properties dictionary
</summary>
<returns>the flattened dictionary</returns>
<remarks>
<para>
Reduces the collection of ordered dictionaries to a single dictionary
containing the resultant values for the keys.
</para>
</remarks>
</member>
<member name="P:log4net.Util.CompositeProperties.Item(System.String)">
<summary>
Gets the value of a property
</summary>
<value>
The value for the property with the specified key
</value>
<remarks>
<para>
Looks up the value for the <paramref name="key"/> specified.
The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched
in the order in which they were added to this collection. The value
returned is the value held by the first collection that contains
the specified key.
</para>
<para>
If none of the collections contain the specified key then
<c>null</c> is returned.
</para>
</remarks>
</member>
<member name="T:log4net.Util.ContextPropertiesBase">
<summary>
Base class for Context Properties implementations
</summary>
<remarks>
<para>
This class defines a basic property get set accessor
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)">
<summary>
Gets or sets the value of a property
</summary>
<value>
The value for the property with the specified key
</value>
<remarks>
<para>
Gets or sets the value of a property
</para>
</remarks>
</member>
<member name="T:log4net.Util.ConverterInfo">
<summary>
Wrapper class used to map converter names to converter types
</summary>
<remarks>
<para>
Pattern converter info class used during configuration by custom
PatternString and PatternLayer converters.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ConverterInfo.#ctor">
<summary>
default constructor
</summary>
</member>
<member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)">
<summary>
</summary>
<param name="entry"></param>
</member>
<member name="P:log4net.Util.ConverterInfo.Name">
<summary>
Gets or sets the name of the conversion pattern
</summary>
<remarks>
<para>
The name of the pattern in the format string
</para>
</remarks>
</member>
<member name="P:log4net.Util.ConverterInfo.Type">
<summary>
Gets or sets the type of the converter
</summary>
<remarks>
<para>
The value specified must extend the
<see cref="T:log4net.Util.PatternConverter"/> type.
</para>
</remarks>
</member>
<member name="P:log4net.Util.ConverterInfo.Properties">
<summary>
</summary>
</member>
<member name="T:log4net.Util.CountingQuietTextWriter">
<summary>
Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of
the number of bytes written.
</summary>
<remarks>
<para>
This writer counts the number of bytes written.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Util.QuietTextWriter">
<summary>
<see cref="T:System.IO.TextWriter"/> that does not leak exceptions
</summary>
<remarks>
<para>
<see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong.
Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Util.TextWriterAdapter">
<summary>
Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
messages to an instance of <see cref="T:System.IO.TextWriter"/>.
</summary>
<remarks>
<para>
Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
messages to an instance of <see cref="T:System.IO.TextWriter"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Util.TextWriterAdapter.m_writer">
<summary>
The writer to forward messages to
</summary>
</member>
<member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)">
<summary>
Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
messages to a <see cref="T:System.IO.TextWriter"/>.
</summary>
<param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param>
<remarks>
<para>
Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
messages to a <see cref="T:System.IO.TextWriter"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Util.TextWriterAdapter.Close">
<summary>
Closes the writer and releases any system resources associated with the writer
</summary>
<remarks>
<para>
</para>
</remarks>
</member>
<member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)">
<summary>
Dispose this writer
</summary>
<param name="disposing">flag indicating if we are being disposed</param>
<remarks>
<para>
Dispose this writer
</para>
</remarks>
</member>
<member name="M:log4net.Util.TextWriterAdapter.Flush">
<summary>
Flushes any buffered output
</summary>
<remarks>
<para>
Clears all buffers for the writer and causes any buffered data to be written
to the underlying device
</para>
</remarks>
</member>
<member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)">
<summary>
Writes a character to the wrapped TextWriter
</summary>
<param name="value">the value to write to the TextWriter</param>
<remarks>
<para>
Writes a character to the wrapped TextWriter
</para>
</remarks>
</member>
<member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)">
<summary>
Writes a character buffer to the wrapped TextWriter
</summary>
<param name="buffer">the data buffer</param>
<param name="index">the start index</param>
<param name="count">the number of characters to write</param>
<remarks>
<para>
Writes a character buffer to the wrapped TextWriter
</para>
</remarks>
</member>
<member name="M:log4net.Util.TextWriterAdapter.Write(System.String)">
<summary>
Writes a string to the wrapped TextWriter
</summary>
<param name="value">the value to write to the TextWriter</param>
<remarks>
<para>
Writes a string to the wrapped TextWriter
</para>
</remarks>
</member>
<member name="P:log4net.Util.TextWriterAdapter.Writer">
<summary>
Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
</summary>
<value>
The underlying <see cref="T:System.IO.TextWriter"/>.
</value>
<remarks>
<para>
Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.TextWriterAdapter.Encoding">
<summary>
The Encoding in which the output is written
</summary>
<value>
The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/>
</value>
<remarks>
<para>
The Encoding in which the output is written
</para>
</remarks>
</member>
<member name="P:log4net.Util.TextWriterAdapter.FormatProvider">
<summary>
Gets an object that controls formatting
</summary>
<value>
The format provider
</value>
<remarks>
<para>
Gets an object that controls formatting
</para>
</remarks>
</member>
<member name="P:log4net.Util.TextWriterAdapter.NewLine">
<summary>
Gets or sets the line terminator string used by the TextWriter
</summary>
<value>
The line terminator to use
</value>
<remarks>
<para>
Gets or sets the line terminator string used by the TextWriter
</para>
</remarks>
</member>
<member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
<summary>
Constructor
</summary>
<param name="writer">the writer to actually write to</param>
<param name="errorHandler">the error handler to report error to</param>
<remarks>
<para>
Create a new QuietTextWriter using a writer and error handler
</para>
</remarks>
</member>
<member name="M:log4net.Util.QuietTextWriter.Write(System.Char)">
<summary>
Writes a character to the underlying writer
</summary>
<param name="value">the char to write</param>
<remarks>
<para>
Writes a character to the underlying writer
</para>
</remarks>
</member>
<member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
<summary>
Writes a buffer to the underlying writer
</summary>
<param name="buffer">the buffer to write</param>
<param name="index">the start index to write from</param>
<param name="count">the number of characters to write</param>
<remarks>
<para>
Writes a buffer to the underlying writer
</para>
</remarks>
</member>
<member name="M:log4net.Util.QuietTextWriter.Write(System.String)">
<summary>
Writes a string to the output.
</summary>
<param name="value">The string data to write to the output.</param>
<remarks>
<para>
Writes a string to the output.
</para>
</remarks>
</member>
<member name="M:log4net.Util.QuietTextWriter.Close">
<summary>
Closes the underlying output writer.
</summary>
<remarks>
<para>
Closes the underlying output writer.
</para>
</remarks>
</member>
<member name="F:log4net.Util.QuietTextWriter.m_errorHandler">
<summary>
The error handler instance to pass all errors to
</summary>
</member>
<member name="F:log4net.Util.QuietTextWriter.m_closed">
<summary>
Flag to indicate if this writer is closed
</summary>
</member>
<member name="P:log4net.Util.QuietTextWriter.ErrorHandler">
<summary>
Gets or sets the error handler that all errors are passed to.
</summary>
<value>
The error handler that all errors are passed to.
</value>
<remarks>
<para>
Gets or sets the error handler that all errors are passed to.
</para>
</remarks>
</member>
<member name="P:log4net.Util.QuietTextWriter.Closed">
<summary>
Gets a value indicating whether this writer is closed.
</summary>
<value>
<c>true</c> if this writer is closed, otherwise <c>false</c>.
</value>
<remarks>
<para>
Gets a value indicating whether this writer is closed.
</para>
</remarks>
</member>
<member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
<summary>
Constructor
</summary>
<param name="writer">The <see cref="T:System.IO.TextWriter"/> to actually write to.</param>
<param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler"/> to report errors to.</param>
<remarks>
<para>
Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter"/> class
with the specified <see cref="T:System.IO.TextWriter"/> and <see cref="T:log4net.Core.IErrorHandler"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
<summary>
Writes a character to the underlying writer and counts the number of bytes written.
</summary>
<param name="value">the char to write</param>
<remarks>
<para>
Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
the number of bytes written.
</para>
</remarks>
</member>
<member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
<summary>
Writes a buffer to the underlying writer and counts the number of bytes written.
</summary>
<param name="buffer">the buffer to write</param>
<param name="index">the start index to write from</param>
<param name="count">the number of characters to write</param>
<remarks>
<para>
Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
the number of bytes written.
</para>
</remarks>
</member>
<member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
<summary>
Writes a string to the output and counts the number of bytes written.
</summary>
<param name="str">The string data to write to the output.</param>
<remarks>
<para>
Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
the number of bytes written.
</para>
</remarks>
</member>
<member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
<summary>
Total number of bytes written.
</summary>
</member>
<member name="P:log4net.Util.CountingQuietTextWriter.Count">
<summary>
Gets or sets the total number of bytes written.
</summary>
<value>
The total number of bytes written.
</value>
<remarks>
<para>
Gets or sets the total number of bytes written.
</para>
</remarks>
</member>
<member name="T:log4net.Util.CyclicBuffer">
<summary>
A fixed size rolling buffer of logging events.
</summary>
<remarks>
<para>
An array backed fixed size leaky bucket.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)">
<summary>
Constructor
</summary>
<param name="maxSize">The maximum number of logging events in the buffer.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer"/> class with
the specified maximum number of buffered logging events.
</para>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception>
</member>
<member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)">
<summary>
Appends a <paramref name="loggingEvent"/> to the buffer.
</summary>
<param name="loggingEvent">The event to append to the buffer.</param>
<returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns>
<remarks>
<para>
Append an event to the buffer. If the buffer still contains free space then
<c>null</c> is returned. If the buffer is full then an event will be dropped
to make space for the new event, the event dropped is returned.
</para>
</remarks>
</member>
<member name="M:log4net.Util.CyclicBuffer.PopOldest">
<summary>
Get and remove the oldest event in the buffer.
</summary>
<returns>The oldest logging event in the buffer</returns>
<remarks>
<para>
Gets the oldest (first) logging event in the buffer and removes it
from the buffer.
</para>
</remarks>
</member>
<member name="M:log4net.Util.CyclicBuffer.PopAll">
<summary>
Pops all the logging events from the buffer into an array.
</summary>
<returns>An array of all the logging events in the buffer.</returns>
<remarks>
<para>
Get all the events in the buffer and clear the buffer.
</para>
</remarks>
</member>
<member name="M:log4net.Util.CyclicBuffer.Clear">
<summary>
Clear the buffer
</summary>
<remarks>
<para>
Clear the buffer of all events. The events in the buffer are lost.
</para>
</remarks>
</member>
<member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
<summary>
Gets the <paramref name="i"/>th oldest event currently in the buffer.
</summary>
<value>The <paramref name="i"/>th oldest event currently in the buffer.</value>
<remarks>
<para>
If <paramref name="i"/> is outside the range 0 to the number of events
currently in the buffer, then <c>null</c> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Util.CyclicBuffer.MaxSize">
<summary>
Gets the maximum size of the buffer.
</summary>
<value>The maximum size of the buffer.</value>
<remarks>
<para>
Gets the maximum size of the buffer
</para>
</remarks>
</member>
<member name="P:log4net.Util.CyclicBuffer.Length">
<summary>
Gets the number of logging events in the buffer.
</summary>
<value>The number of logging events in the buffer.</value>
<remarks>
<para>
This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/>
(inclusive).
</para>
</remarks>
</member>
<member name="T:log4net.Util.EmptyCollection">
<summary>
An always empty <see cref="T:System.Collections.ICollection"/>.
</summary>
<remarks>
<para>
A singleton implementation of the <see cref="T:System.Collections.ICollection"/>
interface that always represents an empty collection.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.EmptyCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection"/> class.
</summary>
<remarks>
<para>
Uses a private access modifier to enforce the singleton pattern.
</para>
</remarks>
</member>
<member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)">
<summary>
Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
<see cref="T:System.Array"/>, starting at a particular Array index.
</summary>
<param name="array">The one-dimensional <see cref="T:System.Array"/>
that is the destination of the elements copied from
<see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
indexing.</param>
<param name="index">The zero-based index in array at which
copying begins.</param>
<remarks>
<para>
As the collection is empty no values are copied into the array.
</para>
</remarks>
</member>
<member name="M:log4net.Util.EmptyCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator"/> that can be used to
iterate through the collection.
</returns>
<remarks>
<para>
As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
</para>
</remarks>
</member>
<member name="F:log4net.Util.EmptyCollection.s_instance">
<summary>
The singleton instance of the empty collection.
</summary>
</member>
<member name="P:log4net.Util.EmptyCollection.Instance">
<summary>
Gets the singleton instance of the empty collection.
</summary>
<returns>The singleton instance of the empty collection.</returns>
<remarks>
<para>
Gets the singleton instance of the empty collection.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyCollection.IsSynchronized">
<summary>
Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
</summary>
<value>
<b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
</value>
<remarks>
<para>
For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyCollection.Count">
<summary>
Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
</summary>
<value>
The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
</value>
<remarks>
<para>
As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyCollection.SyncRoot">
<summary>
Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
</summary>
<value>
An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
</value>
<remarks>
<para>
As the collection is empty and thread safe and synchronized this instance is also
the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object.
</para>
</remarks>
</member>
<member name="T:log4net.Util.EmptyDictionary">
<summary>
An always empty <see cref="T:System.Collections.IDictionary"/>.
</summary>
<remarks>
<para>
A singleton implementation of the <see cref="T:System.Collections.IDictionary"/>
interface that always represents an empty collection.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.EmptyDictionary.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary"/> class.
</summary>
<remarks>
<para>
Uses a private access modifier to enforce the singleton pattern.
</para>
</remarks>
</member>
<member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)">
<summary>
Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
<see cref="T:System.Array"/>, starting at a particular Array index.
</summary>
<param name="array">The one-dimensional <see cref="T:System.Array"/>
that is the destination of the elements copied from
<see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
indexing.</param>
<param name="index">The zero-based index in array at which
copying begins.</param>
<remarks>
<para>
As the collection is empty no values are copied into the array.
</para>
</remarks>
</member>
<member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that can iterate through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator"/> that can be used to
iterate through the collection.
</returns>
<remarks>
<para>
As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
</para>
</remarks>
</member>
<member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)">
<summary>
Adds an element with the provided key and value to the
<see cref="T:log4net.Util.EmptyDictionary"/>.
</summary>
<param name="key">The <see cref="T:System.Object"/> to use as the key of the element to add.</param>
<param name="value">The <see cref="T:System.Object"/> to use as the value of the element to add.</param>
<remarks>
<para>
As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/>
is thrown if this method is called.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
</member>
<member name="M:log4net.Util.EmptyDictionary.Clear">
<summary>
Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary"/>.
</summary>
<remarks>
<para>
As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
is thrown if this method is called.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
</member>
<member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)">
<summary>
Determines whether the <see cref="T:log4net.Util.EmptyDictionary"/> contains an element
with the specified key.
</summary>
<param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary"/>.</param>
<returns><c>false</c></returns>
<remarks>
<para>
As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Util.EmptyDictionary.GetEnumerator">
<summary>
Returns an enumerator that can iterate through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator"/> that can be used to
iterate through the collection.
</returns>
<remarks>
<para>
As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
</para>
</remarks>
</member>
<member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)">
<summary>
Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary"/>.
</summary>
<param name="key">The key of the element to remove.</param>
<remarks>
<para>
As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
is thrown if this method is called.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
</member>
<member name="F:log4net.Util.EmptyDictionary.s_instance">
<summary>
The singleton instance of the empty dictionary.
</summary>
</member>
<member name="P:log4net.Util.EmptyDictionary.Instance">
<summary>
Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
</summary>
<returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.</returns>
<remarks>
<para>
Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyDictionary.IsSynchronized">
<summary>
Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
</summary>
<value>
<b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
</value>
<remarks>
<para>
For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyDictionary.Count">
<summary>
Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>
</summary>
<value>
The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
</value>
<remarks>
<para>
As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyDictionary.SyncRoot">
<summary>
Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
</summary>
<value>
An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
</value>
<remarks>
<para>
As the collection is empty and thread safe and synchronized this instance is also
the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyDictionary.IsFixedSize">
<summary>
Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> has a fixed size.
</summary>
<value><c>true</c></value>
<remarks>
<para>
As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyDictionary.IsReadOnly">
<summary>
Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> is read-only.
</summary>
<value><c>true</c></value>
<remarks>
<para>
As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyDictionary.Keys">
<summary>
Gets an <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.
</summary>
<value>An <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
<remarks>
<para>
As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyDictionary.Values">
<summary>
Gets an <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.
</summary>
<value>An <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
<remarks>
<para>
As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Util.EmptyDictionary.Item(System.Object)">
<summary>
Gets or sets the element with the specified key.
</summary>
<param name="key">The key of the element to get or set.</param>
<value><c>null</c></value>
<remarks>
<para>
As the collection is empty no values can be looked up or stored.
If the index getter is called then <c>null</c> is returned.
A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
</member>
<member name="T:log4net.Util.FormattingInfo">
<summary>
Contain the information obtained when parsing formatting modifiers
in conversion modifiers.
</summary>
<remarks>
<para>
Holds the formatting information extracted from the format string by
the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/>
objects when rendering the output.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.FormattingInfo.#ctor">
<summary>
Defaut Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class
with the specified parameters.
</para>
</remarks>
</member>
<member name="P:log4net.Util.FormattingInfo.Min">
<summary>
Gets or sets the minimum value.
</summary>
<value>
The minimum value.
</value>
<remarks>
<para>
Gets or sets the minimum value.
</para>
</remarks>
</member>
<member name="P:log4net.Util.FormattingInfo.Max">
<summary>
Gets or sets the maximum value.
</summary>
<value>
The maximum value.
</value>
<remarks>
<para>
Gets or sets the maximum value.
</para>
</remarks>
</member>
<member name="P:log4net.Util.FormattingInfo.LeftAlign">
<summary>
Gets or sets a flag indicating whether left align is enabled
or not.
</summary>
<value>
A flag indicating whether left align is enabled or not.
</value>
<remarks>
<para>
Gets or sets a flag indicating whether left align is enabled or not.
</para>
</remarks>
</member>
<member name="T:log4net.Util.GlobalContextProperties">
<summary>
Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/>
</summary>
<remarks>
<para>
This class implements a properties collection that is thread safe and supports both
storing properties and capturing a read only copy of the current propertied.
</para>
<para>
This class is optimized to the scenario where the properties are read frequently
and are modified infrequently.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties">
<summary>
The read only copy of the properties.
</summary>
<remarks>
<para>
This variable is declared <c>volatile</c> to prevent the compiler and JIT from
reordering reads and writes of this thread performed on different threads.
</para>
</remarks>
</member>
<member name="F:log4net.Util.GlobalContextProperties.m_syncRoot">
<summary>
Lock object used to synchronize updates within this instance
</summary>
</member>
<member name="M:log4net.Util.GlobalContextProperties.#ctor">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)">
<summary>
Remove a property from the global context
</summary>
<param name="key">the key for the entry to remove</param>
<remarks>
<para>
Removing an entry from the global context properties is relatively expensive compared
with reading a value.
</para>
</remarks>
</member>
<member name="M:log4net.Util.GlobalContextProperties.Clear">
<summary>
Clear the global context properties
</summary>
</member>
<member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties">
<summary>
Get a readonly immutable copy of the properties
</summary>
<returns>the current global context properties</returns>
<remarks>
<para>
This implementation is fast because the GlobalContextProperties class
stores a readonly copy of the properties.
</para>
</remarks>
</member>
<member name="P:log4net.Util.GlobalContextProperties.Item(System.String)">
<summary>
Gets or sets the value of a property
</summary>
<value>
The value for the property with the specified key
</value>
<remarks>
<para>
Reading the value for a key is faster than setting the value.
When the value is written a new read only copy of
the properties is created.
</para>
</remarks>
</member>
<member name="T:log4net.Util.ILogExtensions">
<summary>
The static class ILogExtensions contains a set of widely used
methods that ease the interaction with the ILog interface implementations.
</summary>
<remarks>
<para>
This class contains methods for logging at different levels and checks the
properties for determining if those logging levels are enabled in the current
configuration.
</para>
</remarks>
<example>Simple example of logging messages
<code lang="C#">
using log4net.Util;
ILog log = LogManager.GetLogger("application-log");
log.InfoExt("Application Start");
log.DebugExt("This is a debug message");
</code>
</example>
</member>
<member name="F:log4net.Util.ILogExtensions.declaringType">
<summary>
The fully qualified type of the Logger class.
</summary>
</member>
<member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object})">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>INFO</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>INFO</c> enabled, then it converts
the message object (retrieved by invocation of the provided callback) to a
string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
It then proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Debug(System.Object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Debug(System.Object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> //TODO
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>INFO</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>INFO</c> enabled, then it converts
the message object (passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Debug(System.Object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Debug(System.Object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Debug(System.Object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Debug(System.Object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Debug(System.Object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Debug(System.Object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Debug(System.Object)"/>
<seealso cref="P:log4net.ILog.IsDebugEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object})">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>INFO</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>INFO</c> enabled, then it converts
the message object (retrieved by invocation of the provided callback) to a
string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
It then proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Info(System.Object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Info(System.Object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> //TODO
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>INFO</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>INFO</c> enabled, then it converts
the message object (passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Info(System.Object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Info(System.Object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Info(System.Object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Info(System.Object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Info(System.Object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Info(System.Object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Info(System.Object)"/>
<seealso cref="P:log4net.ILog.IsInfoEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object})">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>WARN</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>WARN</c> enabled, then it converts
the message object (retrieved by invocation of the provided callback) to a
string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
It then proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Warn(System.Object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Warn(System.Object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> //TODO
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>WARN</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>WARN</c> enabled, then it converts
the message object (passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Warn(System.Object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Warn(System.Object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Warn(System.Object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Warn(System.Object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Warn(System.Object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Warn(System.Object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Warn(System.Object)"/>
<seealso cref="P:log4net.ILog.IsWarnEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object})">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>ERROR</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>ERROR</c> enabled, then it converts
the message object (retrieved by invocation of the provided callback) to a
string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
It then proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Error(System.Object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Error(System.Object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> //TODO
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>ERROR</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>ERROR</c> enabled, then it converts
the message object (passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Error(System.Object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Error(System.Object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Error(System.Object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Error(System.Object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Error(System.Object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Error(System.Object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Error(System.Object)"/>
<seealso cref="P:log4net.ILog.IsErrorEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object})">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>FATAL</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>FATAL</c> enabled, then it converts
the message object (retrieved by invocation of the provided callback) to a
string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
It then proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="callback">The lambda expression that gets the object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)">
<overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> //TODO
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<remarks>
<para>
This method first checks if this logger is <c>FATAL</c>
enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
implementation. If this logger is <c>FATAL</c> enabled, then it converts
the message object (passed as parameter) to a string by invoking the appropriate
<see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
proceeds to call all the registered appenders in this logger
and also higher in the hierarchy depending on the value of
the additivity flag.
</para>
<para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
to this method will print the name of the <see cref="T:System.Exception"/>
but no stack trace. To print a stack trace use the
<see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)">
<summary>
Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
the stack trace of the <see cref="T:System.Exception"/> passed
as a parameter.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="message">The message object to log.</param>
<param name="exception">The exception to log, including its stack trace.</param>
<remarks>
<para>
See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="args">An Object array containing zero or more objects to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
<summary>
Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
</summary>
<param name="logger">The logger on which the message is logged.</param>
<param name="format">A String containing zero or more format items</param>
<param name="arg0">An Object to format</param>
<param name="arg1">An Object to format</param>
<param name="arg2">An Object to format</param>
<remarks>
<para>
The message is formatted using the <c>String.Format</c> method. See
<see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
of the formatting.
</para>
<para>
This method does not take an <see cref="T:System.Exception"/> object to include in the
log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
methods instead.
</para>
</remarks>
<seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
<seealso cref="P:log4net.ILog.IsFatalEnabled"/>
</member>
<member name="T:log4net.Util.LevelMapping">
<summary>
Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/>
</summary>
<remarks>
<para>
Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances
to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.LevelMapping.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)">
<summary>
Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping
</summary>
<param name="entry">the entry to add</param>
<remarks>
<para>
If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added
for the same <see cref="T:log4net.Core.Level"/> then that entry will be
overwritten.
</para>
</remarks>
</member>
<member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)">
<summary>
Lookup the mapping for the specified level
</summary>
<param name="level">the level to lookup</param>
<returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns>
<remarks>
<para>
Lookup the value for the specified level. Finds the nearest
mapping value for the level that is equal to or less than the
<paramref name="level"/> specified.
</para>
<para>
If no mapping could be found then <c>null</c> is returned.
</para>
</remarks>
</member>
<member name="M:log4net.Util.LevelMapping.ActivateOptions">
<summary>
Initialize options
</summary>
<remarks>
<para>
Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array
</para>
</remarks>
</member>
<member name="T:log4net.Util.LogicalThreadContextProperties">
<summary>
Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/>
</summary>
<remarks>
<para>
Class implements a collection of properties that is specific to each thread.
The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
</para>
<para>
This class stores its properties in a slot on the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> named
<c>log4net.Util.LogicalThreadContextProperties</c>.
</para>
<para>
The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
<see cref="T:System.Security.Permissions.SecurityPermission"/> for the
<see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
If the calling code does not have this permission then this context will be disabled.
It will not store any property values set on it.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled">
<summary>
Flag used to disable this context if we don't have permission to access the CallContext.
</summary>
</member>
<member name="M:log4net.Util.LogicalThreadContextProperties.#ctor">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)">
<summary>
Remove a property
</summary>
<param name="key">the key for the entry to remove</param>
<remarks>
<para>
Remove the value for the specified <paramref name="key"/> from the context.
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogicalThreadContextProperties.Clear">
<summary>
Clear all the context properties
</summary>
<remarks>
<para>
Clear all the context properties
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)">
<summary>
Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread.
</summary>
<param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param>
<returns>the properties for this thread</returns>
<remarks>
<para>
The collection returned is only to be used on the calling thread. If the
caller needs to share the collection between different threads then the
caller must clone the collection before doings so.
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogicalThreadContextProperties.GetCallContextData">
<summary>
Gets the call context get data.
</summary>
<returns>The peroperties dictionary stored in the call context</returns>
<remarks>
The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.GetData(System.String)"/> has a
security link demand, therfore we must put the method call in a seperate method
that we can wrap in an exception handler.
</remarks>
</member>
<member name="M:log4net.Util.LogicalThreadContextProperties.SetCallContextData(log4net.Util.PropertiesDictionary)">
<summary>
Sets the call context data.
</summary>
<param name="properties">The properties.</param>
<remarks>
The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.SetData(System.String,System.Object)"/> has a
security link demand, therfore we must put the method call in a seperate method
that we can wrap in an exception handler.
</remarks>
</member>
<member name="F:log4net.Util.LogicalThreadContextProperties.declaringType">
<summary>
The fully qualified type of the LogicalThreadContextProperties class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)">
<summary>
Gets or sets the value of a property
</summary>
<value>
The value for the property with the specified key
</value>
<remarks>
<para>
Get or set the property value for the <paramref name="key"/> specified.
</para>
</remarks>
</member>
<member name="T:log4net.Util.LogReceivedEventHandler">
<summary>
</summary>
<param name="source"></param>
<param name="e"></param>
</member>
<member name="T:log4net.Util.LogLog">
<summary>
Outputs log statements from within the log4net assembly.
</summary>
<remarks>
<para>
Log4net components cannot make log4net logging calls. However, it is
sometimes useful for the user to learn about what log4net is
doing.
</para>
<para>
All log4net internal debug calls go to the standard output stream
whereas internal error messages are sent to the standard error output
stream.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.LogLog.ToString">
<summary>
Formats Prefix, Source, and Message in the same format as the value
sent to Console.Out and Trace.Write.
</summary>
<returns></returns>
</member>
<member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Util.LogLog"/> class.
</summary>
<param name="source"></param>
<param name="prefix"></param>
<param name="message"></param>
<param name="exception"></param>
</member>
<member name="M:log4net.Util.LogLog.#cctor">
<summary>
Static constructor that initializes logging by reading
settings from the application configuration file.
</summary>
<remarks>
<para>
The <c>log4net.Internal.Debug</c> application setting
controls internal debugging. This setting should be set
to <c>true</c> to enable debugging.
</para>
<para>
The <c>log4net.Internal.Quiet</c> application setting
suppresses all internal logging including error messages.
This setting should be set to <c>true</c> to enable message
suppression.
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)">
<summary>
Raises the LogReceived event when an internal messages is received.
</summary>
<param name="source"></param>
<param name="prefix"></param>
<param name="message"></param>
<param name="exception"></param>
</member>
<member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)">
<summary>
Writes log4net internal debug messages to the
standard output stream.
</summary>
<param name="source"></param>
<param name="message">The message to log.</param>
<remarks>
<para>
All internal debug messages are prepended with
the string "log4net: ".
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)">
<summary>
Writes log4net internal debug messages to the
standard output stream.
</summary>
<param name="source">The Type that generated this message.</param>
<param name="message">The message to log.</param>
<param name="exception">An exception to log.</param>
<remarks>
<para>
All internal debug messages are prepended with
the string "log4net: ".
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)">
<summary>
Writes log4net internal warning messages to the
standard error stream.
</summary>
<param name="source">The Type that generated this message.</param>
<param name="message">The message to log.</param>
<remarks>
<para>
All internal warning messages are prepended with
the string "log4net:WARN ".
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)">
<summary>
Writes log4net internal warning messages to the
standard error stream.
</summary>
<param name="source">The Type that generated this message.</param>
<param name="message">The message to log.</param>
<param name="exception">An exception to log.</param>
<remarks>
<para>
All internal warning messages are prepended with
the string "log4net:WARN ".
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogLog.Error(System.Type,System.String)">
<summary>
Writes log4net internal error messages to the
standard error stream.
</summary>
<param name="source">The Type that generated this message.</param>
<param name="message">The message to log.</param>
<remarks>
<para>
All internal error messages are prepended with
the string "log4net:ERROR ".
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)">
<summary>
Writes log4net internal error messages to the
standard error stream.
</summary>
<param name="source">The Type that generated this message.</param>
<param name="message">The message to log.</param>
<param name="exception">An exception to log.</param>
<remarks>
<para>
All internal debug messages are prepended with
the string "log4net:ERROR ".
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogLog.EmitOutLine(System.String)">
<summary>
Writes output to the standard output stream.
</summary>
<param name="message">The message to log.</param>
<remarks>
<para>
Writes to both Console.Out and System.Diagnostics.Trace.
Note that the System.Diagnostics.Trace is not supported
on the Compact Framework.
</para>
<para>
If the AppDomain is not configured with a config file then
the call to System.Diagnostics.Trace may fail. This is only
an issue if you are programmatically creating your own AppDomains.
</para>
</remarks>
</member>
<member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)">
<summary>
Writes output to the standard error stream.
</summary>
<param name="message">The message to log.</param>
<remarks>
<para>
Writes to both Console.Error and System.Diagnostics.Trace.
Note that the System.Diagnostics.Trace is not supported
on the Compact Framework.
</para>
<para>
If the AppDomain is not configured with a config file then
the call to System.Diagnostics.Trace may fail. This is only
an issue if you are programmatically creating your own AppDomains.
</para>
</remarks>
</member>
<member name="F:log4net.Util.LogLog.s_debugEnabled">
<summary>
Default debug level
</summary>
</member>
<member name="F:log4net.Util.LogLog.s_quietMode">
<summary>
In quietMode not even errors generate any output.
</summary>
</member>
<member name="E:log4net.Util.LogLog.LogReceived">
<summary>
The event raised when an internal message has been received.
</summary>
</member>
<member name="P:log4net.Util.LogLog.Source">
<summary>
The Type that generated the internal message.
</summary>
</member>
<member name="P:log4net.Util.LogLog.TimeStamp">
<summary>
The DateTime stamp of when the internal message was received.
</summary>
</member>
<member name="P:log4net.Util.LogLog.Prefix">
<summary>
A string indicating the severity of the internal message.
</summary>
<remarks>
"log4net: ",
"log4net:ERROR ",
"log4net:WARN "
</remarks>
</member>
<member name="P:log4net.Util.LogLog.Message">
<summary>
The internal log message.
</summary>
</member>
<member name="P:log4net.Util.LogLog.Exception">
<summary>
The Exception related to the message.
</summary>
<remarks>
Optional. Will be null if no Exception was passed.
</remarks>
</member>
<member name="P:log4net.Util.LogLog.InternalDebugging">
<summary>
Gets or sets a value indicating whether log4net internal logging
is enabled or disabled.
</summary>
<value>
<c>true</c> if log4net internal logging is enabled, otherwise
<c>false</c>.
</value>
<remarks>
<para>
When set to <c>true</c>, internal debug level logging will be
displayed.
</para>
<para>
This value can be set by setting the application setting
<c>log4net.Internal.Debug</c> in the application configuration
file.
</para>
<para>
The default value is <c>false</c>, i.e. debugging is
disabled.
</para>
</remarks>
<example>
<para>
The following example enables internal debugging using the
application configuration file :
</para>
<code lang="XML" escaped="true">
<configuration>
<appSettings>
<add key="log4net.Internal.Debug" value="true" />
</appSettings>
</configuration>
</code>
</example>
</member>
<member name="P:log4net.Util.LogLog.QuietMode">
<summary>
Gets or sets a value indicating whether log4net should generate no output
from internal logging, not even for errors.
</summary>
<value>
<c>true</c> if log4net should generate no output at all from internal
logging, otherwise <c>false</c>.
</value>
<remarks>
<para>
When set to <c>true</c> will cause internal logging at all levels to be
suppressed. This means that no warning or error reports will be logged.
This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and
disables all debug also.
</para>
<para>This value can be set by setting the application setting
<c>log4net.Internal.Quiet</c> in the application configuration file.
</para>
<para>
The default value is <c>false</c>, i.e. internal logging is not
disabled.
</para>
</remarks>
<example>
The following example disables internal logging using the
application configuration file :
<code lang="XML" escaped="true">
<configuration>
<appSettings>
<add key="log4net.Internal.Quiet" value="true"/>
</appSettings>
</configuration>
</code>
</example>
</member>
<member name="P:log4net.Util.LogLog.EmitInternalMessages">
<summary>
</summary>
</member>
<member name="P:log4net.Util.LogLog.IsDebugEnabled">
<summary>
Test if LogLog.Debug is enabled for output.
</summary>
<value>
<c>true</c> if Debug is enabled
</value>
<remarks>
<para>
Test if LogLog.Debug is enabled for output.
</para>
</remarks>
</member>
<member name="P:log4net.Util.LogLog.IsWarnEnabled">
<summary>
Test if LogLog.Warn is enabled for output.
</summary>
<value>
<c>true</c> if Warn is enabled
</value>
<remarks>
<para>
Test if LogLog.Warn is enabled for output.
</para>
</remarks>
</member>
<member name="P:log4net.Util.LogLog.IsErrorEnabled">
<summary>
Test if LogLog.Error is enabled for output.
</summary>
<value>
<c>true</c> if Error is enabled
</value>
<remarks>
<para>
Test if LogLog.Error is enabled for output.
</para>
</remarks>
</member>
<member name="T:log4net.Util.LogLog.LogReceivedAdapter">
<summary>
Subscribes to the LogLog.LogReceived event and stores messages
to the supplied IList instance.
</summary>
</member>
<member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)">
<summary>
</summary>
<param name="items"></param>
</member>
<member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose">
<summary>
</summary>
</member>
<member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items">
<summary>
</summary>
</member>
<member name="T:log4net.Util.LogReceivedEventArgs">
<summary>
</summary>
</member>
<member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)">
<summary>
</summary>
<param name="loglog"></param>
</member>
<member name="P:log4net.Util.LogReceivedEventArgs.LogLog">
<summary>
</summary>
</member>
<member name="T:log4net.Util.NativeError">
<summary>
Represents a native error code and message.
</summary>
<remarks>
<para>
Represents a Win32 platform native error.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
<summary>
Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
error number and message.
</summary>
<param name="number">The number of the native error.</param>
<param name="message">The message of the native error.</param>
<remarks>
<para>
Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
error number and message.
</para>
</remarks>
</member>
<member name="M:log4net.Util.NativeError.GetLastError">
<summary>
Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class for the last Windows error.
</summary>
<returns>
An instance of the <see cref="T:log4net.Util.NativeError"/> class for the last windows error.
</returns>
<remarks>
<para>
The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
native Win32 <c>FormatMessage</c> function.
</para>
</remarks>
</member>
<member name="M:log4net.Util.NativeError.GetError(System.Int32)">
<summary>
Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class.
</summary>
<param name="number">the error number for the native error</param>
<returns>
An instance of the <see cref="T:log4net.Util.NativeError"/> class for the specified
error number.
</returns>
<remarks>
<para>
The message for the specified error number is lookup up using the
native Win32 <c>FormatMessage</c> function.
</para>
</remarks>
</member>
<member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
<summary>
Retrieves the message corresponding with a Win32 message identifier.
</summary>
<param name="messageId">Message identifier for the requested message.</param>
<returns>
The message corresponding with the specified message identifier.
</returns>
<remarks>
<para>
The message will be searched for in system message-table resource(s)
using the native <c>FormatMessage</c> function.
</para>
</remarks>
</member>
<member name="M:log4net.Util.NativeError.ToString">
<summary>
Return error information string
</summary>
<returns>error information string</returns>
<remarks>
<para>
Return error information string
</para>
</remarks>
</member>
<member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
<summary>
Formats a message string.
</summary>
<param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param>
<param name="lpSource">Location of the message definition.</param>
<param name="dwMessageId">Message identifier for the requested message.</param>
<param name="dwLanguageId">Language identifier for the requested message.</param>
<param name="lpBuffer">If <paramref name="dwFlags" /> includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the <c>LocalAlloc</c> function, and places the pointer to the buffer at the address specified in <paramref name="lpBuffer" />.</param>
<param name="nSize">If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer.</param>
<param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
<remarks>
<para>
The function requires a message definition as input. The message definition can come from a
buffer passed into the function. It can come from a message table resource in an
already-loaded module. Or the caller can ask the function to search the system's message
table resource(s) for the message definition. The function finds the message definition
in a message table resource based on a message identifier and a language identifier.
The function copies the formatted message text to an output buffer, processing any embedded
insert sequences if requested.
</para>
<para>
To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
</para>
</remarks>
<returns>
<para>
If the function succeeds, the return value is the number of TCHARs stored in the output
buffer, excluding the terminating null character.
</para>
<para>
If the function fails, the return value is zero. To get extended error information,
call <see cref="M:Marshal.GetLastWin32Error()" />.
</para>
</returns>
</member>
<member name="P:log4net.Util.NativeError.Number">
<summary>
Gets the number of the native error.
</summary>
<value>
The number of the native error.
</value>
<remarks>
<para>
Gets the number of the native error.
</para>
</remarks>
</member>
<member name="P:log4net.Util.NativeError.Message">
<summary>
Gets the message of the native error.
</summary>
<value>
The message of the native error.
</value>
<remarks>
<para>
</para>
Gets the message of the native error.
</remarks>
</member>
<member name="T:log4net.Util.NullDictionaryEnumerator">
<summary>
An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>.
</summary>
<remarks>
<para>
A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection
that is empty and not modifiable.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.NullDictionaryEnumerator.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> class.
</summary>
<remarks>
<para>
Uses a private access modifier to enforce the singleton pattern.
</para>
</remarks>
</member>
<member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext">
<summary>
Test if the enumerator can advance, if so advance.
</summary>
<returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> cannot advance.</returns>
<remarks>
<para>
As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/>
will always return <c>false</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Util.NullDictionaryEnumerator.Reset">
<summary>
Resets the enumerator back to the start.
</summary>
<remarks>
<para>
As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing.
</para>
</remarks>
</member>
<member name="F:log4net.Util.NullDictionaryEnumerator.s_instance">
<summary>
The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
</summary>
</member>
<member name="P:log4net.Util.NullDictionaryEnumerator.Instance">
<summary>
Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
</summary>
<returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.</returns>
<remarks>
<para>
Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.NullDictionaryEnumerator.Current">
<summary>
Gets the current object from the enumerator.
</summary>
<remarks>
Throws an <see cref="T:System.InvalidOperationException"/> because the
<see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
</remarks>
<remarks>
<para>
As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
will throw an <see cref="T:System.InvalidOperationException"/>.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
cannot be positioned over a valid location.</exception>
</member>
<member name="P:log4net.Util.NullDictionaryEnumerator.Key">
<summary>
Gets the current key from the enumerator.
</summary>
<remarks>
Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>
never has a current value.
</remarks>
<remarks>
<para>
As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/>
will throw an <see cref="T:System.InvalidOperationException"/>.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
cannot be positioned over a valid location.</exception>
</member>
<member name="P:log4net.Util.NullDictionaryEnumerator.Value">
<summary>
Gets the current value from the enumerator.
</summary>
<value>The current value from the enumerator.</value>
<remarks>
Throws an <see cref="T:System.InvalidOperationException"/> because the
<see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
</remarks>
<remarks>
<para>
As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/>
will throw an <see cref="T:System.InvalidOperationException"/>.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
cannot be positioned over a valid location.</exception>
</member>
<member name="P:log4net.Util.NullDictionaryEnumerator.Entry">
<summary>
Gets the current entry from the enumerator.
</summary>
<remarks>
Throws an <see cref="T:System.InvalidOperationException"/> because the
<see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current entry.
</remarks>
<remarks>
<para>
As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/>
will throw an <see cref="T:System.InvalidOperationException"/>.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
cannot be positioned over a valid location.</exception>
</member>
<member name="T:log4net.Util.NullEnumerator">
<summary>
An always empty <see cref="T:System.Collections.IEnumerator"/>.
</summary>
<remarks>
<para>
A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection
that is empty and not modifiable.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.NullEnumerator.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator"/> class.
</summary>
<remarks>
<para>
Uses a private access modifier to enforce the singleton pattern.
</para>
</remarks>
</member>
<member name="M:log4net.Util.NullEnumerator.MoveNext">
<summary>
Test if the enumerator can advance, if so advance
</summary>
<returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator"/> cannot advance.</returns>
<remarks>
<para>
As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/>
will always return <c>false</c>.
</para>
</remarks>
</member>
<member name="M:log4net.Util.NullEnumerator.Reset">
<summary>
Resets the enumerator back to the start.
</summary>
<remarks>
<para>
As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing.
</para>
</remarks>
</member>
<member name="F:log4net.Util.NullEnumerator.s_instance">
<summary>
The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
</summary>
</member>
<member name="P:log4net.Util.NullEnumerator.Instance">
<summary>
Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
</summary>
<returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.</returns>
<remarks>
<para>
Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.NullEnumerator.Current">
<summary>
Gets the current object from the enumerator.
</summary>
<remarks>
Throws an <see cref="T:System.InvalidOperationException"/> because the
<see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
</remarks>
<remarks>
<para>
As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/>
will throw an <see cref="T:System.InvalidOperationException"/>.
</para>
</remarks>
<exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/>
cannot be positioned over a valid location.</exception>
</member>
<member name="T:log4net.Util.NullSecurityContext">
<summary>
A SecurityContext used when a SecurityContext is not required
</summary>
<remarks>
<para>
The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the
<see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/>
is required but one has not been provided.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Util.NullSecurityContext.Instance">
<summary>
Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
</summary>
<remarks>
<para>
Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
</para>
</remarks>
</member>
<member name="M:log4net.Util.NullSecurityContext.#ctor">
<summary>
Private constructor
</summary>
<remarks>
<para>
Private constructor for singleton pattern.
</para>
</remarks>
</member>
<member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)">
<summary>
Impersonate this SecurityContext
</summary>
<param name="state">State supplied by the caller</param>
<returns><c>null</c></returns>
<remarks>
<para>
No impersonation is done and <c>null</c> is always returned.
</para>
</remarks>
</member>
<member name="T:log4net.Util.OnlyOnceErrorHandler">
<summary>
Implements log4net's default error handling policy which consists
of emitting a message for the first error in an appender and
ignoring all subsequent errors.
</summary>
<remarks>
<para>
The error message is processed using the LogLog sub-system by default.
</para>
<para>
This policy aims at protecting an otherwise working application
from being flooded with error messages when logging fails.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Ron Grabowski</author>
</member>
<member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor">
<summary>
Default Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="prefix">The prefix to use for each message.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class
with the specified prefix.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OnlyOnceErrorHandler.Reset">
<summary>
Reset the error handler back to its initial disabled state.
</summary>
</member>
<member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
<summary>
Log an Error
</summary>
<param name="message">The error message.</param>
<param name="e">The exception.</param>
<param name="errorCode">The internal error code.</param>
<remarks>
<para>
Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)">
<summary>
Log the very first error
</summary>
<param name="message">The error message.</param>
<param name="e">The exception.</param>
<param name="errorCode">The internal error code.</param>
<remarks>
<para>
Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)">
<summary>
Log an Error
</summary>
<param name="message">The error message.</param>
<param name="e">The exception.</param>
<remarks>
<para>
Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)">
<summary>
Log an error
</summary>
<param name="message">The error message.</param>
<remarks>
<para>
Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
</para>
</remarks>
</member>
<member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDate">
<summary>
The date the error was recorded.
</summary>
</member>
<member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime">
<summary>
Flag to indicate if it is the first error
</summary>
</member>
<member name="F:log4net.Util.OnlyOnceErrorHandler.m_message">
<summary>
The message recorded during the first error.
</summary>
</member>
<member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception">
<summary>
The exception recorded during the first error.
</summary>
</member>
<member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode">
<summary>
The error code recorded during the first error.
</summary>
</member>
<member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix">
<summary>
String to prefix each message with
</summary>
</member>
<member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType">
<summary>
The fully qualified type of the OnlyOnceErrorHandler class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled">
<summary>
Is error logging enabled
</summary>
<remarks>
<para>
Is error logging enabled. Logging is only enabled for the
first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate">
<summary>
The date the first error that trigged this error handler occured.
</summary>
</member>
<member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage">
<summary>
The message from the first error that trigged this error handler.
</summary>
</member>
<member name="P:log4net.Util.OnlyOnceErrorHandler.Exception">
<summary>
The exception from the first error that trigged this error handler.
</summary>
<remarks>
May be <see langword="null" />.
</remarks>
</member>
<member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode">
<summary>
The error code from the first error that trigged this error handler.
</summary>
<remarks>
Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/>
</remarks>
</member>
<member name="T:log4net.Util.OptionConverter">
<summary>
A convenience class to convert property values to specific types.
</summary>
<remarks>
<para>
Utility functions for converting types and parsing values.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.OptionConverter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter"/> class.
</summary>
<remarks>
<para>
Uses a private access modifier to prevent instantiation of this class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)">
<summary>
Converts a string to a <see cref="T:System.Boolean"/> value.
</summary>
<param name="argValue">String to convert.</param>
<param name="defaultValue">The default value.</param>
<returns>The <see cref="T:System.Boolean"/> value of <paramref name="argValue"/>.</returns>
<remarks>
<para>
If <paramref name="argValue"/> is "true", then <c>true</c> is returned.
If <paramref name="argValue"/> is "false", then <c>false</c> is returned.
Otherwise, <paramref name="defaultValue"/> is returned.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)">
<summary>
Parses a file size into a number.
</summary>
<param name="argValue">String to parse.</param>
<param name="defaultValue">The default value.</param>
<returns>The <see cref="T:System.Int64"/> value of <paramref name="argValue"/>.</returns>
<remarks>
<para>
Parses a file size of the form: number[KB|MB|GB] into a
long value. It is scaled with the appropriate multiplier.
</para>
<para>
<paramref name="defaultValue"/> is returned when <paramref name="argValue"/>
cannot be converted to a <see cref="T:System.Int64"/> value.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)">
<summary>
Converts a string to an object.
</summary>
<param name="target">The target type to convert to.</param>
<param name="txt">The string to convert to an object.</param>
<returns>
The object converted from a string or <c>null</c> when the
conversion failed.
</returns>
<remarks>
<para>
Converts a string to an object. Uses the converter registry to try
to convert the string value into the specified target type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)">
<summary>
Checks if there is an appropriate type conversion from the source type to the target type.
</summary>
<param name="sourceType">The type to convert from.</param>
<param name="targetType">The type to convert to.</param>
<returns><c>true</c> if there is a conversion from the source type to the target type.</returns>
<remarks>
Checks if there is an appropriate type conversion from the source type to the target type.
<para>
</para>
</remarks>
</member>
<member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)">
<summary>
Converts an object to the target type.
</summary>
<param name="sourceInstance">The object to convert to the target type.</param>
<param name="targetType">The type to convert to.</param>
<returns>The converted object.</returns>
<remarks>
<para>
Converts an object to the target type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)">
<summary>
Instantiates an object given a class name.
</summary>
<param name="className">The fully qualified class name of the object to instantiate.</param>
<param name="superClass">The class to which the new object should belong.</param>
<param name="defaultValue">The object to return in case of non-fulfillment.</param>
<returns>
An instance of the <paramref name="className"/> or <paramref name="defaultValue"/>
if the object could not be instantiated.
</returns>
<remarks>
<para>
Checks that the <paramref name="className"/> is a subclass of
<paramref name="superClass"/>. If that test fails or the object could
not be instantiated, then <paramref name="defaultValue"/> is returned.
</para>
</remarks>
</member>
<member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)">
<summary>
Performs variable substitution in string <paramref name="value"/> from the
values of keys found in <paramref name="props"/>.
</summary>
<param name="value">The string on which variable substitution is performed.</param>
<param name="props">The dictionary to use to lookup variables.</param>
<returns>The result of the substitutions.</returns>
<remarks>
<para>
The variable substitution delimiters are <b>${</b> and <b>}</b>.
</para>
<para>
For example, if props contains <c>key=value</c>, then the call
</para>
<para>
<code lang="C#">
string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
</code>
</para>
<para>
will set the variable <c>s</c> to "Value of key is value.".
</para>
<para>
If no value could be found for the specified key, then substitution
defaults to an empty string.
</para>
<para>
For example, if system properties contains no value for the key
"nonExistentKey", then the call
</para>
<para>
<code lang="C#">
string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
</code>
</para>
<para>
will set <s>s</s> to "Value of nonExistentKey is []".
</para>
<para>
An Exception is thrown if <paramref name="value"/> contains a start
delimiter "${" which is not balanced by a stop delimiter "}".
</para>
</remarks>
</member>
<member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)">
<summary>
Converts the string representation of the name or numeric value of one or
more enumerated constants to an equivalent enumerated object.
</summary>
<param name="enumType">The type to convert to.</param>
<param name="value">The enum string value.</param>
<param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param>
<returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns>
</member>
<member name="F:log4net.Util.OptionConverter.declaringType">
<summary>
The fully qualified type of the OptionConverter class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.PatternParser">
<summary>
Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class
is delegated to the PatternParser class.
</summary>
<remarks>
<para>
The <c>PatternParser</c> processes a pattern string and
returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.PatternParser.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="pattern">The pattern to parse.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.PatternParser"/> class
with the specified pattern string.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternParser.Parse">
<summary>
Parses the pattern into a chain of pattern converters.
</summary>
<returns>The head of a chain of pattern converters.</returns>
<remarks>
<para>
Parses the pattern into a chain of pattern converters.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternParser.BuildCache">
<summary>
Build the unified cache of converters from the static and instance maps
</summary>
<returns>the list of all the converter names</returns>
<remarks>
<para>
Build the unified cache of converters from the static and instance maps
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])">
<summary>
Internal method to parse the specified pattern to find specified matches
</summary>
<param name="pattern">the pattern to parse</param>
<param name="matches">the converter names to match in the pattern</param>
<remarks>
<para>
The matches param must be sorted such that longer strings come before shorter ones.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)">
<summary>
Process a parsed literal
</summary>
<param name="text">the literal text</param>
</member>
<member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)">
<summary>
Process a parsed converter pattern
</summary>
<param name="converterName">the name of the converter</param>
<param name="option">the optional option for the converter</param>
<param name="formattingInfo">the formatting info for the converter</param>
</member>
<member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)">
<summary>
Resets the internal state of the parser and adds the specified pattern converter
to the chain.
</summary>
<param name="pc">The pattern converter to add.</param>
</member>
<member name="F:log4net.Util.PatternParser.m_head">
<summary>
The first pattern converter in the chain
</summary>
</member>
<member name="F:log4net.Util.PatternParser.m_tail">
<summary>
the last pattern converter in the chain
</summary>
</member>
<member name="F:log4net.Util.PatternParser.m_pattern">
<summary>
The pattern
</summary>
</member>
<member name="F:log4net.Util.PatternParser.m_patternConverters">
<summary>
Internal map of converter identifiers to converter types
</summary>
<remarks>
<para>
This map overrides the static s_globalRulesRegistry map.
</para>
</remarks>
</member>
<member name="F:log4net.Util.PatternParser.declaringType">
<summary>
The fully qualified type of the PatternParser class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Util.PatternParser.PatternConverters">
<summary>
Get the converter registry used by this parser
</summary>
<value>
The converter registry used by this parser
</value>
<remarks>
<para>
Get the converter registry used by this parser
</para>
</remarks>
</member>
<member name="T:log4net.Util.PatternParser.StringLengthComparer">
<summary>
Sort strings by length
</summary>
<remarks>
<para>
<see cref="T:System.Collections.IComparer"/> that orders strings by string length.
The longest strings are placed first
</para>
</remarks>
</member>
<member name="T:log4net.Util.PatternString">
<summary>
This class implements a patterned string.
</summary>
<remarks>
<para>
This string has embedded patterns that are resolved and expanded
when the string is formatted.
</para>
<para>
This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
in that it accepts a pattern and renders it to a string. Unlike the
<see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
of the process in general.
</para>
<para>
The recognized conversion pattern names are:
</para>
<list type="table">
<listheader>
<term>Conversion Pattern Name</term>
<description>Effect</description>
</listheader>
<item>
<term>appdomain</term>
<description>
<para>
Used to output the friendly name of the current AppDomain.
</para>
</description>
</item>
<item>
<term>date</term>
<description>
<para>
Used to output the current date and time in the local time zone.
To output the date in universal time use the <c>%utcdate</c> pattern.
The date conversion
specifier may be followed by a <i>date format specifier</i> enclosed
between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
<b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
given then ISO8601 format is
assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
</para>
<para>
The date format specifier admits the same syntax as the
time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
</para>
<para>
For better results it is recommended to use the log4net date
formatters. These can be specified using one of the strings
"ABSOLUTE", "DATE" and "ISO8601" for specifying
<see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
<see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
<b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
</para>
<para>
These dedicated date formatters perform significantly
better than <see cref="M:DateTime.ToString(string)"/>.
</para>
</description>
</item>
<item>
<term>env</term>
<description>
<para>
Used to output the a specific environment variable. The key to
lookup must be specified within braces and directly following the
pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value
of the <c>COMPUTERNAME</c> environment variable.
</para>
<para>
The <c>env</c> pattern is not supported on the .NET Compact Framework.
</para>
</description>
</item>
<item>
<term>identity</term>
<description>
<para>
Used to output the user name for the currently active user
(Principal.Identity.Name).
</para>
</description>
</item>
<item>
<term>newline</term>
<description>
<para>
Outputs the platform dependent line separator character or
characters.
</para>
<para>
This conversion pattern name offers the same performance as using
non-portable line separator strings such as "\n", or "\r\n".
Thus, it is the preferred way of specifying a line separator.
</para>
</description>
</item>
<item>
<term>processid</term>
<description>
<para>
Used to output the system process ID for the current process.
</para>
</description>
</item>
<item>
<term>property</term>
<description>
<para>
Used to output a specific context property. The key to
lookup must be specified within braces and directly following the
pattern specifier, e.g. <b>%property{user}</b> would include the value
from the property that is keyed by the string 'user'. Each property value
that is to be included in the log must be specified separately.
Properties are stored in logging contexts. By default
the <c>log4net:HostName</c> property is set to the name of machine on
which the event was originally logged.
</para>
<para>
If no key is specified, e.g. <b>%property</b> then all the keys and their
values are printed in a comma separated list.
</para>
<para>
The properties of an event are combined from a number of different
contexts. These are listed below in the order in which they are searched.
</para>
<list type="definition">
<item>
<term>the thread properties</term>
<description>
The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
thread. These properties are shared by all events logged on this thread.
</description>
</item>
<item>
<term>the global properties</term>
<description>
The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
properties are shared by all the threads in the AppDomain.
</description>
</item>
</list>
</description>
</item>
<item>
<term>random</term>
<description>
<para>
Used to output a random string of characters. The string is made up of
uppercase letters and numbers. By default the string is 4 characters long.
The length of the string can be specified within braces directly following the
pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string.
</para>
</description>
</item>
<item>
<term>username</term>
<description>
<para>
Used to output the WindowsIdentity for the currently
active user.
</para>
</description>
</item>
<item>
<term>utcdate</term>
<description>
<para>
Used to output the date of the logging event in universal time.
The date conversion
specifier may be followed by a <i>date format specifier</i> enclosed
between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
<b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
given then ISO8601 format is
assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
</para>
<para>
The date format specifier admits the same syntax as the
time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
</para>
<para>
For better results it is recommended to use the log4net date
formatters. These can be specified using one of the strings
"ABSOLUTE", "DATE" and "ISO8601" for specifying
<see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
<see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
<b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
</para>
<para>
These dedicated date formatters perform significantly
better than <see cref="M:DateTime.ToString(string)"/>.
</para>
</description>
</item>
<item>
<term>%</term>
<description>
<para>
The sequence %% outputs a single percent sign.
</para>
</description>
</item>
</list>
<para>
Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
instance using <see cref="M:AddConverter(ConverterInfo)"/> or
<see cref="M:AddConverter(string, Type)"/>.
</para>
<para>
See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
<i>format modifiers</i> supported by the patterns.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Util.PatternString.s_globalRulesRegistry">
<summary>
Internal map of converter identifiers to converter types.
</summary>
</member>
<member name="F:log4net.Util.PatternString.m_pattern">
<summary>
the pattern
</summary>
</member>
<member name="F:log4net.Util.PatternString.m_head">
<summary>
the head of the pattern converter chain
</summary>
</member>
<member name="F:log4net.Util.PatternString.m_instanceRulesRegistry">
<summary>
patterns defined on this PatternString only
</summary>
</member>
<member name="M:log4net.Util.PatternString.#cctor">
<summary>
Initialize the global registry
</summary>
</member>
<member name="M:log4net.Util.PatternString.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Initialize a new instance of <see cref="T:log4net.Util.PatternString"/>
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternString.#ctor(System.String)">
<summary>
Constructs a PatternString
</summary>
<param name="pattern">The pattern to use with this PatternString</param>
<remarks>
<para>
Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternString.ActivateOptions">
<summary>
Initialize object options
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)">
<summary>
Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern
</summary>
<param name="pattern">the pattern to parse</param>
<returns>The <see cref="T:log4net.Util.PatternParser"/></returns>
<remarks>
<para>
Returns PatternParser used to parse the conversion string. Subclasses
may override this to return a subclass of PatternParser which recognize
custom conversion pattern name.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)">
<summary>
Produces a formatted string as specified by the conversion pattern.
</summary>
<param name="writer">The TextWriter to write the formatted event to</param>
<remarks>
<para>
Format the pattern to the <paramref name="writer"/>.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternString.Format">
<summary>
Format the pattern as a string
</summary>
<returns>the pattern formatted as a string</returns>
<remarks>
<para>
Format the pattern to a string.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)">
<summary>
Add a converter to this PatternString
</summary>
<param name="converterInfo">the converter info</param>
<remarks>
<para>
This version of the method is used by the configurator.
Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)">
<summary>
Add a converter to this PatternString
</summary>
<param name="name">the name of the conversion pattern for this converter</param>
<param name="type">the type of the converter</param>
<remarks>
<para>
Add a converter to this PatternString
</para>
</remarks>
</member>
<member name="P:log4net.Util.PatternString.ConversionPattern">
<summary>
Gets or sets the pattern formatting string
</summary>
<value>
The pattern formatting string
</value>
<remarks>
<para>
The <b>ConversionPattern</b> option. This is the string which
controls formatting and consists of a mix of literal content and
conversion specifiers.
</para>
</remarks>
</member>
<member name="T:log4net.Util.PropertiesDictionary">
<summary>
String keyed object map.
</summary>
<remarks>
<para>
While this collection is serializable only member
objects that are serializable will
be serialized along with this collection.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="T:log4net.Util.ReadOnlyPropertiesDictionary">
<summary>
String keyed object map that is read only.
</summary>
<remarks>
<para>
This collection is readonly and cannot be modified.
</para>
<para>
While this collection is serializable only member
objects that are serializable will
be serialized along with this collection.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable">
<summary>
The Hashtable used to store the properties data
</summary>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
<summary>
Copy Constructor
</summary>
<param name="propertiesDictionary">properties to copy</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Deserialization constructor
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class
with serialized data.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys">
<summary>
Gets the key names.
</summary>
<returns>An array of all the keys.</returns>
<remarks>
<para>
Gets the key names.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)">
<summary>
Test if the dictionary contains a specified key
</summary>
<param name="key">the key to look for</param>
<returns>true if the dictionary contains the specified key</returns>
<remarks>
<para>
Test if the dictionary contains a specified key
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
<param name="context">The destination for this serialization.</param>
<remarks>
<para>
Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
<summary>
See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
</summary>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
<summary>
See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
</summary>
<param name="key"></param>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
<summary>
See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
</summary>
<param name="key"></param>
<returns></returns>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear">
<summary>
Remove all properties from the properties collection
</summary>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
<summary>
See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
</summary>
<param name="key"></param>
<param name="value"></param>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
<summary>
See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
</summary>
<param name="array"></param>
<param name="index"></param>
</member>
<member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
<summary>
See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
</summary>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)">
<summary>
Gets or sets the value of the property with the specified key.
</summary>
<value>
The value of the property with the specified key.
</value>
<param name="key">The key of the property to get or set.</param>
<remarks>
<para>
The property value will only be serialized if it is serializable.
If it cannot be serialized it will be silently ignored if
a serialization operation is performed.
</para>
</remarks>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable">
<summary>
The hashtable used to store the properties
</summary>
<value>
The internal collection used to store the properties
</value>
<remarks>
<para>
The hashtable used to store the properties
</para>
</remarks>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
<summary>
See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
</summary>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
<summary>
See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
</summary>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values">
<summary>
See <see cref="P:System.Collections.IDictionary.Values"/>
</summary>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys">
<summary>
See <see cref="P:System.Collections.IDictionary.Keys"/>
</summary>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
<summary>
See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
</summary>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized">
<summary>
See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
</summary>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count">
<summary>
The number of properties in this collection
</summary>
</member>
<member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot">
<summary>
See <see cref="P:System.Collections.ICollection.SyncRoot"/>
</summary>
</member>
<member name="M:log4net.Util.PropertiesDictionary.#ctor">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
<summary>
Constructor
</summary>
<param name="propertiesDictionary">properties to copy</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class
with serialized data.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<remarks>
<para>
Because this class is sealed the serialization constructor is private.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)">
<summary>
Remove the entry with the specified key from this dictionary
</summary>
<param name="key">the key for the entry to remove</param>
<remarks>
<para>
Remove the entry with the specified key from this dictionary
</para>
</remarks>
</member>
<member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
<summary>
See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
</summary>
<returns>an enumerator</returns>
<remarks>
<para>
Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
<summary>
See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
</summary>
<param name="key">the key to remove</param>
<remarks>
<para>
Remove the entry with the specified key from this dictionary
</para>
</remarks>
</member>
<member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
<summary>
See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
</summary>
<param name="key">the key to lookup in the collection</param>
<returns><c>true</c> if the collection contains the specified key</returns>
<remarks>
<para>
Test if this collection contains a specified key.
</para>
</remarks>
</member>
<member name="M:log4net.Util.PropertiesDictionary.Clear">
<summary>
Remove all properties from the properties collection
</summary>
<remarks>
<para>
Remove all properties from the properties collection
</para>
</remarks>
</member>
<member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
<summary>
See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
</summary>
<param name="key">the key</param>
<param name="value">the value to store for the key</param>
<remarks>
<para>
Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
</member>
<member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
<summary>
See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
</summary>
<param name="array"></param>
<param name="index"></param>
</member>
<member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
<summary>
See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
</summary>
</member>
<member name="P:log4net.Util.PropertiesDictionary.Item(System.String)">
<summary>
Gets or sets the value of the property with the specified key.
</summary>
<value>
The value of the property with the specified key.
</value>
<param name="key">The key of the property to get or set.</param>
<remarks>
<para>
The property value will only be serialized if it is serializable.
If it cannot be serialized it will be silently ignored if
a serialization operation is performed.
</para>
</remarks>
</member>
<member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
<summary>
See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
</summary>
<value>
<c>false</c>
</value>
<remarks>
<para>
This collection is modifiable. This property always
returns <c>false</c>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
<summary>
See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
</summary>
<value>
The value for the key specified.
</value>
<remarks>
<para>
Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
</member>
<member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values">
<summary>
See <see cref="P:System.Collections.IDictionary.Values"/>
</summary>
</member>
<member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys">
<summary>
See <see cref="P:System.Collections.IDictionary.Keys"/>
</summary>
</member>
<member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
<summary>
See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
</summary>
</member>
<member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized">
<summary>
See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
</summary>
</member>
<member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot">
<summary>
See <see cref="P:System.Collections.ICollection.SyncRoot"/>
</summary>
</member>
<member name="T:log4net.Util.PropertyEntry">
<summary>
A class to hold the key and data for a property set in the config file
</summary>
<remarks>
<para>
A class to hold the key and data for a property set in the config file
</para>
</remarks>
</member>
<member name="M:log4net.Util.PropertyEntry.ToString">
<summary>
Override <c>Object.ToString</c> to return sensible debug info
</summary>
<returns>string info about this object</returns>
</member>
<member name="P:log4net.Util.PropertyEntry.Key">
<summary>
Property Key
</summary>
<value>
Property Key
</value>
<remarks>
<para>
Property Key.
</para>
</remarks>
</member>
<member name="P:log4net.Util.PropertyEntry.Value">
<summary>
Property Value
</summary>
<value>
Property Value
</value>
<remarks>
<para>
Property Value.
</para>
</remarks>
</member>
<member name="T:log4net.Util.ProtectCloseTextWriter">
<summary>
A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message
</summary>
<remarks>
<para>
This writer is used in special cases where it is necessary
to protect a writer from being closed by a client.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)">
<summary>
Constructor
</summary>
<param name="writer">the writer to actually write to</param>
<remarks>
<para>
Create a new ProtectCloseTextWriter using a writer
</para>
</remarks>
</member>
<member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)">
<summary>
Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
</summary>
<param name="writer">the writer to attach to</param>
<remarks>
<para>
Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
</para>
</remarks>
</member>
<member name="M:log4net.Util.ProtectCloseTextWriter.Close">
<summary>
Does not close the underlying output writer.
</summary>
<remarks>
<para>
Does not close the underlying output writer.
This method does nothing.
</para>
</remarks>
</member>
<member name="T:log4net.Util.ReaderWriterLock">
<summary>
Defines a lock that supports single writers and multiple readers
</summary>
<remarks>
<para>
<c>ReaderWriterLock</c> is used to synchronize access to a resource.
At any given time, it allows either concurrent read access for
multiple threads, or write access for a single thread. In a
situation where a resource is changed infrequently, a
<c>ReaderWriterLock</c> provides better throughput than a simple
one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>.
</para>
<para>
If a platform does not support a <c>System.Threading.ReaderWriterLock</c>
implementation then all readers and writers are serialized. Therefore
the caller must not rely on multiple simultaneous readers.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.ReaderWriterLock.#ctor">
<summary>
Constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock">
<summary>
Acquires a reader lock
</summary>
<remarks>
<para>
<see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer
lock, or if at least one thread is waiting for the writer lock.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock">
<summary>
Decrements the lock count
</summary>
<remarks>
<para>
<see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count
reaches zero, the lock is released.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock">
<summary>
Acquires the writer lock
</summary>
<remarks>
<para>
This method blocks if another thread has a reader lock or writer lock.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock">
<summary>
Decrements the lock count on the writer lock
</summary>
<remarks>
<para>
ReleaseWriterLock decrements the writer lock count.
When the count reaches zero, the writer lock is released.
</para>
</remarks>
</member>
<member name="T:log4net.Util.ReusableStringWriter">
<summary>
A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused
</summary>
<remarks>
<para>
A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused.
This uses a single buffer for string operations.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)">
<summary>
Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
</summary>
<param name="formatProvider">the format provider to use</param>
<remarks>
<para>
Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)">
<summary>
Override Dispose to prevent closing of writer
</summary>
<param name="disposing">flag</param>
<remarks>
<para>
Override Dispose to prevent closing of writer
</para>
</remarks>
</member>
<member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)">
<summary>
Reset this string writer so that it can be reused.
</summary>
<param name="maxCapacity">the maximum buffer capacity before it is trimmed</param>
<param name="defaultSize">the default size to make the buffer</param>
<remarks>
<para>
Reset this string writer so that it can be reused.
The internal buffers are cleared and reset.
</para>
</remarks>
</member>
<member name="T:log4net.Util.SystemInfo">
<summary>
Utility class for system specific information.
</summary>
<remarks>
<para>
Utility class of static methods for system specific information.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
<author>Alexey Solofnenko</author>
</member>
<member name="M:log4net.Util.SystemInfo.#ctor">
<summary>
Private constructor to prevent instances.
</summary>
<remarks>
<para>
Only static methods are exposed from this type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.#cctor">
<summary>
Initialize default values for private static fields.
</summary>
<remarks>
<para>
Only static methods are exposed from this type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
<summary>
Gets the assembly location path for the specified assembly.
</summary>
<param name="myAssembly">The assembly to get the location for.</param>
<returns>The location of the assembly.</returns>
<remarks>
<para>
This method does not guarantee to return the correct path
to the assembly. If only tries to give an indication as to
where the assembly was loaded from.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)">
<summary>
Gets the fully qualified name of the <see cref="T:System.Type"/>, including
the name of the assembly from which the <see cref="T:System.Type"/> was
loaded.
</summary>
<param name="type">The <see cref="T:System.Type"/> to get the fully qualified name for.</param>
<returns>The fully qualified name for the <see cref="T:System.Type"/>.</returns>
<remarks>
<para>
This is equivalent to the <c>Type.AssemblyQualifiedName</c> property,
but this method works on the .NET Compact Framework 1.0 as well as
the full .NET runtime.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)">
<summary>
Gets the short name of the <see cref="T:System.Reflection.Assembly"/>.
</summary>
<param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the name for.</param>
<returns>The short name of the <see cref="T:System.Reflection.Assembly"/>.</returns>
<remarks>
<para>
The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName"/>
without the version, culture, or public key. i.e. it is just the
assembly's file name without the extension.
</para>
<para>
Use this rather than <c>Assembly.GetName().Name</c> because that
is not available on the Compact Framework.
</para>
<para>
Because of a FileIOPermission security demand we cannot do
the obvious Assembly.GetName().Name. We are allowed to get
the <see cref="P:System.Reflection.Assembly.FullName"/> of the assembly so we
start from there and strip out just the assembly name.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)">
<summary>
Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
</summary>
<param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the file name for.</param>
<returns>The file name of the assembly.</returns>
<remarks>
<para>
Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)">
<summary>
Loads the type specified in the type string.
</summary>
<param name="relativeType">A sibling type to use to load the type.</param>
<param name="typeName">The name of the type to load.</param>
<param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
<param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
<returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
<remarks>
<para>
If the type name is fully qualified, i.e. if contains an assembly name in
the type name, the type will be loaded from the system using
<see cref="M:Type.GetType(string,bool)"/>.
</para>
<para>
If the type name is not fully qualified, it will be loaded from the assembly
containing the specified relative type. If the type is not found in the assembly
then all the loaded assemblies will be searched for the type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.String,System.Boolean,System.Boolean)">
<summary>
Loads the type specified in the type string.
</summary>
<param name="typeName">The name of the type to load.</param>
<param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
<param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
<returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
<remarks>
<para>
If the type name is fully qualified, i.e. if contains an assembly name in
the type name, the type will be loaded from the system using
<see cref="M:Type.GetType(string,bool)"/>.
</para>
<para>
If the type name is not fully qualified it will be loaded from the
assembly that is directly calling this method. If the type is not found
in the assembly then all the loaded assemblies will be searched for the type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)">
<summary>
Loads the type specified in the type string.
</summary>
<param name="relativeAssembly">An assembly to load the type from.</param>
<param name="typeName">The name of the type to load.</param>
<param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
<param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
<returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
<remarks>
<para>
If the type name is fully qualified, i.e. if contains an assembly name in
the type name, the type will be loaded from the system using
<see cref="M:Type.GetType(string,bool)"/>.
</para>
<para>
If the type name is not fully qualified it will be loaded from the specified
assembly. If the type is not found in the assembly then all the loaded assemblies
will be searched for the type.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.NewGuid">
<summary>
Generate a new guid
</summary>
<returns>A new Guid</returns>
<remarks>
<para>
Generate a new guid
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)">
<summary>
Create an <see cref="T:System.ArgumentOutOfRangeException"/>
</summary>
<param name="parameterName">The name of the parameter that caused the exception</param>
<param name="actualValue">The value of the argument that causes this exception</param>
<param name="message">The message that describes the error</param>
<returns>the ArgumentOutOfRangeException object</returns>
<remarks>
<para>
Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class
with a specified error message, the parameter name, and the value
of the argument.
</para>
<para>
The Compact Framework does not support the 3 parameter constructor for the
<see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an
implementation that works for all platforms.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)">
<summary>
Parse a string into an <see cref="T:System.Int32"/> value
</summary>
<param name="s">the string to parse</param>
<param name="val">out param where the parsed value is placed</param>
<returns><c>true</c> if the string was able to be parsed into an integer</returns>
<remarks>
<para>
Attempts to parse the string into an integer. If the string cannot
be parsed then this method returns <c>false</c>. The method does not throw an exception.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)">
<summary>
Parse a string into an <see cref="T:System.Int64"/> value
</summary>
<param name="s">the string to parse</param>
<param name="val">out param where the parsed value is placed</param>
<returns><c>true</c> if the string was able to be parsed into an integer</returns>
<remarks>
<para>
Attempts to parse the string into an integer. If the string cannot
be parsed then this method returns <c>false</c>. The method does not throw an exception.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)">
<summary>
Parse a string into an <see cref="T:System.Int16"/> value
</summary>
<param name="s">the string to parse</param>
<param name="val">out param where the parsed value is placed</param>
<returns><c>true</c> if the string was able to be parsed into an integer</returns>
<remarks>
<para>
Attempts to parse the string into an integer. If the string cannot
be parsed then this method returns <c>false</c>. The method does not throw an exception.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
<summary>
Lookup an application setting
</summary>
<param name="key">the application settings key to lookup</param>
<returns>the value for the key, or <c>null</c></returns>
<remarks>
<para>
Configuration APIs are not supported under the Compact Framework
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
<summary>
Convert a path into a fully qualified local file path.
</summary>
<param name="path">The path to convert.</param>
<returns>The fully qualified path.</returns>
<remarks>
<para>
Converts the path specified to a fully
qualified path. If the path is relative it is
taken as relative from the application base
directory.
</para>
<para>
The path specified must be a local file path, a URI is not supported.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
<summary>
Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
</summary>
<returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
<remarks>
<para>
The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
</para>
</remarks>
</member>
<member name="F:log4net.Util.SystemInfo.EmptyTypes">
<summary>
Gets an empty array of types.
</summary>
<remarks>
<para>
The <c>Type.EmptyTypes</c> field is not available on
the .NET Compact Framework 1.0.
</para>
</remarks>
</member>
<member name="F:log4net.Util.SystemInfo.declaringType">
<summary>
The fully qualified type of the SystemInfo class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="F:log4net.Util.SystemInfo.s_hostName">
<summary>
Cache the host name for the current machine
</summary>
</member>
<member name="F:log4net.Util.SystemInfo.s_appFriendlyName">
<summary>
Cache the application friendly name
</summary>
</member>
<member name="F:log4net.Util.SystemInfo.s_nullText">
<summary>
Text to output when a <c>null</c> is encountered.
</summary>
</member>
<member name="F:log4net.Util.SystemInfo.s_notAvailableText">
<summary>
Text to output when an unsupported feature is requested.
</summary>
</member>
<member name="F:log4net.Util.SystemInfo.s_processStartTime">
<summary>
Start time for the current process.
</summary>
</member>
<member name="P:log4net.Util.SystemInfo.NewLine">
<summary>
Gets the system dependent line terminator.
</summary>
<value>
The system dependent line terminator.
</value>
<remarks>
<para>
Gets the system dependent line terminator.
</para>
</remarks>
</member>
<member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory">
<summary>
Gets the base directory for this <see cref="T:System.AppDomain"/>.
</summary>
<value>The base directory path for the current <see cref="T:System.AppDomain"/>.</value>
<remarks>
<para>
Gets the base directory for this <see cref="T:System.AppDomain"/>.
</para>
<para>
The value returned may be either a local file path or a URI.
</para>
</remarks>
</member>
<member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation">
<summary>
Gets the path to the configuration file for the current <see cref="T:System.AppDomain"/>.
</summary>
<value>The path to the configuration file for the current <see cref="T:System.AppDomain"/>.</value>
<remarks>
<para>
The .NET Compact Framework 1.0 does not have a concept of a configuration
file. For this runtime, we use the entry assembly location as the root for
the configuration file name.
</para>
<para>
The value returned may be either a local file path or a URI.
</para>
</remarks>
</member>
<member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation">
<summary>
Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
</summary>
<value>The path to the entry assembly.</value>
<remarks>
<para>
Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
</para>
</remarks>
</member>
<member name="P:log4net.Util.SystemInfo.CurrentThreadId">
<summary>
Gets the ID of the current thread.
</summary>
<value>The ID of the current thread.</value>
<remarks>
<para>
On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method
is used to obtain the thread ID for the current thread. This is the
operating system ID for the thread.
</para>
<para>
On the .NET Compact Framework 1.0 it is not possible to get the
operating system thread ID for the current thread. The native method
<c>GetCurrentThreadId</c> is implemented inline in a header file
and cannot be called.
</para>
<para>
On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
gives a stable id unrelated to the operating system thread ID which may
change if the runtime is using fibers.
</para>
</remarks>
</member>
<member name="P:log4net.Util.SystemInfo.HostName">
<summary>
Get the host name or machine name for the current machine
</summary>
<value>
The hostname or machine name
</value>
<remarks>
<para>
Get the host name or machine name for the current machine
</para>
<para>
The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or
the machine name (<c>Environment.MachineName</c>) for
the current machine, or if neither of these are available
then <c>NOT AVAILABLE</c> is returned.
</para>
</remarks>
</member>
<member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName">
<summary>
Get this application's friendly name
</summary>
<value>
The friendly name of this application as a string
</value>
<remarks>
<para>
If available the name of the application is retrieved from
the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>.
</para>
<para>
Otherwise the file name of the entry assembly is used.
</para>
</remarks>
</member>
<member name="P:log4net.Util.SystemInfo.ProcessStartTime">
<summary>
Get the start time for the current process.
</summary>
<remarks>
<para>
This is the time at which the log4net library was loaded into the
AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
this is not the start time for the current process.
</para>
<para>
The log4net library should be loaded by an application early during its
startup, therefore this start time should be a good approximation for
the actual start time.
</para>
<para>
Note that AppDomains may be loaded and unloaded within the
same process without the process terminating, however this start time
will be set per AppDomain.
</para>
</remarks>
</member>
<member name="P:log4net.Util.SystemInfo.NullText">
<summary>
Text to output when a <c>null</c> is encountered.
</summary>
<remarks>
<para>
Use this value to indicate a <c>null</c> has been encountered while
outputting a string representation of an item.
</para>
<para>
The default value is <c>(null)</c>. This value can be overridden by specifying
a value for the <c>log4net.NullText</c> appSetting in the application's
.config file.
</para>
</remarks>
</member>
<member name="P:log4net.Util.SystemInfo.NotAvailableText">
<summary>
Text to output when an unsupported feature is requested.
</summary>
<remarks>
<para>
Use this value when an unsupported feature is requested.
</para>
<para>
The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
.config file.
</para>
</remarks>
</member>
<member name="T:log4net.Util.SystemStringFormat">
<summary>
Utility class that represents a format string.
</summary>
<remarks>
<para>
Utility class that represents a format string.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
<summary>
Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
<param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
<param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
</member>
<member name="M:log4net.Util.SystemStringFormat.ToString">
<summary>
Format the string and arguments
</summary>
<returns>the formatted string</returns>
</member>
<member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>
Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
A specified parameter supplies culture-specific formatting information.
</summary>
<param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
<param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
<param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
<returns>
A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
</returns>
<remarks>
<para>
This method does not throw exceptions. If an exception thrown while formatting the result the
exception and arguments are returned in the result string.
</para>
</remarks>
</member>
<member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
<summary>
Process an error during StringFormat
</summary>
</member>
<member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
<summary>
Dump the contents of an array into a string builder
</summary>
</member>
<member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
<summary>
Dump an object to a string
</summary>
</member>
<member name="F:log4net.Util.SystemStringFormat.declaringType">
<summary>
The fully qualified type of the SystemStringFormat class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="T:log4net.Util.ThreadContextProperties">
<summary>
Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
</summary>
<remarks>
<para>
Class implements a collection of properties that is specific to each thread.
The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Util.ThreadContextProperties._dictionary">
<summary>
Each thread will automatically have its instance.
</summary>
</member>
<member name="M:log4net.Util.ThreadContextProperties.#ctor">
<summary>
Internal constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)">
<summary>
Remove a property
</summary>
<param name="key">the key for the entry to remove</param>
<remarks>
<para>
Remove a property
</para>
</remarks>
</member>
<member name="M:log4net.Util.ThreadContextProperties.GetKeys">
<summary>
Get the keys stored in the properties.
</summary>
<para>
Gets the keys stored in the properties.
</para>
<returns>a set of the defined keys</returns>
</member>
<member name="M:log4net.Util.ThreadContextProperties.Clear">
<summary>
Clear all properties
</summary>
<remarks>
<para>
Clear all properties
</para>
</remarks>
</member>
<member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)">
<summary>
Get the <c>PropertiesDictionary</c> for this thread.
</summary>
<param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param>
<returns>the properties for this thread</returns>
<remarks>
<para>
The collection returned is only to be used on the calling thread. If the
caller needs to share the collection between different threads then the
caller must clone the collection before doing so.
</para>
</remarks>
</member>
<member name="P:log4net.Util.ThreadContextProperties.Item(System.String)">
<summary>
Gets or sets the value of a property
</summary>
<value>
The value for the property with the specified key
</value>
<remarks>
<para>
Gets or sets the value of a property
</para>
</remarks>
</member>
<member name="T:log4net.Util.ThreadContextStack">
<summary>
Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
</summary>
<remarks>
<para>
Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="F:log4net.Util.ThreadContextStack.m_stack">
<summary>
The stack store.
</summary>
</member>
<member name="M:log4net.Util.ThreadContextStack.#ctor">
<summary>
Internal constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack"/> class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ThreadContextStack.Clear">
<summary>
Clears all the contextual information held in this stack.
</summary>
<remarks>
<para>
Clears all the contextual information held in this stack.
Only call this if you think that this tread is being reused after
a previous call execution which may not have completed correctly.
You do not need to use this method if you always guarantee to call
the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
syntax.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ThreadContextStack.Pop">
<summary>
Removes the top context from this stack.
</summary>
<returns>The message in the context that was removed from the top of this stack.</returns>
<remarks>
<para>
Remove the top context from this stack, and return
it to the caller. If this stack is empty then an
empty string (not <see langword="null"/>) is returned.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ThreadContextStack.Push(System.String)">
<summary>
Pushes a new context message into this stack.
</summary>
<param name="message">The new context message.</param>
<returns>
An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
</returns>
<remarks>
<para>
Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
is returned that can be used to clean up this stack. This
can be easily combined with the <c>using</c> keyword to scope the
context.
</para>
</remarks>
<example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
<code lang="C#">
using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
{
log.Warn("This should have an ThreadContext Stack message");
}
</code>
</example>
</member>
<member name="M:log4net.Util.ThreadContextStack.GetFullMessage">
<summary>
Gets the current context information for this stack.
</summary>
<returns>The current context information.</returns>
</member>
<member name="M:log4net.Util.ThreadContextStack.ToString">
<summary>
Gets the current context information for this stack.
</summary>
<returns>Gets the current context information</returns>
<remarks>
<para>
Gets the current context information for this stack.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
<summary>
Get a portable version of this object
</summary>
<returns>the portable instance of this object</returns>
<remarks>
<para>
Get a cross thread portable version of this object
</para>
</remarks>
</member>
<member name="P:log4net.Util.ThreadContextStack.Count">
<summary>
The number of messages in the stack
</summary>
<value>
The current number of messages in the stack
</value>
<remarks>
<para>
The current number of messages in the stack. That is
the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called
minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called.
</para>
</remarks>
</member>
<member name="P:log4net.Util.ThreadContextStack.InternalStack">
<summary>
Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/>
</summary>
<value>The internal storage stack</value>
<remarks>
<para>
This property is provided only to support backward compatability
of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
be modified.
</para>
</remarks>
</member>
<member name="T:log4net.Util.ThreadContextStack.StackFrame">
<summary>
Inner class used to represent a single context frame in the stack.
</summary>
<remarks>
<para>
Inner class used to represent a single context frame in the stack.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)">
<summary>
Constructor
</summary>
<param name="message">The message for this context.</param>
<param name="parent">The parent context in the chain.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame"/> class
with the specified message and parent context.
</para>
</remarks>
</member>
<member name="P:log4net.Util.ThreadContextStack.StackFrame.Message">
<summary>
Get the message.
</summary>
<value>The message.</value>
<remarks>
<para>
Get the message.
</para>
</remarks>
</member>
<member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage">
<summary>
Gets the full text of the context down to the root level.
</summary>
<value>
The full text of the context down to the root level.
</value>
<remarks>
<para>
Gets the full text of the context down to the root level.
</para>
</remarks>
</member>
<member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame">
<summary>
Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method.
</summary>
<remarks>
<para>
This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
</para>
</remarks>
</member>
<member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack">
<summary>
The ThreadContextStack internal stack
</summary>
</member>
<member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth">
<summary>
The depth to trim the stack to when this instance is disposed
</summary>
</member>
<member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)">
<summary>
Constructor
</summary>
<param name="frameStack">The internal stack used by the ThreadContextStack.</param>
<param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame"/> class with
the specified stack and return depth.
</para>
</remarks>
</member>
<member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose">
<summary>
Returns the stack to the correct depth.
</summary>
<remarks>
<para>
Returns the stack to the correct depth.
</para>
</remarks>
</member>
<member name="T:log4net.Util.ThreadContextStacks">
<summary>
Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
</summary>
<remarks>
<para>
Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
</para>
</remarks>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)">
<summary>
Internal constructor
</summary>
<remarks>
<para>
Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks"/> class.
</para>
</remarks>
</member>
<member name="F:log4net.Util.ThreadContextStacks.declaringType">
<summary>
The fully qualified type of the ThreadContextStacks class.
</summary>
<remarks>
Used by the internal logger to record the Type of the
log message.
</remarks>
</member>
<member name="P:log4net.Util.ThreadContextStacks.Item(System.String)">
<summary>
Gets the named thread context stack
</summary>
<value>
The named stack
</value>
<remarks>
<para>
Gets the named thread context stack
</para>
</remarks>
</member>
<member name="T:log4net.Util.Transform">
<summary>
Utility class for transforming strings.
</summary>
<remarks>
<para>
Utility class for transforming strings.
</para>
</remarks>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.Util.Transform.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.Util.Transform"/> class.
</summary>
<remarks>
<para>
Uses a private access modifier to prevent instantiation of this class.
</para>
</remarks>
</member>
<member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
<summary>
Write a string to an <see cref="T:System.Xml.XmlWriter"/>
</summary>
<param name="writer">the writer to write to</param>
<param name="textData">the string to write</param>
<param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
<remarks>
<para>
The test is escaped either using XML escape entities
or using CDATA sections.
</para>
</remarks>
</member>
<member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
<summary>
Replace invalid XML characters in text string
</summary>
<param name="textData">the XML text input string</param>
<param name="mask">the string to use in place of invalid characters</param>
<returns>A string that does not contain invalid XML characters.</returns>
<remarks>
<para>
Certain Unicode code points are not allowed in the XML InfoSet, for
details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
</para>
<para>
This method replaces any illegal characters in the input string
with the mask string specified.
</para>
</remarks>
</member>
<member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
<summary>
Count the number of times that the substring occurs in the text
</summary>
<param name="text">the text to search</param>
<param name="substring">the substring to find</param>
<returns>the number of times the substring occurs in the text</returns>
<remarks>
<para>
The substring is assumed to be non repeating within itself.
</para>
</remarks>
</member>
<member name="F:log4net.Util.Transform.INVALIDCHARS">
<summary>
Characters illegal in XML 1.0
</summary>
</member>
<member name="T:log4net.Util.WindowsSecurityContext">
<summary>
Impersonate a Windows Account
</summary>
<remarks>
<para>
This <see cref="T:log4net.Core.SecurityContext"/> impersonates a Windows account.
</para>
<para>
How the impersonation is done depends on the value of <see cref="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"/>.
This allows the context to either impersonate a set of user credentials specified
using username, domain name and password or to revert to the process credentials.
</para>
</remarks>
</member>
<member name="M:log4net.Util.WindowsSecurityContext.#ctor">
<summary>
Default constructor
</summary>
<remarks>
<para>
Default constructor
</para>
</remarks>
</member>
<member name="M:log4net.Util.WindowsSecurityContext.ActivateOptions">
<summary>
Initialize the SecurityContext based on the options set.
</summary>
<remarks>
<para>
This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
activation scheme. The <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> method must
be called on this object after the configuration properties have
been set. Until <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> is called this
object is in an undefined state and must not be used.
</para>
<para>
If any of the configuration properties are modified then
<see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> must be called again.
</para>
<para>
The security context will try to Logon the specified user account and
capture a primary token for impersonation.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException">The required <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>,
<see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> or <see cref="P:log4net.Util.WindowsSecurityContext.Password"/> properties were not specified.</exception>
</member>
<member name="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)">
<summary>
Impersonate the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
</summary>
<param name="state">caller provided state</param>
<returns>
An <see cref="T:System.IDisposable"/> instance that will revoke the impersonation of this SecurityContext
</returns>
<remarks>
<para>
Depending on the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property either
impersonate a user using credentials supplied or revert
to the process credentials.
</para>
</remarks>
</member>
<member name="M:log4net.Util.WindowsSecurityContext.LogonUser(System.String,System.String,System.String)">
<summary>
Create a <see cref="T:System.Security.Principal.WindowsIdentity"/> given the userName, domainName and password.
</summary>
<param name="userName">the user name</param>
<param name="domainName">the domain name</param>
<param name="password">the password</param>
<returns>the <see cref="T:System.Security.Principal.WindowsIdentity"/> for the account specified</returns>
<remarks>
<para>
Uses the Windows API call LogonUser to get a principal token for the account. This
token is used to initialize the WindowsIdentity.
</para>
</remarks>
</member>
<member name="P:log4net.Util.WindowsSecurityContext.Credentials">
<summary>
Gets or sets the impersonation mode for this security context
</summary>
<value>
The impersonation mode for this security context
</value>
<remarks>
<para>
Impersonate either a user with user credentials or
revert this thread to the credentials of the process.
The value is one of the <see cref="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"/>
enum.
</para>
<para>
The default value is <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
</para>
<para>
When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
the user's credentials are established using the
<see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.Password"/>
values.
</para>
<para>
When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"/>
no other properties need to be set. If the calling thread is
impersonating then it will be reverted back to the process credentials.
</para>
</remarks>
</member>
<member name="P:log4net.Util.WindowsSecurityContext.UserName">
<summary>
Gets or sets the Windows username for this security context
</summary>
<value>
The Windows username for this security context
</value>
<remarks>
<para>
This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
</para>
</remarks>
</member>
<member name="P:log4net.Util.WindowsSecurityContext.DomainName">
<summary>
Gets or sets the Windows domain name for this security context
</summary>
<value>
The Windows domain name for this security context
</value>
<remarks>
<para>
The default value for <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> is the local machine name
taken from the <see cref="P:System.Environment.MachineName"/> property.
</para>
<para>
This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
</para>
</remarks>
</member>
<member name="P:log4net.Util.WindowsSecurityContext.Password">
<summary>
Sets the password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
</summary>
<value>
The password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
</value>
<remarks>
<para>
This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
</para>
</remarks>
</member>
<member name="T:log4net.Util.WindowsSecurityContext.ImpersonationMode">
<summary>
The impersonation modes for the <see cref="T:log4net.Util.WindowsSecurityContext"/>
</summary>
<remarks>
<para>
See the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property for
details.
</para>
</remarks>
</member>
<member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User">
<summary>
Impersonate a user using the credentials supplied
</summary>
</member>
<member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process">
<summary>
Revert this the thread to the credentials of the process
</summary>
</member>
<member name="T:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext">
<summary>
Adds <see cref="T:System.IDisposable"/> to <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
</summary>
<remarks>
<para>
Helper class to expose the <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
through the <see cref="T:System.IDisposable"/> interface.
</para>
</remarks>
</member>
<member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.#ctor(System.Security.Principal.WindowsImpersonationContext)">
<summary>
Constructor
</summary>
<param name="impersonationContext">the impersonation context being wrapped</param>
<remarks>
<para>
Constructor
</para>
</remarks>
</member>
<member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.Dispose">
<summary>
Revert the impersonation
</summary>
<remarks>
<para>
Revert the impersonation
</para>
</remarks>
</member>
<member name="T:log4net.GlobalContext">
<summary>
The log4net Global Context.
</summary>
<remarks>
<para>
The <c>GlobalContext</c> provides a location for global debugging
information to be stored.
</para>
<para>
The global context has a properties map and these properties can
be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
supports selecting and outputing these properties.
</para>
<para>
By default the <c>log4net:HostName</c> property is set to the name of
the current machine.
</para>
</remarks>
<example>
<code lang="C#">
GlobalContext.Properties["hostname"] = Environment.MachineName;
</code>
</example>
<threadsafety static="true" instance="true"/>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.GlobalContext.#ctor">
<summary>
Private Constructor.
</summary>
<remarks>
Uses a private access modifier to prevent instantiation of this class.
</remarks>
</member>
<member name="F:log4net.GlobalContext.s_properties">
<summary>
The global context properties instance
</summary>
</member>
<member name="P:log4net.GlobalContext.Properties">
<summary>
The global properties map.
</summary>
<value>
The global properties map.
</value>
<remarks>
<para>
The global properties map.
</para>
</remarks>
</member>
<member name="T:log4net.AssemblyInfo">
<summary>
Provides information about the environment the assembly has
been built for.
</summary>
</member>
<member name="F:log4net.AssemblyInfo.Version">
<summary>Version of the assembly</summary>
</member>
<member name="F:log4net.AssemblyInfo.TargetFrameworkVersion">
<summary>Version of the framework targeted</summary>
</member>
<member name="F:log4net.AssemblyInfo.TargetFramework">
<summary>Type of framework targeted</summary>
</member>
<member name="F:log4net.AssemblyInfo.ClientProfile">
<summary>Does it target a client profile?</summary>
</member>
<member name="P:log4net.AssemblyInfo.Info">
<summary>
Identifies the version and target for this assembly.
</summary>
</member>
<member name="T:log4net.LogicalThreadContext">
<summary>
The log4net Logical Thread Context.
</summary>
<remarks>
<para>
The <c>LogicalThreadContext</c> provides a location for <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging
information to be stored.
The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/>
properties with the same name.
</para>
<para>
The Logical Thread Context has a properties map and a stack.
The properties and stack can
be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
supports selecting and outputting these properties.
</para>
<para>
The Logical Thread Context provides a diagnostic context for the current call context.
This is an instrument for distinguishing interleaved log
output from different sources. Log output is typically interleaved
when a server handles multiple clients near-simultaneously.
</para>
<para>
The Logical Thread Context is managed on a per <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> basis.
</para>
<para>
The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
<see cref="T:System.Security.Permissions.SecurityPermission"/> for the
<see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
If the calling code does not have this permission then this context will be disabled.
It will not store any property values set on it.
</para>
</remarks>
<example>Example of using the thread context properties to store a username.
<code lang="C#">
LogicalThreadContext.Properties["user"] = userName;
log.Info("This log message has a LogicalThreadContext Property called 'user'");
</code>
</example>
<example>Example of how to push a message into the context stack
<code lang="C#">
using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
{
log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
} // at the end of the using block the message is automatically popped
</code>
</example>
<threadsafety static="true" instance="true"/>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.LogicalThreadContext.#ctor">
<summary>
Private Constructor.
</summary>
<remarks>
<para>
Uses a private access modifier to prevent instantiation of this class.
</para>
</remarks>
</member>
<member name="F:log4net.LogicalThreadContext.s_properties">
<summary>
The thread context properties instance
</summary>
</member>
<member name="F:log4net.LogicalThreadContext.s_stacks">
<summary>
The thread context stacks instance
</summary>
</member>
<member name="P:log4net.LogicalThreadContext.Properties">
<summary>
The thread properties map
</summary>
<value>
The thread properties map
</value>
<remarks>
<para>
The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/>
or <see cref="T:log4net.GlobalContext"/> properties with the same name.
</para>
</remarks>
</member>
<member name="P:log4net.LogicalThreadContext.Stacks">
<summary>
The thread stacks
</summary>
<value>
stack map
</value>
<remarks>
<para>
The logical thread stacks.
</para>
</remarks>
</member>
<member name="T:log4net.LogManager">
<summary>
This class is used by client applications to request logger instances.
</summary>
<remarks>
<para>
This class has static methods that are used by a client to request
a logger instance. The <see cref="M:GetLogger(string)"/> method is
used to retrieve a logger.
</para>
<para>
See the <see cref="T:log4net.ILog"/> interface for more details.
</para>
</remarks>
<example>Simple example of logging messages
<code lang="C#">
ILog log = LogManager.GetLogger("application-log");
log.Info("Application Start");
log.Debug("This is a debug message");
if (log.IsDebugEnabled)
{
log.Debug("This is another debug message");
}
</code>
</example>
<threadsafety static="true" instance="true"/>
<seealso cref="T:log4net.ILog"/>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.LogManager.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.LogManager"/> class.
</summary>
<remarks>
Uses a private access modifier to prevent instantiation of this class.
</remarks>
</member>
<member name="M:log4net.LogManager.Exists(System.String)">
<overloads>Returns the named logger if it exists.</overloads>
<summary>
Returns the named logger if it exists.
</summary>
<remarks>
<para>
If the named logger exists (in the default repository) then it
returns a reference to the logger, otherwise it returns <c>null</c>.
</para>
</remarks>
<param name="name">The fully qualified logger name to look for.</param>
<returns>The logger found, or <c>null</c> if no logger could be found.</returns>
</member>
<member name="M:log4net.LogManager.Exists(System.String,System.String)">
<summary>
Returns the named logger if it exists.
</summary>
<remarks>
<para>
If the named logger exists (in the specified repository) then it
returns a reference to the logger, otherwise it returns
<c>null</c>.
</para>
</remarks>
<param name="repository">The repository to lookup in.</param>
<param name="name">The fully qualified logger name to look for.</param>
<returns>
The logger found, or <c>null</c> if the logger doesn't exist in the specified
repository.
</returns>
</member>
<member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)">
<summary>
Returns the named logger if it exists.
</summary>
<remarks>
<para>
If the named logger exists (in the repository for the specified assembly) then it
returns a reference to the logger, otherwise it returns
<c>null</c>.
</para>
</remarks>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<param name="name">The fully qualified logger name to look for.</param>
<returns>
The logger, or <c>null</c> if the logger doesn't exist in the specified
assembly's repository.
</returns>
</member>
<member name="M:log4net.LogManager.GetCurrentLoggers">
<overloads>Get the currently defined loggers.</overloads>
<summary>
Returns all the currently defined loggers in the default repository.
</summary>
<remarks>
<para>The root logger is <b>not</b> included in the returned array.</para>
</remarks>
<returns>All the defined loggers.</returns>
</member>
<member name="M:log4net.LogManager.GetCurrentLoggers(System.String)">
<summary>
Returns all the currently defined loggers in the specified repository.
</summary>
<param name="repository">The repository to lookup in.</param>
<remarks>
The root logger is <b>not</b> included in the returned array.
</remarks>
<returns>All the defined loggers.</returns>
</member>
<member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)">
<summary>
Returns all the currently defined loggers in the specified assembly's repository.
</summary>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<remarks>
The root logger is <b>not</b> included in the returned array.
</remarks>
<returns>All the defined loggers.</returns>
</member>
<member name="M:log4net.LogManager.GetLogger(System.String)">
<overloads>Get or create a logger.</overloads>
<summary>
Retrieves or creates a named logger.
</summary>
<remarks>
<para>
Retrieves a logger named as the <paramref name="name"/>
parameter. If the named logger already exists, then the
existing instance will be returned. Otherwise, a new instance is
created.
</para>
<para>By default, loggers do not have a set level but inherit
it from the hierarchy. This is one of the central features of
log4net.
</para>
</remarks>
<param name="name">The name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
</member>
<member name="M:log4net.LogManager.GetLogger(System.String,System.String)">
<summary>
Retrieves or creates a named logger.
</summary>
<remarks>
<para>
Retrieve a logger named as the <paramref name="name"/>
parameter. If the named logger already exists, then the
existing instance will be returned. Otherwise, a new instance is
created.
</para>
<para>
By default, loggers do not have a set level but inherit
it from the hierarchy. This is one of the central features of
log4net.
</para>
</remarks>
<param name="repository">The repository to lookup in.</param>
<param name="name">The name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
</member>
<member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)">
<summary>
Retrieves or creates a named logger.
</summary>
<remarks>
<para>
Retrieve a logger named as the <paramref name="name"/>
parameter. If the named logger already exists, then the
existing instance will be returned. Otherwise, a new instance is
created.
</para>
<para>
By default, loggers do not have a set level but inherit
it from the hierarchy. This is one of the central features of
log4net.
</para>
</remarks>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<param name="name">The name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
</member>
<member name="M:log4net.LogManager.GetLogger(System.Type)">
<summary>
Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
</summary>
<remarks>
Get the logger for the fully qualified name of the type specified.
</remarks>
<param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
</member>
<member name="M:log4net.LogManager.GetLogger(System.String,System.Type)">
<summary>
Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
</summary>
<remarks>
Gets the logger for the fully qualified name of the type specified.
</remarks>
<param name="repository">The repository to lookup in.</param>
<param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
</member>
<member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)">
<summary>
Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
</summary>
<remarks>
Gets the logger for the fully qualified name of the type specified.
</remarks>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
<param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
<returns>The logger with the name specified.</returns>
</member>
<member name="M:log4net.LogManager.Shutdown">
<summary>
Shuts down the log4net system.
</summary>
<remarks>
<para>
Calling this method will <b>safely</b> close and remove all
appenders in all the loggers including root contained in all the
default repositories.
</para>
<para>
Some appenders need to be closed before the application exists.
Otherwise, pending logging events might be lost.
</para>
<para>The <c>shutdown</c> method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
</para>
</remarks>
</member>
<member name="M:log4net.LogManager.ShutdownRepository">
<overloads>Shutdown a logger repository.</overloads>
<summary>
Shuts down the default repository.
</summary>
<remarks>
<para>
Calling this method will <b>safely</b> close and remove all
appenders in all the loggers including root contained in the
default repository.
</para>
<para>Some appenders need to be closed before the application exists.
Otherwise, pending logging events might be lost.
</para>
<para>The <c>shutdown</c> method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
</para>
</remarks>
</member>
<member name="M:log4net.LogManager.ShutdownRepository(System.String)">
<summary>
Shuts down the repository for the repository specified.
</summary>
<remarks>
<para>
Calling this method will <b>safely</b> close and remove all
appenders in all the loggers including root contained in the
<paramref name="repository"/> specified.
</para>
<para>
Some appenders need to be closed before the application exists.
Otherwise, pending logging events might be lost.
</para>
<para>The <c>shutdown</c> method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
</para>
</remarks>
<param name="repository">The repository to shutdown.</param>
</member>
<member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)">
<summary>
Shuts down the repository specified.
</summary>
<remarks>
<para>
Calling this method will <b>safely</b> close and remove all
appenders in all the loggers including root contained in the
repository. The repository is looked up using
the <paramref name="repositoryAssembly"/> specified.
</para>
<para>
Some appenders need to be closed before the application exists.
Otherwise, pending logging events might be lost.
</para>
<para>
The <c>shutdown</c> method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
</para>
</remarks>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
</member>
<member name="M:log4net.LogManager.ResetConfiguration">
<overloads>Reset the configuration of a repository</overloads>
<summary>
Resets all values contained in this repository instance to their defaults.
</summary>
<remarks>
<para>
Resets all values contained in the repository instance to their
defaults. This removes all appenders from all loggers, sets
the level of all non-root loggers to <c>null</c>,
sets their additivity flag to <c>true</c> and sets the level
of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
message disabling is set to its default "off" value.
</para>
</remarks>
</member>
<member name="M:log4net.LogManager.ResetConfiguration(System.String)">
<summary>
Resets all values contained in this repository instance to their defaults.
</summary>
<remarks>
<para>
Reset all values contained in the repository instance to their
defaults. This removes all appenders from all loggers, sets
the level of all non-root loggers to <c>null</c>,
sets their additivity flag to <c>true</c> and sets the level
of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
message disabling is set to its default "off" value.
</para>
</remarks>
<param name="repository">The repository to reset.</param>
</member>
<member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)">
<summary>
Resets all values contained in this repository instance to their defaults.
</summary>
<remarks>
<para>
Reset all values contained in the repository instance to their
defaults. This removes all appenders from all loggers, sets
the level of all non-root loggers to <c>null</c>,
sets their additivity flag to <c>true</c> and sets the level
of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
message disabling is set to its default "off" value.
</para>
</remarks>
<param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
</member>
<member name="M:log4net.LogManager.GetLoggerRepository">
<overloads>Get the logger repository.</overloads>
<summary>
Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
</para>
</remarks>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
</member>
<member name="M:log4net.LogManager.GetLoggerRepository(System.String)">
<summary>
Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
by the <paramref name="repository"/> argument.
</para>
</remarks>
<param name="repository">The repository to lookup in.</param>
</member>
<member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)">
<summary>
Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
by the <paramref name="repositoryAssembly"/> argument.
</para>
</remarks>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
</member>
<member name="M:log4net.LogManager.GetRepository">
<overloads>Get a logger repository.</overloads>
<summary>
Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
</para>
</remarks>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
</member>
<member name="M:log4net.LogManager.GetRepository(System.String)">
<summary>
Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
by the <paramref name="repository"/> argument.
</para>
</remarks>
<param name="repository">The repository to lookup in.</param>
</member>
<member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)">
<summary>
Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
</summary>
<returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
<remarks>
<para>
Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
by the <paramref name="repositoryAssembly"/> argument.
</para>
</remarks>
<param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
</member>
<member name="M:log4net.LogManager.CreateDomain(System.Type)">
<overloads>Create a domain</overloads>
<summary>
Creates a repository with the specified repository type.
</summary>
<remarks>
<para>
<b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
</para>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository()"/> will return
the same repository instance.
</para>
</remarks>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
</member>
<member name="M:log4net.LogManager.CreateRepository(System.Type)">
<overloads>Create a logger repository.</overloads>
<summary>
Creates a repository with the specified repository type.
</summary>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository()"/> will return
the same repository instance.
</para>
</remarks>
</member>
<member name="M:log4net.LogManager.CreateDomain(System.String)">
<summary>
Creates a repository with the specified name.
</summary>
<remarks>
<para>
<b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
</para>
<para>
Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
<see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
</para>
<para>
The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
</para>
</remarks>
<param name="repository">The name of the repository, this must be unique amongst repositories.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
</member>
<member name="M:log4net.LogManager.CreateRepository(System.String)">
<summary>
Creates a repository with the specified name.
</summary>
<remarks>
<para>
Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
<see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
</para>
<para>
The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
</para>
</remarks>
<param name="repository">The name of the repository, this must be unique amongst repositories.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
</member>
<member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)">
<summary>
Creates a repository with the specified name and repository type.
</summary>
<remarks>
<para>
<b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
</para>
<para>
The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
</para>
</remarks>
<param name="repository">The name of the repository, this must be unique to the repository.</param>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
</member>
<member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)">
<summary>
Creates a repository with the specified name and repository type.
</summary>
<remarks>
<para>
The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
</para>
</remarks>
<param name="repository">The name of the repository, this must be unique to the repository.</param>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
<exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
</member>
<member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)">
<summary>
Creates a repository for the specified assembly and repository type.
</summary>
<remarks>
<para>
<b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
</para>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
same assembly specified will return the same repository instance.
</para>
</remarks>
<param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
</member>
<member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)">
<summary>
Creates a repository for the specified assembly and repository type.
</summary>
<remarks>
<para>
The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
same assembly specified will return the same repository instance.
</para>
</remarks>
<param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
<param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
and has a no arg constructor. An instance of this type will be created to act
as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
<returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
</member>
<member name="M:log4net.LogManager.GetAllRepositories">
<summary>
Gets the list of currently defined repositories.
</summary>
<remarks>
<para>
Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created.
</para>
</remarks>
<returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
</member>
<member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)">
<summary>
Looks up the wrapper object for the logger specified.
</summary>
<param name="logger">The logger to get the wrapper for.</param>
<returns>The wrapper for the logger specified.</returns>
</member>
<member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])">
<summary>
Looks up the wrapper objects for the loggers specified.
</summary>
<param name="loggers">The loggers to get the wrappers for.</param>
<returns>The wrapper objects for the loggers specified.</returns>
</member>
<member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)">
<summary>
Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by
this manager.
</summary>
<param name="logger">The logger to wrap.</param>
<returns>The wrapper for the logger specified.</returns>
</member>
<member name="F:log4net.LogManager.s_wrapperMap">
<summary>
The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects.
</summary>
</member>
<member name="T:log4net.MDC">
<summary>
Implementation of Mapped Diagnostic Contexts.
</summary>
<remarks>
<note>
<para>
The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
</para>
</note>
<para>
The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is
based on a map instead of a stack. It provides <i>mapped
diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or
MDC in short, is an instrument for distinguishing interleaved log
output from different sources. Log output is typically interleaved
when a server handles multiple clients near-simultaneously.
</para>
<para>
The MDC is managed on a per thread basis.
</para>
</remarks>
<threadsafety static="true" instance="true"/>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.MDC.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.MDC"/> class.
</summary>
<remarks>
Uses a private access modifier to prevent instantiation of this class.
</remarks>
</member>
<member name="M:log4net.MDC.Get(System.String)">
<summary>
Gets the context value identified by the <paramref name="key"/> parameter.
</summary>
<param name="key">The key to lookup in the MDC.</param>
<returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns>
<remarks>
<note>
<para>
The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
</para>
</note>
<para>
If the <paramref name="key"/> parameter does not look up to a
previously defined context then <c>null</c> will be returned.
</para>
</remarks>
</member>
<member name="M:log4net.MDC.Set(System.String,System.String)">
<summary>
Add an entry to the MDC
</summary>
<param name="key">The key to store the value under.</param>
<param name="value">The value to store.</param>
<remarks>
<note>
<para>
The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
</para>
</note>
<para>
Puts a context value (the <paramref name="value"/> parameter) as identified
with the <paramref name="key"/> parameter into the current thread's
context map.
</para>
<para>
If a value is already defined for the <paramref name="key"/>
specified then the value will be replaced. If the <paramref name="value"/>
is specified as <c>null</c> then the key value mapping will be removed.
</para>
</remarks>
</member>
<member name="M:log4net.MDC.Remove(System.String)">
<summary>
Removes the key value mapping for the key specified.
</summary>
<param name="key">The key to remove.</param>
<remarks>
<note>
<para>
The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
</para>
</note>
<para>
Remove the specified entry from this thread's MDC
</para>
</remarks>
</member>
<member name="M:log4net.MDC.Clear">
<summary>
Clear all entries in the MDC
</summary>
<remarks>
<note>
<para>
The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
</para>
</note>
<para>
Remove all the entries from this thread's MDC
</para>
</remarks>
</member>
<member name="T:log4net.NDC">
<summary>
Implementation of Nested Diagnostic Contexts.
</summary>
<remarks>
<note>
<para>
The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
</para>
</note>
<para>
A Nested Diagnostic Context, or NDC in short, is an instrument
to distinguish interleaved log output from different sources. Log
output is typically interleaved when a server handles multiple
clients near-simultaneously.
</para>
<para>
Interleaved log output can still be meaningful if each log entry
from different contexts had a distinctive stamp. This is where NDCs
come into play.
</para>
<para>
Note that NDCs are managed on a per thread basis. The NDC class
is made up of static methods that operate on the context of the
calling thread.
</para>
</remarks>
<example>How to push a message into the context
<code lang="C#">
using(NDC.Push("my context message"))
{
... all log calls will have 'my context message' included ...
} // at the end of the using block the message is automatically removed
</code>
</example>
<threadsafety static="true" instance="true"/>
<author>Nicko Cadell</author>
<author>Gert Driesen</author>
</member>
<member name="M:log4net.NDC.#ctor">
<summary>
Initializes a new instance of the <see cref="T:log4net.NDC"/> class.
</summary>
<remarks>
Uses a private access modifier to prevent instantiation of this class.
</remarks>
</member>
<member name="M:log4net.NDC.Clear">
<summary>
Clears all the contextual information held on the current thread.
</summary>
<remarks>
<note>
<para>
The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
</para>
</note>
<para>
Clears the stack of NDC data held on the current thread.
</para>
</remarks>
</member>
<member name="M:log4net.NDC.CloneStack">
<summary>
Creates a clone of the stack of context information.
</summary>
<returns>A clone of the context info for this thread.</returns>
<remarks>
<note>
<para>
The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
</para>
</note>
<para>
The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/>
method to allow child threads to inherit the context of their
parent thread.
</para>
</remarks>
</member>
<member name="M:log4net.NDC.Inherit(System.Collections.Stack)">
<summary>
Inherits the contextual information from another thread.
</summary>
<param name="stack">The context stack to inherit.</param>
<remarks>
<note>
<para>
The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
</para>
</note>
<para>
This thread will use the context information from the stack
supplied. This can be used to initialize child threads with
the same contextual information as their parent threads. These
contexts will <b>NOT</b> be shared. Any further contexts that
are pushed onto the stack will not be visible to the other.
Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to
this method.
</para>
</remarks>
</member>
<member name="M:log4net.NDC.Pop">
<summary>
Removes the top context from the stack.
</summary>
<returns>
The message in the context that was removed from the top
of the stack.
</returns>
<remarks>
<note>
<para>
The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
</para>
</note>
<para>
Remove the top context from the stack, and return
it to the caller. If the stack is empty then an
empty string (not <c>null</c>) is returned.
</para>
</remarks>
</member>
<member name="M:log4net.NDC.Push(System.String)">
<summary>
Pushes a new context message.
</summary>
<param name="message">The new context message.</param>
<returns>
An <see cref="T:System.IDisposable"/> that can be used to clean up
the context stack.
</returns>
<remarks>
<note>
<para>
The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
</para>
</note>
<para>
Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
is returned that can be used to clean up the context stack. This
can be easily combined with the <c>using</c> keyword to scope the
context.
</para>
</remarks>
<example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
<code lang="C#">
using(log4net.NDC.Push("NDC_Message"))
{
log.Warn("This should have an NDC message");
}
</code>
</example>
</member>
<member name="M:log4net.NDC.Remove">
<summary>
Removes the context information for this thread. It is
not required to call this method.
</summary>
<remarks>
<note>
<para>
The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
</para>
</note>
<para>
This method is not implemented.
</para>
</remarks>
</member>
<member name="M:log4net.NDC.SetMaxDepth(System.Int32)">
<summary>
Forces the stack depth to be at most <paramref name="maxDepth"/>.
</summary>
<param name="maxDepth">The maximum depth of the stack</param>
<remarks>
<note>
<para>
The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
</para>
</note>
<para>
Forces the stack depth to be at most <paramref name="maxDepth"/>.
This may truncate the head of the stack. This only affects the
stack in the current thread. Also it does not prevent it from
growing, it only sets the maximum depth at the time of the
call. This can be used to return to a known context depth.
</para>
</remarks>
</member>
<member name="P:log4net.NDC.Depth">
<summary>
Gets the current context depth.
</summary>
<value>The current context depth.</value>
<remarks>
<note>
<para>
The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
</para>
</note>
<para>
The number of context values pushed onto the context stack.
</para>
<para>
Used to record the current depth of the context. This can then
be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method.
</para>
</remarks>
<seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/>
</member>
<member name="T:log4net.ThreadContext">
<summary>
The log4net Thread Context.
</summary>
<remarks>
<para>
The <c>ThreadContext</c> provides a location for thread specific debugging
information to be stored.
The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
properties with the same name.
</para>
<para>
The thread context has a properties map and a stack.
The properties and stack can
be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
supports selecting and outputting these properties.
</para>
<para>
The Thread Context provides a diagnostic context for the current thread.
This is an instrument for distinguishing interleaved log
output from different sources. Log output is typically interleaved
when a server handles multiple clients near-simultaneously.
</para>
<para>
The Thread Context is managed on a per thread basis.
</para>
</remarks>
<example>Example of using the thread context properties to store a username.
<code lang="C#">
ThreadContext.Properties["user"] = userName;
log.Info("This log message has a ThreadContext Property called 'user'");
</code>
</example>
<example>Example of how to push a message into the context stack
<code lang="C#">
using(ThreadContext.Stacks["NDC"].Push("my context message"))
{
log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
} // at the end of the using block the message is automatically popped
</code>
</example>
<threadsafety static="true" instance="true"/>
<author>Nicko Cadell</author>
</member>
<member name="M:log4net.ThreadContext.#ctor">
<summary>
Private Constructor.
</summary>
<remarks>
<para>
Uses a private access modifier to prevent instantiation of this class.
</para>
</remarks>
</member>
<member name="F:log4net.ThreadContext.s_properties">
<summary>
The thread context properties instance
</summary>
</member>
<member name="F:log4net.ThreadContext.s_stacks">
<summary>
The thread context stacks instance
</summary>
</member>
<member name="P:log4net.ThreadContext.Properties">
<summary>
The thread properties map
</summary>
<value>
The thread properties map
</value>
<remarks>
<para>
The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
properties with the same name.
</para>
</remarks>
</member>
<member name="P:log4net.ThreadContext.Stacks">
<summary>
The thread stacks
</summary>
<value>
stack map
</value>
<remarks>
<para>
The thread local stacks.
</para>
</remarks>
</member>
</members>
</doc>
<?xml version="1.0"?>
<doc>
<assembly>
<name>PowerArgs</name>
</assembly>
<members>
<member name="T:PowerArgs.IArgMetadataEx">
<summary>
Extension methods that make it easy to work with metadata collections
</summary>
</member>
<member name="M:PowerArgs.IArgMetadataEx.HasMeta``1(System.Collections.Generic.IEnumerable{PowerArgs.IArgMetadata})">
<summary>
Returns true if the given collection of metadata contains metadata of the generic type T
provided.
</summary>
<typeparam name="T">The type of metadata to search for</typeparam>
<param name="metadata">The list of metadata to search</param>
<returns>rue if the given collection of metadata contains metadata of the generic type T
provided, otherwise false</returns>
</member>
<member name="M:PowerArgs.IArgMetadataEx.Meta``1(System.Collections.Generic.IEnumerable{PowerArgs.IArgMetadata})">
<summary>
Gets the first instance of metadata of the given generic type T in the collection
or null if it was not found.
</summary>
<typeparam name="T">The type of metadata to search for</typeparam>
<param name="metadata">The list of metadata to search</param>
<returns>the first instance of an metadata of the given generic type T in the collection
or null if it was not found</returns>
</member>
<member name="M:PowerArgs.IArgMetadataEx.TryGetMeta``1(System.Collections.Generic.IEnumerable{PowerArgs.IArgMetadata},``0@)">
<summary>
Try to get the first instance of metadata of the given generic type T in the collection.
</summary>
<typeparam name="T">The type of metadata to search for</typeparam>
<param name="metadata">The list of metadata to search</param>
<param name="ret">the our variable to set if the metadata was found</param>
<returns>true if the metadata was found, otherwise false</returns>
</member>
<member name="M:PowerArgs.IArgMetadataEx.Metas``1(System.Collections.Generic.IEnumerable{PowerArgs.IArgMetadata})">
<summary>
Gets the subset of metadata of the given generic type T from the collection.
</summary>
<typeparam name="T">The type of metadata to search for</typeparam>
<param name="metadata">The list of metadata to search</param>
<returns>the subset of metadata of the given generic type T from the collection</returns>
</member>
<member name="T:PowerArgs.MatchCollectionEx">
<summary>
A simple helper that makes it possible to do Linq queries over a MatchCollection
</summary>
</member>
<member name="M:PowerArgs.MatchCollectionEx.ToList(System.Text.RegularExpressions.MatchCollection)">
<summary>
Converts a MatchCollection to a List of Match objects so that you can perform linq queries over the matches.
</summary>
<param name="matches">The MatchCollection to convert</param>
<returns>a list of Match objects</returns>
</member>
<member name="T:PowerArgs.MemberInfoEx">
<summary>
Provides some reflection helpers in the form of extension methods for the MemberInfo type.
</summary>
</member>
<member name="M:PowerArgs.MemberInfoEx.HasAttr``1(System.Reflection.MemberInfo)">
<summary>
Returns true if the given member has an attribute of the given type (including inherited types).
</summary>
<typeparam name="T">The type of attribute to test for (will return true for attributes that inherit from this type)</typeparam>
<param name="info">The member to test</param>
<returns>true if a matching attribute was found, false otherwise</returns>
</member>
<member name="M:PowerArgs.MemberInfoEx.Attr``1(System.Reflection.MemberInfo)">
<summary>
Gets the attribute of the given type or null if the member does not have this attribute defined. The standard reflection helper GetCustomAttributes will
give you a new instance of the attribute every time you call it. This helper caches it's results so if you ask for the same attibute twice you will actually
get back the same attribute. Note that the cache key is based off of the type T that you provide. So asking for Attr() where T : BaseType> and then asking for Attr() where T : ConcreteType
will result in two different objects being returned. If you ask for Attr() where T : BaseType and then Attr() where T :BaseType the caching will work and you'll get the same object back
the second time.
</summary>
<typeparam name="T">The type of attribute to search for</typeparam>
<param name="info">The member to inspect</param>
<returns>The desired attribute or null if it is not present</returns>
</member>
<member name="M:PowerArgs.MemberInfoEx.Attrs``1(System.Reflection.MemberInfo)">
<summary>
Gets the attributes of the given type. The standard reflection helper GetCustomAttributes will give you new instances of the attributes every time you call it.
This helper caches it's results so if you ask for the same attibutes twice you will actually get back the same attributes. Note that the cache key is based off
of the type T that you provide. So asking for Attrs() where T : BaseType and then asking for Attrs() where T : ConcreteType
will result in two different sets of objects being returned. If you ask for Attrs() where T : BaseType and then Attrs() where T : BaseType the caching will work and you'll get the
same results back the second time.
</summary>
<typeparam name="T">The type of attribute to search for</typeparam>
<param name="info">The member to inspect</param>
<returns>The list of attributes that you asked for</returns>
</member>
<member name="T:PowerArgs.ParemeterInfoEx">
<summary>
Some useful helper extensions for the ParameterInfo type
</summary>
</member>
<member name="M:PowerArgs.ParemeterInfoEx.HasAttr``1(System.Reflection.ParameterInfo)">
<summary>
Returns true if the given parameter has an attribute of the given type (including inherited types).
</summary>
<typeparam name="T">The type of attribute to test for (will return true for attributes that inherit from this type)</typeparam>
<param name="info">The parameter to test</param>
<returns>true if a matching attribute was found, false otherwise</returns>
</member>
<member name="M:PowerArgs.ParemeterInfoEx.Attr``1(System.Reflection.ParameterInfo)">
<summary>
Gets the attribute of the given type or null if the parameter does not have this attribute defined. The standard reflection helper GetCustomAttributes will
give you a new instance of the attribute every time you call it. This helper caches it's results so if you ask for the same attibute twice you will actually
get back the same attribute. Note that the cache key is based off of the type T that you provide. So asking for Attr() where T : BaseType> and then asking for Attr() where T : ConcreteType
will result in two different objects being returned. If you ask for Attr() where T : BaseType and then Attr() where T :BaseType the caching will work and you'll get the same object back
the second time.
</summary>
<typeparam name="T">The type of attribute to search for</typeparam>
<param name="info">The parameter to inspect</param>
<returns>The desired attribute or null if it is not present</returns>
</member>
<member name="M:PowerArgs.ParemeterInfoEx.Attrs``1(System.Reflection.ParameterInfo)">
<summary>
Gets the attributes of the given type. The standard reflection helper GetCustomAttributes will give you new instances of the attributes every time you call it.
This helper caches it's results so if you ask for the same attibutes twice you will actually get back the same attributes. Note that the cache key is based off
of the type T that you provide. So asking for Attrs() where T : BaseType and then asking for Attrs() where T : ConcreteType
will result in two different sets of objects being returned. If you ask for Attrs() where T : BaseType and then Attrs() where T : BaseType the caching will work and you'll get the
same results back the second time.
</summary>
<typeparam name="T">The type of attribute to search for</typeparam>
<param name="info">The parameter to inspect</param>
<returns>The list of attributes that you asked for</returns>
</member>
<member name="T:PowerArgs.ISmartTabCompletionSource">
<summary>
A replacement for ITabCompletionSource that makes it easier to implement custom tab completion logic
</summary>
</member>
<member name="M:PowerArgs.ISmartTabCompletionSource.TryComplete(PowerArgs.TabCompletionContext,System.String@)">
<summary>
PowerArgs will call this method if it has enhanced the command prompt and the user presses tab. The
context object passed into the function will contain useful information about what the user has typed on the command line.
If you find a completion then you should assign it to the completion variable and return true.
</summary>
<param name="context">An object containing useful information about what the user has typed on the command line</param>
<param name="completion">The variable that you should assign the completed string to if you find a match.</param>
<returns>True if you completed the string, false otherwise.</returns>
</member>
<member name="T:PowerArgs.AliasCollection">
<summary>
This class tracks the command line aliases for a CommandLineArgument and a CommandLineAction.
It combines the aliases that have been retrieved from the ArgShortcut attibute and any additional
aliases that may have been added to the model manually into a single collection. It also makes sure that those two sources
of aliases don't conflict.
</summary>
</member>
<member name="M:PowerArgs.AliasCollection.IndexOf(System.String)">
<summary>
Gets the index of the given alias in the collection.
</summary>
<param name="item">the alias to look for</param>
<returns>The index of item if found in the list; otherwise, -1.</returns>
</member>
<member name="M:PowerArgs.AliasCollection.Insert(System.Int32,System.String)">
<summary>
Not supported
</summary>
<param name="index">Not supported</param>
<param name="item">Not supported</param>
</member>
<member name="M:PowerArgs.AliasCollection.RemoveAt(System.Int32)">
<summary>
Not supported
</summary>
<param name="index">Not supported</param>
</member>
<member name="M:PowerArgs.AliasCollection.AddRange(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Adds the given aliases to the collection.
</summary>
<param name="items">The alias to add</param>
</member>
<member name="M:PowerArgs.AliasCollection.Add(System.String)">
<summary>
Adds the given alias to the collection. An InvalidArgDefinitionException is thrown if you try to add
the same alias twice (case sensitivity is determined by the CommandLineArgument or CommandLineAction).
</summary>
<param name="item">The alias to add</param>
</member>
<member name="M:PowerArgs.AliasCollection.Clear">
<summary>
Clear is not supported, use ClearOverrides() to clear items that have manually been added
</summary>
</member>
<member name="M:PowerArgs.AliasCollection.ClearOverrides">
<summary>
Clears the aliases that have been manually addd to this collection via Add() or AddRange().
Aliases that are inferred from the Metadata will still be present in the collection.
</summary>
</member>
<member name="M:PowerArgs.AliasCollection.Contains(System.String)">
<summary>
Tests to see if this Alias collection contains the given item. Case sensitivity is enforced
based on the CommandLineArgument or CommandLineAction.
</summary>
<param name="item">The item to test for containment</param>
<returns>True if the collection contains the item, otherwise false</returns>
</member>
<member name="M:PowerArgs.AliasCollection.CopyTo(System.String[],System.Int32)">
<summary>
Copies this collection to an array, starting at the given index
</summary>
<param name="array">the destination array</param>
<param name="arrayIndex">the starting index of where to place the elements into the destination</param>
</member>
<member name="M:PowerArgs.AliasCollection.Remove(System.String)">
<summary>
Removes the given alias from the collection if it was added via Add() or AddRange(). If
it was added by injecting metadata into a CommandLineArgument or a CommandLineAction then
an InvalidOperationException will be thrown. The correct way to remove metadata injected
aliases is to remove it from the metadata directly.
</summary>
<param name="item">the item to remove</param>
<returns>true if the alias was removed, false otherwise</returns>
</member>
<member name="M:PowerArgs.AliasCollection.GetEnumerator">
<summary>
Gets an enumerator capable of enumerating all aliases
</summary>
<returns>an enumerator capable of enumerating all aliases</returns>
</member>
<member name="M:PowerArgs.AliasCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>
Gets an enumerator capable of enumerating all aliases
</summary>
<returns>an enumerator capable of enumerating all aliases</returns>
</member>
<member name="P:PowerArgs.AliasCollection.Item(System.Int32)">
<summary>
The setter is not supported. The getter returns the item at the specified index.
</summary>
<param name="index"></param>
<returns>the item at the specified index</returns>
</member>
<member name="P:PowerArgs.AliasCollection.Count">
<summary>
Gets the count of aliases
</summary>
</member>
<member name="P:PowerArgs.AliasCollection.IsReadOnly">
<summary>
Not read only ever
</summary>
</member>
<member name="T:PowerArgs.ArgAction`1">
<summary>
This is the more complex version of the public result that is produced by the parser.
</summary>
<typeparam name="T">Represents the custom argument scaffold type that was passed to the parser.</typeparam>
</member>
<member name="T:PowerArgs.ArgAction">
<summary>
This is the weakly typed, more complex version of the public result that is produced by the parser.
</summary>
</member>
<member name="M:PowerArgs.ArgAction.Invoke">
<summary>
This will find the implementation method for your action and invoke it, passing the action specific
arguments as a parameter.
</summary>
</member>
<member name="P:PowerArgs.ArgAction.Definition">
<summary>
The definition or model that was used to parse the arguments
</summary>
</member>
<member name="P:PowerArgs.ArgAction.Value">
<summary>
The instance of your custom scaffold type that the parser generated and parsed.
</summary>
</member>
<member name="P:PowerArgs.ArgAction.ActionArgs">
<summary>
If you used the action framework then this will represent the instance of the action specific arguments
that were parsed.
</summary>
</member>
<member name="P:PowerArgs.ArgAction.ActionArgsProperty">
<summary>
If you used the action framework then this will map to the property that the user specified as the first
parameter on the command line.
</summary>
</member>
<member name="P:PowerArgs.ArgAction.ActionParameters">
<summary>
This is set if you defined your action via a method with simple parameters
</summary>
</member>
<member name="P:PowerArgs.ArgAction.HandledException">
<summary>
If an exception was handled by the parser then this property will be populated and others will not be.
</summary>
</member>
<member name="P:PowerArgs.ArgAction.Cancelled">
<summary>
If processing was cancelled then this property will be set to true.
</summary>
</member>
<member name="P:PowerArgs.ArgAction`1.Args">
<summary>
The instance of your custom scaffold type that the parser generated and parsed.
</summary>
</member>
<member name="T:PowerArgs.ConsoleHelper">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="F:PowerArgs.ConsoleHelper.ConsoleImpl">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="M:PowerArgs.ConsoleHelper.ReadLine(System.String@,System.Collections.Generic.List{System.String},PowerArgs.CommandLineArgumentsDefinition)">
<summary>
Only marked public for testing. Please do not use.
</summary>
<param name="rawInput">a reference to the command line string</param>
<param name="history">Any previous command lines</param>
<param name="definition">The args definition</param>
<returns>A new set of command line args</returns>
</member>
<member name="M:PowerArgs.ConsoleHelper.ParseContext(System.String)">
<summary>
The input is the full command line previous to the token to be completed. This function
pulls out the last token before the completion's 'so far' input.
</summary>
<param name="commandLine"></param>
<returns></returns>
</member>
<member name="T:PowerArgs.BooleanExpressionParser">
<summary>
A simple boolean expression parser that supports and '&', or '|', and grouping via parentheses.
</summary>
</member>
<member name="M:PowerArgs.BooleanExpressionParser.Parse(System.String)">
<summary>
Parses the given boolean expression which can be made up of variables and boolean operators (and '&' and or '|') grouped by parentheses.
</summary>
<param name="expressionText">The expression to parse</param>
<returns>The parsed expression</returns>
</member>
<member name="M:PowerArgs.BooleanExpressionParser.Revive(System.String,System.String)">
<summary>
A reviver that makes boolean expressions specificable on the command line
</summary>
<param name="key">not used</param>
<param name="val">the expression text</param>
<returns></returns>
</member>
<member name="T:PowerArgs.BooleanOperator">
<summary>
Represents the set of supported boolean operators
</summary>
</member>
<member name="F:PowerArgs.BooleanOperator.And">
<summary>
Represents an 'and' boolean operation
</summary>
</member>
<member name="F:PowerArgs.BooleanOperator.Or">
<summary>
Represents an 'or' boolean operation
</summary>
</member>
<member name="T:PowerArgs.BooleanExpressionTokenType">
<summary>
An enum representing a type of boolean expression token
</summary>
</member>
<member name="F:PowerArgs.BooleanExpressionTokenType.Variable">
<summary>
Represents a boolean variable
</summary>
</member>
<member name="F:PowerArgs.BooleanExpressionTokenType.GroupOpen">
<summary>
Represents the beginning of a logically grouped boolean expression
</summary>
</member>
<member name="F:PowerArgs.BooleanExpressionTokenType.GroupClose">
<summary>
Represents the end of a logically grouped boolean expression
</summary>
</member>
<member name="F:PowerArgs.BooleanExpressionTokenType.And">
<summary>
Represents an 'and' clause in a boolean expression
</summary>
</member>
<member name="F:PowerArgs.BooleanExpressionTokenType.Or">
<summary>
Represents an 'or' clause in a boolean expression
</summary>
</member>
<member name="F:PowerArgs.BooleanExpressionTokenType.Not">
<summary>
Indicates that an expression should be negated
</summary>
</member>
<member name="T:PowerArgs.BooleanExpressionToken">
<summary>
A class that represents a boolean expression token
</summary>
</member>
<member name="T:PowerArgs.Token">
<summary>
A base token class that represents a substring from a document. The location in the source
document is tracked along with the substring so that code that processes the token can indicate
where problems are to the user who supplied the document if needed.
</summary>
</member>
<member name="M:PowerArgs.Token.#ctor(System.String,System.Int32,System.Int32,System.Int32)">
<summary>
Creates a token given an initial value, a start index, a line number, and a column number
</summary>
<param name="initialValue">The initial value of a token. You can append to the token later</param>
<param name="startIndex">the zero based start index of this token in the document</param>
<param name="line">the 1 based line number of the token in the document</param>
<param name="col">the 1 based index of the token within it's line</param>
</member>
<member name="M:PowerArgs.Token.ToString">
<summary>
Gets a string representation of the token, along with position info
</summary>
<returns>a string representation of the token, along with position info</returns>
</member>
<member name="M:PowerArgs.Token.As``1">
<summary>
Creates a new instance of the strongly typed token and copies all of the base token's properties to the new value
</summary>
<typeparam name="T">The type of the derived token.</typeparam>
<returns>The strongly typed token</returns>
</member>
<member name="P:PowerArgs.Token.Value">
<summary>
Gets the value of the token
</summary>
</member>
<member name="P:PowerArgs.Token.StartIndex">
<summary>
Gets the zero based start index of this token in the document
</summary>
</member>
<member name="P:PowerArgs.Token.SourceFileLocation">
<summary>
Gets a string that represents the source file of this document. It does not need to be a file name, but it usually is.
</summary>
</member>
<member name="P:PowerArgs.Token.EndIndex">
<summary>
Gets the end index of the token in the document
</summary>
</member>
<member name="P:PowerArgs.Token.Line">
<summary>
Gets the 1 based line number of the token in the document
</summary>
</member>
<member name="P:PowerArgs.Token.Column">
<summary>
Gets the 1 based index of the token within it's line
</summary>
</member>
<member name="P:PowerArgs.Token.Position">
<summary>
Gets a string that represents the position of this token in the source document.
</summary>
</member>
<member name="M:PowerArgs.BooleanExpressionToken.#ctor(System.String,System.Int32,System.Int32,System.Int32)">
<summary>
Creates a boolean expression token
</summary>
<param name="tokenText">the token text</param>
<param name="startIndex">the start index of the token value</param>
<param name="line">the line number of the token value</param>
<param name="col">the column number of the token value</param>
</member>
<member name="P:PowerArgs.BooleanExpressionToken.Type">
<summary>
The type of token
</summary>
</member>
<member name="T:PowerArgs.IBooleanVariableResolver">
<summary>
An interface that describes how to resolve boolean variables that can be either true or false
</summary>
</member>
<member name="M:PowerArgs.IBooleanVariableResolver.ResolveBoolean(System.String)">
<summary>
Implementations should provide a value of true or false for each variable specified. Implementations can
choose how to handle unknown variables either by throwing or returning a default value.
</summary>
<param name="variableName"></param>
<returns></returns>
</member>
<member name="T:PowerArgs.FuncBooleanVariableResolver">
<summary>
A class that can resolve a boolean variable based on a function.
</summary>
</member>
<member name="M:PowerArgs.FuncBooleanVariableResolver.#ctor(System.Func{System.String,System.Boolean})">
<summary>
Creates a new variable resolver given an implementation as a function.
</summary>
<param name="resolverImpl"></param>
</member>
<member name="M:PowerArgs.FuncBooleanVariableResolver.ResolveBoolean(System.String)">
<summary>
Resolves the given variable using the wrapped function
</summary>
<param name="variableName"></param>
<returns></returns>
</member>
<member name="P:PowerArgs.FuncBooleanVariableResolver.ResolverImpl">
<summary>
The function that knows how to resolve boolean variables
</summary>
</member>
<member name="T:PowerArgs.IBooleanExpression">
<summary>
An interface representing a node in a boolean expression that can either be true or false.
</summary>
</member>
<member name="M:PowerArgs.IBooleanExpression.Evaluate(PowerArgs.IBooleanVariableResolver)">
<summary>
Evaluates the state of the node (true or false) given a variable resolver.
</summary>
<param name="resolver">the object to use to resolve boolean variables</param>
<returns>the result of the expression, true or false</returns>
</member>
<member name="M:PowerArgs.IBooleanExpression.Evaluate(System.Collections.Generic.Dictionary{System.String,System.Boolean})">
<summary>
Evaluates the state of the node (true or false) given a set of variable values.
</summary>
<param name="variableValues">The current state of variables</param>
<returns>the result of the expression, true or false</returns>
</member>
<member name="P:PowerArgs.IBooleanExpression.Not">
<summary>
Gets or sets a flag indicating that the expression should be negated
</summary>
</member>
<member name="T:PowerArgs.BooleanVariable">
<summary>
A node in a boolean expression that represents a variable that can either be true or false.
</summary>
</member>
<member name="M:PowerArgs.BooleanVariable.Evaluate(PowerArgs.IBooleanVariableResolver)">
<summary>
Uses the given resolver to resolve the target boolean variable
</summary>
<param name="resolver">The object used to resolve boolean variables</param>
<returns>the result of the resolver</returns>
</member>
<member name="M:PowerArgs.BooleanVariable.Evaluate(System.Collections.Generic.Dictionary{System.String,System.Boolean})">
<summary>
Evaluates the expression given a set of variable values
</summary>
<param name="variableValues">The value of variables that appear in the expression</param>
<returns>True if the expression was true, false otherwise</returns>
</member>
<member name="M:PowerArgs.BooleanVariable.ToString">
<summary>
Gets a string representation of the variable
</summary>
<returns>a string representation of the variable</returns>
</member>
<member name="P:PowerArgs.BooleanVariable.Not">
<summary>
Gets or sets a flag indicating that the variable's value should be negated
</summary>
</member>
<member name="P:PowerArgs.BooleanVariable.VariableName">
<summary>
The name of the variable referenced by this node
</summary>
</member>
<member name="T:PowerArgs.BooleanExpressionGroup">
<summary>
A class that represents a boolean expression that supports and, or, and grouping.
</summary>
</member>
<member name="M:PowerArgs.BooleanExpressionGroup.#ctor">
<summary>
Creates a new empty boolean expression
</summary>
</member>
<member name="M:PowerArgs.BooleanExpressionGroup.Evaluate(System.Collections.Generic.Dictionary{System.String,System.Boolean})">
<summary>
Evaluates the expression given a set of variable values
</summary>
<param name="variableValues">The value of variables that appear in the expression</param>
<returns>True if the expression was true, false otherwise</returns>
</member>
<member name="M:PowerArgs.BooleanExpressionGroup.Evaluate(PowerArgs.IBooleanVariableResolver)">
<summary>
Evaluates the expression given a variable resolver.
</summary>
<param name="resolver">An object used to resolve variables that appear in the expression</param>
<returns>True if the expression was true, false otherwise</returns>
</member>
<member name="M:PowerArgs.BooleanExpressionGroup.ToString">
<summary>
Gets a string representation of the variable
</summary>
<returns>a string representation of the variable</returns>
</member>
<member name="P:PowerArgs.BooleanExpressionGroup.Not">
<summary>
Gets or sets a flag indicating that the expression should be negated
</summary>
</member>
<member name="P:PowerArgs.BooleanExpressionGroup.Operands">
<summary>
The operands (variables or grouped child expressions) that make up this expression.
</summary>
</member>
<member name="P:PowerArgs.BooleanExpressionGroup.Operators">
<summary>
The operators to apply between each operand
</summary>
</member>
<member name="T:PowerArgs.ConsoleCharacter">
<summary>
A wrapper for char that encapsulates foreground and background colors.
</summary>
</member>
<member name="M:PowerArgs.ConsoleCharacter.#ctor(System.Char,System.Nullable{System.ConsoleColor},System.Nullable{System.ConsoleColor})">
<summary>
Create a new ConsoleCharacter given a char value and optionally set the foreground or background coor.
</summary>
<param name="value">The character value</param>
<param name="foregroundColor">The foreground color (defaults to the console's foreground color at initialization time).</param>
<param name="backgroundColor">The background color (defaults to the console's background color at initialization time).</param>
</member>
<member name="M:PowerArgs.ConsoleCharacter.Write">
<summary>
Write this formatted character to the console
</summary>
</member>
<member name="M:PowerArgs.ConsoleCharacter.ToString">
<summary>
Gets the string representation of the character
</summary>
<returns></returns>
</member>
<member name="M:PowerArgs.ConsoleCharacter.Equals(System.Object)">
<summary>
ConsoleCharacters can be compared to other ConsoleCharacter instances or char values.
</summary>
<param name="obj">The ConsoleCharacter or char to compare to.</param>
<returns></returns>
</member>
<member name="M:PowerArgs.ConsoleCharacter.op_Equality(PowerArgs.ConsoleCharacter,PowerArgs.ConsoleCharacter)">
<summary>
Operator overload for Equals
</summary>
<param name="a">The first operand</param>
<param name="b">The second operand</param>
<returns></returns>
</member>
<member name="M:PowerArgs.ConsoleCharacter.op_Inequality(PowerArgs.ConsoleCharacter,PowerArgs.ConsoleCharacter)">
<summary>
Operator overload for !Equals
</summary>
<param name="a">The first operand</param>
<param name="b">The second operand</param>
<returns></returns>
</member>
<member name="M:PowerArgs.ConsoleCharacter.op_Equality(PowerArgs.ConsoleCharacter,System.Char)">
<summary>
Operator overload for Equals
</summary>
<param name="a">The first operand</param>
<param name="b">The second operand</param>
<returns></returns>
</member>
<member name="M:PowerArgs.ConsoleCharacter.op_Inequality(PowerArgs.ConsoleCharacter,System.Char)">
<summary>
Operator overload for !Equals
</summary>
<param name="a">The first operand</param>
<param name="b">The second operand</param>
<returns></returns>
</member>
<member name="M:PowerArgs.ConsoleCharacter.GetHashCode">
<summary>
Override of GetHashcode that returns the internal char's hashcode.
</summary>
<returns>the internal char's hashcode.</returns>
</member>
<member name="P:PowerArgs.ConsoleCharacter.Value">
<summary>
The value of the character
</summary>
</member>
<member name="P:PowerArgs.ConsoleCharacter.ForegroundColor">
<summary>
The console foreground color to use when printing this character.
</summary>
</member>
<member name="P:PowerArgs.ConsoleCharacter.BackgroundColor">
<summary>
The console background color to use when printing this character.
</summary>
</member>
<member name="T:PowerArgs.ConsoleString">
<summary>
A wrapper for string that encapsulates foreground and background colors.
</summary>
</member>
<member name="M:PowerArgs.ConsoleString.#ctor">
<summary>
Create a new empty ConsoleString
</summary>
</member>
<member name="M:PowerArgs.ConsoleString.#ctor(System.String,System.Nullable{System.ConsoleColor},System.Nullable{System.ConsoleColor})">
<summary>
Create a ConsoleString given an initial text value and optional color info.
</summary>
<param name="value"></param>
<param name="foregroundColor">The foreground color (defaults to the console's foreground color at initialization time).</param>
<param name="backgroundColor">The background color (defaults to the console's background color at initialization time).</param>
</member>
<member name="M:PowerArgs.ConsoleString.Append(System.String,System.Nullable{System.ConsoleColor},System.Nullable{System.ConsoleColor})">
<summary>
Appends the given value to this ConsoleString using the given formatting.
</summary>
<param name="value"></param>
<param name="foregroundColor">The foreground color (defaults to the console's foreground color at initialization time).</param>
<param name="backgroundColor">The background color (defaults to the console's background color at initialization time).</param>
</member>
<member name="M:PowerArgs.ConsoleString.Append(PowerArgs.ConsoleString)">
<summary>
Concatenates two ConsoleStrings together.
</summary>
<param name="other">The string to append.</param>
</member>
<member name="M:PowerArgs.ConsoleString.AppendUsingCurrentFormat(System.String)">
<summary>
Appends the given value using the formatting of the last character or the default formatting if this ConsoleString is empty.
</summary>
<param name="value">The string to append.</param>
</member>
<member name="M:PowerArgs.ConsoleString.Replace(System.String,System.String,System.Nullable{System.ConsoleColor},System.Nullable{System.ConsoleColor})">
<summary>
Replaces all occurrances of the given string with the replacement value using the specified formatting.
</summary>
<param name="toFind">The substring to find</param>
<param name="toReplace">The replacement value</param>
<param name="foregroundColor">The foreground color (defaults to the console's foreground color at initialization time).</param>
<param name="backgroundColor">The background color (defaults to the console's background color at initialization time).</param>
<returns>A new ConsoleString with the replacements.</returns>
</member>
<member name="M:PowerArgs.ConsoleString.ReplaceRegex(System.String,System.String,System.Nullable{System.ConsoleColor},System.Nullable{System.ConsoleColor})">
<summary>
Replaces all matches of the given regular expression with the replacement value using the specified formatting.
</summary>
<param name="regex">The regular expression to find.</param>
<param name="toReplace">The replacement value</param>
<param name="foregroundColor">The foreground color (defaults to the console's foreground color at initialization time).</param>
<param name="backgroundColor">The background color (defaults to the console's background color at initialization time).</param>
<returns></returns>
</member>
<member name="M:PowerArgs.ConsoleString.IndexOf(System.String)">
<summary>
Finds the index of a given substring in this ConsoleString.
</summary>
<param name="toFind">The substring to search for.</param>
<returns>The first index of the given substring or -1 if the substring was not found.</returns>
</member>
<member name="M:PowerArgs.ConsoleString.Contains(System.String)">
<summary>
Determines if this ConsoleString contains the given substring.
</summary>
<param name="substr">The substring to search for.</param>
<returns>True if found, false otherwise.</returns>
</member>
<member name="M:PowerArgs.ConsoleString.Substring(System.Int32)">
<summary>
Get a substring of this ConsoleString starting at the given index.
</summary>
<param name="start">the start index.</param>
<returns>A new ConsoleString representing the substring requested.</returns>
</member>
<member name="M:PowerArgs.ConsoleString.Substring(System.Int32,System.Int32)">
<summary>
Get a substring of this ConsoleString starting at the given index and with the given length.
</summary>
<param name="start">the start index.</param>
<param name="length">the number of characters to return</param>
<returns>A new ConsoleString representing the substring requested.</returns>
</member>
<member name="M:PowerArgs.ConsoleString.Write">
<summary>
Write this ConsoleString to the console using the desired style.
</summary>
</member>
<member name="M:PowerArgs.ConsoleString.ToString">
<summary>
Get the string representation of this ConsoleString.
</summary>
<returns></returns>
</member>
<member name="M:PowerArgs.ConsoleString.Equals(System.Object)">
<summary>
Compare this ConsoleString to another ConsoleString or a plain string.
</summary>
<param name="obj">The ConsoleString or plain string to compare to.</param>
<returns>True if equal, false otherwise</returns>
</member>
<member name="M:PowerArgs.ConsoleString.CompareTo(System.String)">
<summary>
Compare this ConsoleString to another ConsoleString.
</summary>
<param name="other">The ConsoleString to compare to.</param>
<returns>True if equal, false otherwise</returns>
</member>
<member name="M:PowerArgs.ConsoleString.GetHashCode">
<summary>
Gets the hashcode of the underlying string
</summary>
<returns>the hashcode of the underlying string</returns>
</member>
<member name="M:PowerArgs.ConsoleString.op_Addition(PowerArgs.ConsoleString,PowerArgs.ConsoleString)">
<summary>
Operator overload that concatenates 2 ConsoleString instances and returns a new one.
</summary>
<param name="a">The left operand</param>
<param name="b">The right operand</param>
<returns>A new, concatenated ConsoleString</returns>
</member>
<member name="M:PowerArgs.ConsoleString.op_Addition(PowerArgs.ConsoleString,System.String)">
<summary>
Operator overload that concatenates a ConsoleString with a string and returns a new one.
</summary>
<param name="a">The left operand</param>
<param name="b">The right operand</param>
<returns>A new, concatenated ConsoleString</returns>
</member>
<member name="M:PowerArgs.ConsoleString.op_Equality(PowerArgs.ConsoleString,PowerArgs.ConsoleString)">
<summary>
Compares 2 ConsoleStrings for equality.
</summary>
<param name="a">The left operand</param>
<param name="b">The right operand</param>
<returns>True if they are the same, false otherwise</returns>
</member>
<member name="M:PowerArgs.ConsoleString.op_Inequality(PowerArgs.ConsoleString,PowerArgs.ConsoleString)">
<summary>
Compares 2 ConsoleStrings for inequality.
</summary>
<param name="a">The left operand</param>
<param name="b">The right operand</param>
<returns>False if they are the same, true otherwise</returns>
</member>
<member name="P:PowerArgs.ConsoleString.Empty">
<summary>
Represents an empty string. You will get a new instance each time you access this property.
</summary>
</member>
<member name="P:PowerArgs.ConsoleString.Length">
<summary>
The length of the string.
</summary>
</member>
<member name="T:PowerArgs.Args">
<summary>
The main entry point for PowerArgs that includes the public parsing functions such as Parse, ParseAction, and InvokeAction.
</summary>
</member>
<member name="M:PowerArgs.Args.SearchAssemblyForRevivers(System.Reflection.Assembly)">
<summary>
PowerArgs will manually search the assembly you provide for any custom type revivers. If you don't specify an
assembly then the assembly that calls this function will automatically be searched.
</summary>
<param name="a">The assembly to search or null if you want PowerArgs to search the assembly that's calling into this function.</param>
</member>
<member name="M:PowerArgs.Args.Convert(System.String)">
<summary>
Converts a single string that represents a command line to be executed into a string[],
accounting for quoted arguments that may or may not contain spaces.
</summary>
<param name="commandLine">The raw arguments as a single string</param>
<returns>a converted string array with the arguments properly broken up</returns>
</member>
<member name="M:PowerArgs.Args.GetAmbientArgs``1">
<summary>
Gets the last instance of this type of argument that was parsed on the current thread
or null if PowerArgs did not parse an object of this type.
</summary>
<typeparam name="T">The scaffold type for your arguments</typeparam>
<returns>the last instance of this type of argument that was parsed on the current thread</returns>
</member>
<member name="M:PowerArgs.Args.GetAmbientArgs(System.Type)">
<summary>
Gets the last instance of this type of argument that was parsed on the current thread
or null if PowerArgs did not parse an object of this type.
</summary>
<param name="t">The scaffold type for your arguments</param>
<returns>the last instance of this type of argument that was parsed on the current thread</returns>
</member>
<member name="M:PowerArgs.Args.ParseAction(PowerArgs.CommandLineArgumentsDefinition,System.String[])">
<summary>
Parses the given arguments using a command line arguments definition.
</summary>
<param name="definition">The definition that defines a set of command line arguments and/or actions.</param>
<param name="args">The command line arguments to parse</param>
<returns></returns>
</member>
<member name="M:PowerArgs.Args.ParseAction``1(System.String[])">
<summary>
Creates a new instance of T and populates it's properties based on the given arguments.
If T correctly implements the heuristics for Actions (or sub commands) then the complex property
that represents the options of a sub command are also populated.
</summary>
<typeparam name="T">The argument scaffold type.</typeparam>
<param name="args">The command line arguments to parse</param>
<returns>The raw result of the parse with metadata about the specified action.</returns>
</member>
<member name="M:PowerArgs.Args.ParseAction(System.Type,System.String[])">
<summary>
Creates a new instance of the given type and populates it's properties based on the given arguments.
If the type correctly implements the heuristics for Actions (or sub commands) then the complex property
that represents the options of a sub command are also populated.
</summary>
<param name="t">The argument scaffold type.</param>
<param name="args">The command line arguments to parse</param>
<returns>The raw result of the parse with metadata about the specified action.</returns>
</member>
<member name="M:PowerArgs.Args.InvokeMain(System.Type,System.String[])">
<summary>
Parses the args for the given scaffold type and then calls the Main() method defined by the type.
</summary>
<param name="t">The argument scaffold type.</param>
<param name="args">The command line arguments to parse</param>
<returns>The raw result of the parse with metadata about the specified action.</returns>
</member>
<member name="M:PowerArgs.Args.InvokeMain(PowerArgs.CommandLineArgumentsDefinition,System.String[])">
<summary>
Parses the args for the given definition and then calls the Main() method defined by the type.
</summary>
<param name="definition"></param>
<param name="args"></param>
<returns></returns>
</member>
<member name="M:PowerArgs.Args.InvokeMain``1(System.String[])">
<summary>
Parses the args for the given scaffold type and then calls the Main() method defined by the type.
</summary>
<typeparam name="T">The argument scaffold type.</typeparam>
<param name="args">The command line arguments to parse</param>
<returns>The raw result of the parse with metadata about the specified action.</returns>
</member>
<member name="M:PowerArgs.Args.InvokeAction``1(System.String[])">
<summary>
Creates a new instance of T and populates it's properties based on the given arguments. T must correctly
implement the heuristics for Actions (or sub commands) because this method will not only detect the action
specified on the command line, but will also find and execute the method that implements the action.
</summary>
<typeparam name="T">The argument scaffold type that must properly implement at least one action.</typeparam>
<param name="args">The command line arguments to parse</param>
<returns>The raw result of the parse with metadata about the specified action. The action is executed before returning.</returns>
</member>
<member name="M:PowerArgs.Args.InvokeAction(PowerArgs.CommandLineArgumentsDefinition,System.String[])">
<summary>
Parses the given arguments using a command line arguments definition. Then, invokes the action
that was specified.
</summary>
<param name="definition">The definition that defines a set of command line arguments and actions.</param>
<param name="args"></param>
<returns>The raw result of the parse with metadata about the specified action. The action is executed before returning.</returns>
</member>
<member name="M:PowerArgs.Args.Parse``1(System.String[])">
<summary>
Creates a new instance of T and populates it's properties based on the given arguments.
</summary>
<typeparam name="T">The argument scaffold type.</typeparam>
<param name="args">The command line arguments to parse</param>
<returns>A new instance of T with all of the properties correctly populated</returns>
</member>
<member name="M:PowerArgs.Args.Parse(System.Type,System.String[])">
<summary>
Creates a new instance of the given type and populates it's properties based on the given arguments.
</summary>
<param name="t">The argument scaffold type</param>
<param name="args">The command line arguments to parse</param>
<returns>A new instance of the given type with all of the properties correctly populated</returns>
</member>
<member name="M:PowerArgs.Args.Parse(PowerArgs.CommandLineArgumentsDefinition,System.String[])">
<summary>
Parses the given arguments using a command line arguments definition. The values will be populated within
the definition.
</summary>
<param name="definition">The definition that defines a set of command line arguments and/or actions.</param>
<param name="args">The command line arguments to parse</param>
</member>
<member name="T:PowerArgs.ArgUsageOptions">
<summary>
A class that lets you customize how your usage displays
</summary>
</member>
<member name="M:PowerArgs.ArgUsageOptions.#ctor">
<summary>
Creates a new instance of ArgUsageOptions
</summary>
</member>
<member name="P:PowerArgs.ArgUsageOptions.ShowType">
<summary>
Set to true if you want to show the type column (true by default)
</summary>
</member>
<member name="P:PowerArgs.ArgUsageOptions.ShowPosition">
<summary>
Set to true if you want to show the position column (true by default)
</summary>
</member>
<member name="P:PowerArgs.ArgUsageOptions.ShowPossibleValues">
<summary>
Set to true to list possible values (usually for enums, true by default)
</summary>
</member>
<member name="P:PowerArgs.ArgUsageOptions.AppendDefaultValueToDescription">
<summary>
Set to true if you want to show default values after the description (true by default)
</summary>
</member>
<member name="P:PowerArgs.ArgUsageOptions.SpecifiedActionOverride">
<summary>
Set this to ensure the usage generator only shows usage info for the specified action. You will typically
populate this by looking at the ArgException that you're probably catching.
</summary>
</member>
<member name="T:PowerArgs.UsageHook">
<summary>
An attribute used to hook into the usage generation process and influence
the content that is written.
</summary>
</member>
<member name="T:PowerArgs.IGlobalArgMetadata">
<summary>
Represents IArgMetadata that is valid for CommandLineArguments, CommandLineActions, and CommandLineArgumentsDefinition instances
</summary>
</member>
<member name="T:PowerArgs.ICommandLineArgumentMetadata">
<summary>
Represents IArgMetadata that is valid for CommandLineArguments
</summary>
</member>
<member name="T:PowerArgs.IArgMetadata">
<summary>
Any attribute that's purpose is to add information about a command line arguments definiton should
derive from this type.
</summary>
</member>
<member name="T:PowerArgs.ICommandLineActionMetadata">
<summary>
Represents IArgMetadata that is valid for CommandLineActions
</summary>
</member>
<member name="T:PowerArgs.ICommandLineArgumentsDefinitionMetadata">
<summary>
Represents IArgMetadata that is valid for CommandLineArgumentsDefinition instances
</summary>
</member>
<member name="M:PowerArgs.UsageHook.BeforeGenerateUsage(PowerArgs.ArgumentUsageInfo)">
<summary>
This hook gets called when the property it is attached to is having
its usage generated. You can override this method and manipulate the
properties of the given usage info object.
</summary>
<param name="info">An object that you can use to manipulate the usage output.</param>
</member>
<member name="E:PowerArgs.UsageHook.HookExecuting">
<summary>
An event you can subscribe to in the case where you created
your hook in running code rather than as a declarative attribute.
</summary>
</member>
<member name="T:PowerArgs.ArgumentUsageInfo">
<summary>
A class that represents usage info to be written to the console.
</summary>
</member>
<member name="M:PowerArgs.ArgumentUsageInfo.#ctor(PowerArgs.CommandLineArgument)">
<summary>
Generate a new info instance given a reflected property.
</summary>
<param name="toAutoGen">The property to use to seed the usage info</param>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.Name">
<summary>
The name that will be written as part of the usage.
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.Aliases">
<summary>
Aliases for this argument that will be honored by the parser. This
includes shortcuts and long form aliases, but can be extended further.
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.PossibleValues">
<summary>
Possible values for this option. This is auto populated for enums and includes the description if specified.
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.IsRequired">
<summary>
Indicates that the argument is required.
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.Type">
<summary>
The friendly type name that will be displayed to the user.
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.Position">
<summary>
The expected position of the argument, or null if not a positioning is not supported for the given argument.
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.Description">
<summary>
The description that will be written as part of the usage.
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.Ignore">
<summary>
If set to true, the argument usage will not be written.
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.IsAction">
<summary>
True if this is the "Action" property
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.IsActionArgs">
<summary>
True if this represents a nested action argument property
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.Property">
<summary>
The reflected property that this info object represents
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.Argument">
<summary>
The command line argument that the system is currently generating usage for
</summary>
</member>
<member name="P:PowerArgs.ArgumentUsageInfo.DefaultValue">
<summary>
The default value for the argument
</summary>
</member>
<member name="T:PowerArgs.ArgUsage">
<summary>
A helper class that generates usage documentation for your command line arguments given a custom argument
scaffolding type.
</summary>
</member>
<member name="M:PowerArgs.ArgUsage.RegisterHook(System.Reflection.PropertyInfo,PowerArgs.UsageHook)">
<summary>
Registers a usage hook for the given property.
</summary>
<param name="prop">The property to hook into or null to hook into all properties.</param>
<param name="hook">The hook implementation.</param>
</member>
<member name="M:PowerArgs.ArgUsage.GenerateUsageFromTemplate``1(System.String)">
<summary>
Generates a usage document given a template
</summary>
<typeparam name="T">The command line argument definition scaffold type</typeparam>
<param name="template">The template to use or null to use the default template that's built into PowerArgs</param>
<returns>The usage document</returns>
</member>
<member name="M:PowerArgs.ArgUsage.GenerateUsageFromTemplate(System.Type,System.String)">
<summary>
Generates a usage document given a template
</summary>
<param name="t">The command line argument definition scaffold type</param>
<param name="template">The template to use or null to use the default template that's built into PowerArgs</param>
<returns>The usage document</returns>
</member>
<member name="M:PowerArgs.ArgUsage.GenerateUsageFromTemplate(PowerArgs.CommandLineArgumentsDefinition,System.String,System.String)">
<summary>
Generates a usage document given a template
</summary>
<param name="def">The object that describes your program</param>
<param name="template">The template to use or null to use the default template that's built into PowerArgs</param>
<param name="templateSourceLocation">The source of the template, usually a file name</param>
<returns>The usage document</returns>
</member>
<member name="M:PowerArgs.ArgUsage.ShowUsageInBrowser``1(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Generates web browser friendly usage documentation for your program and opens it using the local machine's default browser.
</summary>
<typeparam name="T">The command line argument definition scaffold type</typeparam>
<param name="template">The template to use or null to use the default browser friendly template that's built into PowerArgs</param>
<param name="outputFileName">Where to save the output (the browser will open the file from here)</param>
<param name="deleteFileAfterBrowse">True if the file should be deleted after browsing</param>
<param name="waitForBrowserExit">True if you'd like this method to block until the browser is closed. This only works for browsers that start a new process when opened with a document.</param>
<returns>The usage document as a string</returns>
</member>
<member name="M:PowerArgs.ArgUsage.ShowUsageInBrowser(PowerArgs.CommandLineArgumentsDefinition,System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Generates web browser friendly usage documentation for your program and opens it using the local machine's default browser.
</summary>
<param name="def">The object that describes your program</param>
<param name="template">The template to use or null to use the default browser friendly template that's built into PowerArgs</param>
<param name="outputFileName">Where to save the output (the browser will open the file from here)</param>
<param name="deleteFileAfterBrowse">True if the file should be deleted after browsing</param>
<param name="waitForBrowserExit">True if you'd like this method to block until the browser is closed. This only works for browsers that start a new process when opened with a document.</param>
<returns>The usage document as a string</returns>
</member>
<member name="M:PowerArgs.ArgUsage.GetUsage``1(System.String,PowerArgs.ArgUsageOptions)">
<summary>
Generates usage documentation for the given argument scaffold type.
</summary>
<typeparam name="T">Your custom argument scaffold type</typeparam>
<param name="exeName">The name of your program or null if you want PowerArgs to automatically detect it.</param>
<param name="options">Specify custom usage options</param>
<returns>the usage documentation as a string</returns>
</member>
<member name="M:PowerArgs.ArgUsage.GetUsage(PowerArgs.CommandLineArgumentsDefinition,System.String,PowerArgs.ArgUsageOptions)">
<summary>
Generates usage documentation for the given argument definition.
</summary>
<param name="definition">The definition of the command line arguments for a program</param>
<param name="exeName">The name of your program or null if you want PowerArgs to automatically detect it.</param>
<param name="options">Specify custom usage options</param>
<returns>the usage documentation as a string</returns>
</member>
<member name="M:PowerArgs.ArgUsage.GetStyledUsage``1(System.String,PowerArgs.ArgUsageOptions)">
<summary>
Generates color styled usage documentation for the given argument scaffold type.
</summary>
<typeparam name="T">Your custom argument scaffold type</typeparam>
<param name="exeName">The name of your program or null if you want PowerArgs to automatically detect it.</param>
<param name="options">Specify custom usage options</param>
<returns>the usage documentation as a styled string that can be printed to the console</returns>
</member>
<member name="M:PowerArgs.ArgUsage.GetStyledUsage(System.Type,System.String,PowerArgs.ArgUsageOptions)">
<summary>
Generates color styled usage documentation for the given argument scaffold type.
</summary>
<param name="t">Your custom argument scaffold type</param>
<param name="exeName">The name of your program or null if you want PowerArgs to automatically detect it.</param>
<param name="options">Specify custom usage options</param>
<returns>the usage documentation as a styled string that can be printed to the console</returns>
</member>
<member name="M:PowerArgs.ArgUsage.GetStyledUsage(PowerArgs.CommandLineArgumentsDefinition,System.String,PowerArgs.ArgUsageOptions)">
<summary>
Generates color styled usage documentation for the given arguments definition.
</summary>
<param name="definition">The definition of the command line arguments for a program</param>
<param name="exeName">The name of your program or null if you want PowerArgs to automatically detect it.</param>
<param name="options">Specify custom usage options</param>
<returns>the usage documentation as a styled string that can be printed to the console</returns>
</member>
<member name="T:PowerArgs.EasterEggs.MatrixMode">
<summary>
An easter egg that makes all command line output get written in a green themed, futuristic fasion. Don't use in a real program :).
Breaking changes are allowed in the PowerArgs.EasterEggs namespace.
</summary>
</member>
<member name="M:PowerArgs.EasterEggs.MatrixMode.Start">
<summary>
Starts MatrixMode.
</summary>
<returns>An action that when invoked stops MatrixMode.</returns>
</member>
<member name="T:PowerArgs.ArgException">
<summary>
An exception that should be thrown when the error condition is caused because of bad user input.
</summary>
</member>
<member name="M:PowerArgs.ArgException.#ctor(System.String)">
<summary>
Creates a new ArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
</member>
<member name="M:PowerArgs.ArgException.#ctor(System.String,System.Exception)">
<summary>
Creates a new ArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
<param name="inner">The inner exception that caused the problem</param>
</member>
<member name="P:PowerArgs.ArgException.Context">
<summary>
The parser context that may be incomplete since it depends on where the exception was thrown
</summary>
</member>
<member name="T:PowerArgs.InvalidArgDefinitionException">
<summary>
An exception that should be thrown when the error condition is caused by an improperly formed
argument scaffold type. For example if the user specified the same shortcut value for more than one property.
</summary>
</member>
<member name="M:PowerArgs.InvalidArgDefinitionException.#ctor(System.String)">
<summary>
Creates a new InvalidArgDefinitionException given a message.
</summary>
<param name="msg">An error message.</param>
</member>
<member name="M:PowerArgs.InvalidArgDefinitionException.#ctor(System.String,System.Exception)">
<summary>
Creates a new InvalidArgDefinitionException given a message.
</summary>
<param name="msg">An error message.</param>
<param name="inner">The inner exception that caused the problem</param>
</member>
<member name="T:PowerArgs.UnexpectedArgException">
<summary>
An exception that should be thrown when an unexpected named|positional argument is found.
</summary>
</member>
<member name="M:PowerArgs.UnexpectedArgException.#ctor(System.String)">
<summary>
Creates a new UnexpectedArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
</member>
<member name="M:PowerArgs.UnexpectedArgException.#ctor(System.String,System.Exception)">
<summary>
Creates a new UnexpectedArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
<param name="inner">The inner exception that caused the problem</param>
</member>
<member name="T:PowerArgs.DuplicateArgException">
<summary>
An exception that should be thrown when the same argument is repeated.
</summary>
</member>
<member name="M:PowerArgs.DuplicateArgException.#ctor(System.String)">
<summary>
Creates a new DuplicateArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
</member>
<member name="M:PowerArgs.DuplicateArgException.#ctor(System.String,System.Exception)">
<summary>
Creates a new DuplicateArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
<param name="inner">The inner exception that caused the problem</param>
</member>
<member name="T:PowerArgs.MissingArgException">
<summary>
An exception that should be thrown when a required argument is missing.
</summary>
</member>
<member name="M:PowerArgs.MissingArgException.#ctor(System.String)">
<summary>
Creates a new MissingArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
</member>
<member name="M:PowerArgs.MissingArgException.#ctor(System.String,System.Exception)">
<summary>
Creates a new MissingArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
<param name="inner">The inner exception that caused the problem</param>
</member>
<member name="T:PowerArgs.UnknownActionArgException">
<summary>
An exception that should be thrown when an unknown action argument is specified.
</summary>
</member>
<member name="M:PowerArgs.UnknownActionArgException.#ctor(System.String)">
<summary>
Creates a new UnknownActionArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
</member>
<member name="M:PowerArgs.UnknownActionArgException.#ctor(System.String,System.Exception)">
<summary>
Creates a new UnknownActionArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
<param name="inner">The inner exception that caused the problem</param>
</member>
<member name="T:PowerArgs.QueryInvalidArgException">
<summary>
An exception that should be thrown when the query can not be compiled.
</summary>
</member>
<member name="M:PowerArgs.QueryInvalidArgException.#ctor(System.String)">
<summary>
Creates a new QueryInvalidArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
</member>
<member name="M:PowerArgs.QueryInvalidArgException.#ctor(System.String,System.Exception)">
<summary>
Creates a new QueryInvalidArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
<param name="inner">The inner exception that caused the problem</param>
</member>
<member name="T:PowerArgs.ValidationArgException">
<summary>
An exception that should be thrown when an argument's value is not valid.
</summary>
</member>
<member name="M:PowerArgs.ValidationArgException.#ctor(System.String)">
<summary>
Creates a new ValidationArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
</member>
<member name="M:PowerArgs.ValidationArgException.#ctor(System.String,System.Exception)">
<summary>
Creates a new ValidationArgException given a user friendly message
</summary>
<param name="msg">A user friendly message.</param>
<param name="inner">The inner exception that caused the problem</param>
</member>
<member name="T:PowerArgs.ITabCompletionSource">
<summary>
An interface used to implement custom tab completion logic.
</summary>
</member>
<member name="M:PowerArgs.ITabCompletionSource.TryComplete(System.Boolean,System.String,System.String@)">
<summary>
PowerArgs will call this method if it has enhanced the command prompt and the user presses tab. You should use the
text the user has types so far to determine if there is a completion you'd like to make. If you find a completion
then you should assign it to the completion variable and return true.
</summary>
<param name="shift">Indicates if shift was being pressed</param>
<param name="soFar">The text token that the user has typed before pressing tab.</param>
<param name="completion">The variable that you should assign the completed string to if you find a match.</param>
<returns>True if you completed the string, false otherwise.</returns>
</member>
<member name="T:PowerArgs.IConsoleProvider">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="M:PowerArgs.IConsoleProvider.ReadKey">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="M:PowerArgs.IConsoleProvider.Write(System.Object)">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="M:PowerArgs.IConsoleProvider.WriteLine(System.Object)">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="M:PowerArgs.IConsoleProvider.WriteLine">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="M:PowerArgs.IConsoleProvider.Clear">
<summary>
Clears the console window
</summary>
</member>
<member name="P:PowerArgs.IConsoleProvider.CursorLeft">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="P:PowerArgs.IConsoleProvider.CursorTop">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="P:PowerArgs.IConsoleProvider.BufferWidth">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="T:PowerArgs.StdConsoleProvider">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="M:PowerArgs.StdConsoleProvider.ReadKey">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
<returns>Used for internal implementation, but marked public for testing, please do not use.</returns>
</member>
<member name="M:PowerArgs.StdConsoleProvider.Write(System.Object)">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
<param name="output">Used for internal implementation, but marked public for testing, please do not use.</param>
</member>
<member name="M:PowerArgs.StdConsoleProvider.WriteLine(System.Object)">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
<param name="output">Used for internal implementation, but marked public for testing, please do not use.</param>
</member>
<member name="M:PowerArgs.StdConsoleProvider.WriteLine">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="M:PowerArgs.StdConsoleProvider.ReadALineOfConsoleOutput(System.Int32)">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
<param name="y">Used for internal implementation, but marked public for testing, please do not use.</param>
<returns>Used for internal implementation, but marked public for testing, please do not use.</returns>
</member>
<member name="M:PowerArgs.StdConsoleProvider.Clear">
<summary>
Clears the console
</summary>
</member>
<member name="P:PowerArgs.StdConsoleProvider.CursorLeft">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="P:PowerArgs.StdConsoleProvider.CursorTop">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="P:PowerArgs.StdConsoleProvider.BufferWidth">
<summary>
Used for internal implementation, but marked public for testing, please do not use.
</summary>
</member>
<member name="T:PowerArgs.IUsageTemplateProvider">
<summary>
An interface that defines how usage templates should be retrieved
</summary>
</member>
<member name="M:PowerArgs.IUsageTemplateProvider.GetTemplate">
<summary>
Gets the usage template to render
</summary>
<returns>usage template to render</returns>
</member>
<member name="T:PowerArgs.DefaultConsoleUsageTemplateProvider">
<summary>
A usage template provider that returns the default console usage template
</summary>
</member>
<member name="M:PowerArgs.DefaultConsoleUsageTemplateProvider.GetTemplate">
<summary>
gets the default console usage template
</summary>
<returns>the default console usage template</returns>
</member>
<member name="T:PowerArgs.DefaultBrowserUsageTemplateProvider">
<summary>
A usage template provider that returns the default browser usage template
</summary>
</member>
<member name="M:PowerArgs.DefaultBrowserUsageTemplateProvider.GetTemplate">
<summary>
gets the default browser usage template
</summary>
<returns>the default browser usage template</returns>
</member>
<member name="T:PowerArgs.ParseResult">
<summary>
The raw parse result that contains the dictionary of values that were parsed
</summary>
</member>
<member name="P:PowerArgs.ParseResult.ExplicitParameters">
<summary>
Dictionary of values that were either in the format -key value or /key:value on
the command line.
</summary>
</member>
<member name="P:PowerArgs.ParseResult.ImplicitParameters">
<summary>
Dictionary of values that were implicitly specified by position where the key is the position (e.g. 0)
and the value is the actual parameter value.
Example command line: Program.exe John Smith
John would be an implicit parameter at position 0.
Smith would be an implicit parameter at position 1.
</summary>
</member>
<member name="T:PowerArgs.Resources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:PowerArgs.Resources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:PowerArgs.Resources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:PowerArgs.Resources.DefaultBrowserUsageTemplate">
<summary>
Looks up a localized string similar to <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>{{ExeName!}} documentation</title>
</head>
<body>
<h1 class="program-specific-content">{{ExeName!}}</h1>
<p class="program-specific-content">{{Description!}}</p>
<h2>Usage</h2>
<pre class="code-sample">{{UsageSummaryHTMLEncoded!}}</pre>
{{if HasGlobalArguments}}
{{if HasActions}}<h2>Global options</h2>!{{if}}
{{ifnot HasActions}}<h2>Options</h2>!{{ifnot}}
<table>
<tr>
<td class="option-col table-header [rest of string was truncated]";.
</summary>
</member>
<member name="P:PowerArgs.Resources.DefaultConsoleUsageTemplate">
<summary>
Looks up a localized string similar to {{ifnot HasSpecifiedAction}}
Usage - {{UsageSummary Cyan!}}
!{{ifnot}}
{{if HasGlobalArguments}}
{{if HasActions}}Global options!{{if}}{{ifnot HasActions}}Options!{{ifnot}}:
{{table Arguments DefaultAlias>Option Description !}}
!{{if}}
{{if HasActions}}
{{if HasSpecifiedAction}}
Usage - {{ExeName Cyan!}} {{SpecifiedAction.UsageSummary Cyan!}}
{{if SpecifiedAction.HasArguments }}
{{SpecifiedAction.DefaultAlias!}} Options:
{{table SpecifiedAction.Arguments DefaultAlias>Name Description !}}
[rest of string was truncated]";.
</summary>
</member>
<member name="P:PowerArgs.Resources.QueryTemplate">
<summary>
Looks up a localized string similar to using System;
using System.Linq;
using System.Collections.Generic;
$Usings$
namespace $Namespace$
{
public class $Class$
{
public static List<$ReturnType$> $Method$(IEnumerable<$ReturnType$> source)
{
IEnumerable<$ReturnType$> query = from item in source select item;
$WhereComment$ query = from item in query where $Where$ select item;
$OrderByDescendingComment$ query = query.OrderByDescending($OrderByDescending$);
[rest of string was truncated]";.
</summary>
</member>
<member name="T:PowerArgs.DocumentRendererContext">
<summary>
An object that tracks information about document rendering
</summary>
</member>
<member name="M:PowerArgs.DocumentRendererContext.#ctor(System.Object)">
<summary>
Creates a render context from a root data object
</summary>
<param name="rootDataObject">The root data object that will be bound to a template</param>
</member>
<member name="M:PowerArgs.DocumentRendererContext.RenderDynamicContent(System.String,PowerArgs.DocumentToken)">
<summary>
Dynamically renders the given template.
</summary>
<param name="dynamicTemplate">The template to render</param>
<param name="nestedToken">The token in the original document that resulted in dynamic rendering</param>
<returns>The rendered content</returns>
</member>
<member name="M:PowerArgs.DocumentRendererContext.RenderBody(System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Renders the given tokens, which are generally the body of a replacement expression.
</summary>
<param name="body">The tokens to render</param>
<returns>the rendered content</returns>
</member>
<member name="M:PowerArgs.DocumentRendererContext.EvaluateExpression(System.String)">
<summary>
Evaluates the given expression and returns the result. The expression can refer to a local variable (e.g. 'somevariable'),
a path starting from a localVariable (e.g. 'somevariable.SomeProperty.SomeOtherProperty'), or a path starting from the root
data object (e.g. if the root was of type 'Person' you could say 'FirstName', assuming the Person type has a property called 'FirstName').
</summary>
<param name="expressionText">The expression text</param>
<returns>The resolved value as a .NET object</returns>
</member>
<member name="P:PowerArgs.DocumentRendererContext.LocalVariables">
<summary>
The current set of local variables that can be referenced by a template
</summary>
</member>
<member name="P:PowerArgs.DocumentRendererContext.RootDataObject">
<summary>
The root data object that is bound to the document template
</summary>
</member>
<member name="P:PowerArgs.DocumentRendererContext.DocumentRenderer">
<summary>
The object that is currently rendering a document
</summary>
</member>
<member name="T:PowerArgs.TemplateExpression">
<summary>
A document expression that can render a named template
</summary>
</member>
<member name="T:PowerArgs.IDocumentExpression">
<summary>
An interface that defines a signature for evaluating an expression against a data context to render a ConsoleString.
</summary>
</member>
<member name="M:PowerArgs.IDocumentExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
The expression should use it's metadata to evaluate itself against the given data context.
</summary>
<param name="context">The data context</param>
<returns>The evaluated ConsoleString.</returns>
</member>
<member name="M:PowerArgs.TemplateExpression.#ctor(PowerArgs.DocumentToken,PowerArgs.DocumentToken)">
<summary>
Creates a new template expression given an id token and a data evaluation token.
</summary>
<param name="idToken">A token containing the id of the template to render</param>
<param name="evalToken">A token containing an expression to be evaluated. The result of the evaluation will be
used as the root data object to be bound to the named template.</param>
</member>
<member name="M:PowerArgs.TemplateExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
Finds the matching template from the data context, evaluates the data expression, then renders
the template against the data. The rendered document is inserted into the parent document.
</summary>
<param name="context">The data context used to find the named template and to evaluate the data expression</param>
<returns>The rendered child document to be inserted into the parent document</returns>
</member>
<member name="P:PowerArgs.TemplateExpression.IdToken">
<summary>
A token containing the id of the template to render
</summary>
</member>
<member name="P:PowerArgs.TemplateExpression.EvalToken">
<summary>
A token containing an expression to be evaluated. The result of the evaluation
will be used as the root data object to be bound to the named template.
</summary>
</member>
<member name="T:PowerArgs.TemplateExpressionProvider">
<summary>
A provider that can create a template expression from a replacement token and parameters.
</summary>
</member>
<member name="T:PowerArgs.IDocumentExpressionProvider">
<summary>
An object that can take a replacement key, a set of parameters, an optional body, and transform it into a document expression.
</summary>
</member>
<member name="M:PowerArgs.IDocumentExpressionProvider.CreateExpression(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken},System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Transforms a replacement key, parameters, and body into a document expression
</summary>
<param name="replacementKeyToken">The replacement key (e.g. 'each' in {{each foo in bar }})</param>
<param name="parameters">The parameters that were provided in the replacement tag. Whitespace has not been removed for you.</param>
<param name="body">The contents of the doucment that are inside of the replacement tag</param>
<returns>The formal expression that can be evaluated into text</returns>
</member>
<member name="M:PowerArgs.TemplateExpressionProvider.CreateExpression(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken},System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates a template expression given a replacement token and parameters.
</summary>
<param name="replacementKeyToken">The token whose value should be 'template'</param>
<param name="parameters">There should be 2 parameters. One representing the name of the template to render and one representing the data to bind to the template.</param>
<param name="body">Should be empty. Template expressions do not support a body.</param>
<returns>a template expression</returns>
</member>
<member name="T:PowerArgs.TableExpression">
<summary>
A document expression that can be used to render a table that is specifically formatted to display
in a console window.
</summary>
</member>
<member name="M:PowerArgs.TableExpression.#ctor(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates a new table expression given a collection evaluation expression and a list of column tokens
</summary>
<param name="evalToken">A token containing an expression that should evaluate to an IEnumerable</param>
<param name="columns">A list of tokens containing the names of columns to display in the table</param>
</member>
<member name="M:PowerArgs.TableExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
Renders the table given a data context
</summary>
<param name="context">the data context</param>
<returns>the console friendly table, as a ConsoleString</returns>
</member>
<member name="M:PowerArgs.TableExpression.FormatAsTable(System.Collections.Generic.List{PowerArgs.ConsoleString},System.Collections.Generic.List{System.Collections.Generic.List{PowerArgs.ConsoleString}},System.String)">
<summary>
Formats the given column headers and rows as a table.
</summary>
<param name="columns">The column headers</param>
<param name="rows">The row data</param>
<param name="rowPrefix">A string to prepend to each row. This can be used to indent a table.</param>
<returns>The rendered table as a ConsoleString</returns>
</member>
<member name="P:PowerArgs.TableExpression.EvalToken">
<summary>
The token representing the expression to evaluate. The expression is expected to resolve to
an IEnumerable.
</summary>
</member>
<member name="P:PowerArgs.TableExpression.Columns">
<summary>
The tokens that represent the columns to display. Each value is expected to be a property name. Optionally, you can
override the display name by appending '>NewDisplayName' to the value. For example, if there was a property called 'TheName'
and you wanted it to display as 'Name' then the value of the column token would be 'TheName>Name'.
</summary>
</member>
<member name="P:PowerArgs.TableExpression.ShowPossibleValuesForArguments">
<summary>
PowerArgs specific property - Set to false if using outside of Powerargs - If true then properties that are enums
will have their values inserted into the table.
</summary>
</member>
<member name="P:PowerArgs.TableExpression.ShowDefaultValuesForArguments">
<summary>
PowerArgs specific property - Set to false if using outside of Powerargs - If true then the properties that have a default
value will have that inserted into the table
</summary>
</member>
<member name="T:PowerArgs.TableExpressionProvider">
<summary>
A provider that can create a table expression given a replacement token and parameters.
</summary>
</member>
<member name="M:PowerArgs.TableExpressionProvider.CreateExpression(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken},System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates a table expression from the given document info.
</summary>
<param name="replacementKeyToken">The token that should contain a value of 'table'</param>
<param name="parameters">Replacement parameters that should be column names and optional properties</param>
<param name="body">Should be empty. Table expressions don't support bodies</param>
<returns>The created document expression</returns>
</member>
<member name="T:PowerArgs.VarExpression">
<summary>
An expression that indicates the beginning of a local variable's scope
</summary>
</member>
<member name="M:PowerArgs.VarExpression.#ctor(PowerArgs.DocumentToken,PowerArgs.DocumentToken)">
<summary>
Creates a new variable expression given a name and value expression
</summary>
<param name="name">A token containing the name of the local variable to initialize</param>
<param name="value">A token containing an expression that should resolve to the initial value of the variable</param>
</member>
<member name="M:PowerArgs.VarExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
Always results in an empty string, but initializes the local value in the data context
</summary>
<param name="context">The data context used to store the newly initialized variable</param>
<returns>an empty string</returns>
</member>
<member name="P:PowerArgs.VarExpression.NameToken">
<summary>
A token containing the name of the local variable to initialize
</summary>
</member>
<member name="P:PowerArgs.VarExpression.ValueToken">
<summary>
A token containing an expression that should resolve to the initial value of the variable
</summary>
</member>
<member name="T:PowerArgs.ClearVarExpression">
<summary>
An expression that indicates the end of a local variable's scope
</summary>
</member>
<member name="M:PowerArgs.ClearVarExpression.#ctor(PowerArgs.DocumentToken)">
<summary>
Creates a new clear variable expression given a variable name
</summary>
<param name="name">A token containing the name of the variable whose scope is ending</param>
</member>
<member name="M:PowerArgs.ClearVarExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
Removes the named variable from the context's local variable set
</summary>
<param name="context">the context that should contain the local variable to remove</param>
<returns>an empty string</returns>
</member>
<member name="P:PowerArgs.ClearVarExpression.NameToken">
<summary>
A token containing the name of the variable whose scope is ending
</summary>
</member>
<member name="T:PowerArgs.VarExpressionProvider">
<summary>
A provider that can create a variable expression
</summary>
</member>
<member name="M:PowerArgs.VarExpressionProvider.CreateExpression(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken},System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates a variable expression given replacement info
</summary>
<param name="replacementKeyToken">The replacement key token that should have a value of 'var'</param>
<param name="parameters">There should be 2 parameters. The name of the variable and the initial value.</param>
<param name="body">There should be no body</param>
<returns>A variable expression</returns>
</member>
<member name="T:PowerArgs.ClearVarExpressionProvider">
<summary>
A provider that can create an expression to clear a local variable
</summary>
</member>
<member name="M:PowerArgs.ClearVarExpressionProvider.CreateExpression(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken},System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates a clear variable expression given replacement info
</summary>
<param name="replacementKeyToken">The replacement key token that should have a value of 'clearvar'</param>
<param name="parameters">There should be 1 parameter, the name of the variable.</param>
<param name="body">There should be no body</param>
<returns>a clear variable expression</returns>
</member>
<member name="T:PowerArgs.EvalExpression">
<summary>
The core expression that knows how to evaluate C# object expressions like property navigation, including indexed properties.
</summary>
</member>
<member name="M:PowerArgs.EvalExpression.#ctor(PowerArgs.DocumentToken)">
<summary>
Creates an eval expression given a token that represents the expression to evaluate
</summary>
<param name="evalToken">The token containing the expression to evaluate</param>
</member>
<member name="M:PowerArgs.EvalExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
Evaluates the evaluation expression against a data context, optionally setting the console color if the expression contains those parameters
</summary>
<param name="context">The datta context to evaluate against</param>
<returns>The result of the evaluation as a ConsoleString</returns>
</member>
<member name="P:PowerArgs.EvalExpression.EvalToken">
<summary>
Gets the evaluation token that will be evaluated against a data context
</summary>
</member>
<member name="P:PowerArgs.EvalExpression.ForegroundColorToken">
<summary>
The optional foreground color token that can be used to customize the color of the resulting value
</summary>
</member>
<member name="P:PowerArgs.EvalExpression.BackgroundColorToken">
<summary>
The optional background color token that can be used to customize the color of the resulting value
</summary>
</member>
<member name="P:PowerArgs.EvalExpression.FG">
<summary>
Gets the ConsoleColor that matches the provided foreground color token, if it was provided.
</summary>
</member>
<member name="P:PowerArgs.EvalExpression.BG">
<summary>
Gets the ConsoleColor that matches the provided background color token, if it was provided.
</summary>
</member>
<member name="T:PowerArgs.EvalExpressionProvider">
<summary>
The provider that can create an eval expression from template replacement info
</summary>
</member>
<member name="M:PowerArgs.EvalExpressionProvider.CreateExpression(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken},System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates an eval expression given template replacement info
</summary>
<param name="replacementKeyToken">The replacement key token which in this case is the evaluation expression</param>
<param name="parameters">Optional parameters for foreground and background colors. The values should be valid ConsoleColor values.</param>
<param name="body">Should be empty. Eval expressions don't support bodies.</param>
<returns></returns>
</member>
<member name="T:PowerArgs.EachExpression">
<summary>
An expression used to expand a portion of a document template for each element in a collection
</summary>
</member>
<member name="M:PowerArgs.EachExpression.#ctor(PowerArgs.DocumentToken,PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates a new each expression given an iteration variable name, a collection expression, and a body.
</summary>
<param name="iterationVariable">The name to assign to ther variable representing the current element in the template</param>
<param name="collectionExpression">The expression used to determine the collection to enumerate</param>
<param name="body">The body of the each loop</param>
</member>
<member name="M:PowerArgs.EachExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
Evaluates the each loop
</summary>
<param name="context">The context that contains information about the document being rendered</param>
<returns>The rendered contents of the each loop</returns>
</member>
<member name="P:PowerArgs.EachExpression.IterationVariableNameToken">
<summary>
Gets the token in the document that represents the iteration variable name (e.g. 'element' in {{each element in collection}})
</summary>
</member>
<member name="P:PowerArgs.EachExpression.CollectionVariableExpressionToken">
<summary>
Gets the token in the document that represents the collection evaluation expression (e.g. 'collection' in {{each element in collection}})
</summary>
</member>
<member name="P:PowerArgs.EachExpression.Body">
<summary>
Gets the body of the each expression. This body will be evaluated once fore each element in the collection.
</summary>
</member>
<member name="T:PowerArgs.EachExpressionProvider">
<summary>
A class that can take in document replacement info and convert it into a document expression that represents an each loop.
</summary>
</member>
<member name="M:PowerArgs.EachExpressionProvider.CreateExpression(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken},System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Takes in document replacement info and converts it into a document expression that represents an each loop.
</summary>
<param name="replacementKeyToken">The token that is expected to have a value of 'each'</param>
<param name="parameters">The parameters which should follow the format ITERATION_VARIABLE_NAME in COLLECTION_EXPRESSION</param>
<param name="body">The body of the each loop</param>
<returns>The parsed each expression</returns>
</member>
<member name="T:PowerArgs.ConsoleColorStackElement">
<summary>
An element that can be used to track the state of the renderer's colors as expressions are being evaluated
</summary>
</member>
<member name="P:PowerArgs.ConsoleColorStackElement.FG">
<summary>
An optional foreground color value
</summary>
</member>
<member name="P:PowerArgs.ConsoleColorStackElement.BG">
<summary>
An optional background color value
</summary>
</member>
<member name="T:PowerArgs.LocalVariableSet">
<summary>
A class that lets the document renderer track local variable state as expressions are being evaluated
</summary>
</member>
<member name="M:PowerArgs.LocalVariableSet.#ctor">
<summary>
Creates a new local variable set
</summary>
</member>
<member name="M:PowerArgs.LocalVariableSet.PushConsoleColors(System.Nullable{System.ConsoleColor},System.Nullable{System.ConsoleColor})">
<summary>
Sets the current console color variables to the given values, pushing the existing values onto a stack
</summary>
<param name="fg">The optional foreground color to set</param>
<param name="bg">The optional background color to set</param>
</member>
<member name="M:PowerArgs.LocalVariableSet.PopConsoleColors">
<summary>
Pops the latest console colors off of the stack and sets them as the current colors to use.
</summary>
</member>
<member name="M:PowerArgs.LocalVariableSet.Add(PowerArgs.DocumentToken,System.Object)">
<summary>
Adds a new local variable. This will throw if there's already a variable defined with the given identifier
</summary>
<param name="variableToken">The token containing the identifier of the variable name</param>
<param name="value">The initial value of the local variable</param>
</member>
<member name="M:PowerArgs.LocalVariableSet.Force(System.String,System.Object)">
<summary>
Forefully sets the value of a local value, regardless of whether or not that variable is already defined.
</summary>
<param name="variableName">The name of the variable</param>
<param name="value">The value of the variable</param>
</member>
<member name="M:PowerArgs.LocalVariableSet.Remove(PowerArgs.DocumentToken)">
<summary>
Removes a local variable. This will throw if there is no variable with the given name
</summary>
<param name="variableToken">The token containing the identifier of the variable to remove</param>
</member>
<member name="M:PowerArgs.LocalVariableSet.ForceClear(System.String)">
<summary>
Tries to remove a variable, and does not throw if the variable is not defined.
</summary>
<param name="variableName">The name of the variable to clear</param>
</member>
<member name="M:PowerArgs.LocalVariableSet.IsDefined(System.String)">
<summary>
Determines if the given variable is defined
</summary>
<param name="variableName">The name to check</param>
<returns>True if the variable is defined, false otherwise</returns>
</member>
<member name="M:PowerArgs.LocalVariableSet.TryParseLocalVariable(System.String,System.Object@,System.String@)">
<summary>
Tries to parse a local variable from an expression. If successful the expression is evaluated then the local variable is returned via an out variable.
If there was more to the expression, a property navigation for example, then that is also passed to the caller via an out variable.
</summary>
<param name="expression">The expression that may refer to a local variable</param>
<param name="result">The local variable that is set if a local variable was matched</param>
<param name="restOfExpression">The rest of the expression that came after the local variable identifier</param>
<returns>True if a local variable was parsed, false otherwise</returns>
</member>
<member name="P:PowerArgs.LocalVariableSet.CurrentForegroundColor">
<summary>
Gets the current foreground color that is in scope or null if it is not currently defined
</summary>
</member>
<member name="P:PowerArgs.LocalVariableSet.CurrentBackgroundColor">
<summary>
Gets the current background color that is in scope or null if it is not currently defined
</summary>
</member>
<member name="P:PowerArgs.LocalVariableSet.Item(System.String)">
<summary>
Gets the value of a local variable given an identifier
</summary>
<param name="variableName">the name of the variable to lookup</param>
<returns></returns>
</member>
<member name="T:PowerArgs.DynamicExpressionProviderAttribute">
<summary>
An attribute that can be added to a class that implements IDocumentExpressionProvider. This attributes indicates that the provider can be
dynamically registered.
</summary>
</member>
<member name="M:PowerArgs.DynamicExpressionProviderAttribute.#ctor(System.String)">
<summary>
Creates a new DynamicExpressionProviderAttribute given a key
</summary>
<param name="key"></param>
</member>
<member name="P:PowerArgs.DynamicExpressionProviderAttribute.Key">
<summary>
The replacement key (e.g. 'each' in {{each foo in bar }}) to use when the given provider is registered
</summary>
</member>
<member name="T:PowerArgs.DocumentExpressionParser">
<summary>
A class that can parse a collection of document tokens into a collection of expressions
</summary>
</member>
<member name="M:PowerArgs.DocumentExpressionParser.#ctor">
<summary>
Creates a new document expression parser and registers the built in expression provider types.
</summary>
</member>
<member name="M:PowerArgs.DocumentExpressionParser.RegisterDynamicReplacementExpressionProviders(System.Reflection.Assembly,System.Boolean)">
<summary>
Searches the given assembly for IDocumentExpressionProvider types that have the DynamicExpressionProviderAttribute attribute and registers those providers
with this parser. The type needs to have a default constructor.
</summary>
<param name="target">The assembly to search</param>
<param name="allowOverrideExistingKeys">If true, providers with keys that are already exist with override the existing providers. If false, an exception will be thrown if a conflict is found.</param>
</member>
<member name="M:PowerArgs.DocumentExpressionParser.RegisterReplacementExpressionProvider(System.String,PowerArgs.IDocumentExpressionProvider,System.Boolean)">
<summary>
Manually registers the given expression provider using the given key.
</summary>
<param name="replacementKey">The unique key for the replacement provider (e.g. 'each' in {{each foo in bar}}</param>
<param name="provider">The provider to register</param>
<param name="allowOverrideExistingKeys">If true, allow this provider to replace an existing provider registered with the same key . If false, an exception will be thrown if a conflict is found.</param>
</member>
<member name="M:PowerArgs.DocumentExpressionParser.UnregisterReplacementExpressionProvider(System.String)">
<summary>
Unregisters the expression provider with the given key
</summary>
<param name="replacementKey">The key of the provider to unregister</param>
</member>
<member name="M:PowerArgs.DocumentExpressionParser.Parse(System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Parses the given tokens into document expressions that can then be evaluated against a data context.
</summary>
<param name="tokens">The tokens to parse</param>
<returns>a list of document expressions</returns>
</member>
<member name="P:PowerArgs.DocumentExpressionParser.RegisteredReplacementExpressionProviderKeys">
<summary>
Gets a list of registered expression provider keys
</summary>
</member>
<member name="T:PowerArgs.PlainTextDocumentExpression">
<summary>
A document expression that represents plain text with no replacements or custom logic
</summary>
</member>
<member name="F:PowerArgs.PlainTextDocumentExpression.tokens">
<summary>
The plain text tokens
</summary>
</member>
<member name="M:PowerArgs.PlainTextDocumentExpression.#ctor(System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates a plain text document expression given a list of tokens
</summary>
<param name="tokens">A list of plain text tokens to render without any special handling</param>
</member>
<member name="M:PowerArgs.PlainTextDocumentExpression.#ctor(PowerArgs.DocumentToken)">
<summary>
Creates a plain text document expression given a single plain text token
</summary>
<param name="singleToken">A single plain text token to render without any special handling</param>
</member>
<member name="M:PowerArgs.PlainTextDocumentExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
Renders the tokens in the expression, using the ambient foreground and background colors if they are set.
</summary>
<param name="context">The data context to use for evaluation</param>
<returns>The rendered plain text</returns>
</member>
<member name="T:PowerArgs.TokenReader`1">
<summary>
A class that makes it easy to read through a list of tokens
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:PowerArgs.TokenReader`1.#ctor(System.Collections.Generic.List{`0})">
<summary>
Creates a token reader given a list of tokens
</summary>
<param name="tokens">The list of tokens to read through</param>
</member>
<member name="M:PowerArgs.TokenReader`1.Advance(System.Boolean)">
<summary>
Advances the reader to the next token
</summary>
<param name="skipWhitespace">If true, the reader will skip past whitespace tokens when reading</param>
<returns>the next token in the list</returns>
</member>
<member name="M:PowerArgs.TokenReader`1.Peek(System.Boolean)">
<summary>
Gets the next token in the list without actually advancing the reader
</summary>
<param name="skipWhitespace">If true, the reader will skip past whitespace tokens when reading</param>
<returns>The next token in the list</returns>
</member>
<member name="M:PowerArgs.TokenReader`1.TryAdvance(`0@,System.Boolean)">
<summary>
Advances the reader to the next token if one exists.
</summary>
<param name="ret">The out variable to store the token if it was found</param>
<param name="skipWhitespace">If true, the reader will skip past whitespace tokens when reading</param>
<returns>True if the reader advanced, false otherwise</returns>
</member>
<member name="M:PowerArgs.TokenReader`1.CanAdvance(System.Boolean)">
<summary>
Determines if the reader can advance
</summary>
<param name="skipWhitespace">If true, the reader will skip past whitespace tokens when reading</param>
<returns>True if there is another token to read, false otherwise</returns>
</member>
<member name="M:PowerArgs.TokenReader`1.TryPeek(`0@,System.Int32@,System.Int32,System.Boolean)">
<summary>
Reads the next token without advancing if one is available.
</summary>
<param name="ret">The out variable to store the token if it was found</param>
<param name="lastPeekIndex">The out variable to store the index of the peeked token in the token list</param>
<param name="lookAhead">How far to peek ahead, by default 1</param>
<param name="skipWhitespace">If true, the reader will skip past whitespace tokens when reading</param>
<returns>True if the reader peeked at a value, false otherwise</returns>
</member>
<member name="M:PowerArgs.TokenReader`1.ToString">
<summary>
Gets all the tokens in the list concatenated into a single string, including whitespace
</summary>
<returns>all the tokens in the list concatenated into a single string, including whitespace</returns>
</member>
<member name="M:PowerArgs.TokenReader`1.ToString(System.Boolean)">
<summary>
Gets all the tokens in the list concatenated into a single string, optionally excluding whitespace
</summary>
<param name="skipWhitespace">If true, whitespace tokens will not be included in the output. Tokens that have
whitespace and non whitespace characters will always be included</param>
<returns>all the tokens in the list concatenated into a single string, with whitespace tokens optionally excluded</returns>
</member>
<member name="T:PowerArgs.DocumentTokenType">
<summary>
An enum defining the types of tokens that can appear in a templated document
</summary>
</member>
<member name="F:PowerArgs.DocumentTokenType.ReplacementKey">
<summary>
Indicates the Key of a replacement tag. Example: 'each' in '{{each foo in bar}}'
</summary>
</member>
<member name="F:PowerArgs.DocumentTokenType.ReplacementParameter">
<summary>
Indicates a parameter in a replacement tag. Example: 'foo', 'in', and 'bar' in '{{each foo in bar}}'
</summary>
</member>
<member name="F:PowerArgs.DocumentTokenType.PlainText">
<summary>
Text that is not transformed by the document renderer
</summary>
</member>
<member name="F:PowerArgs.DocumentTokenType.BeginReplacementSegment">
<summary>
Indicates the beginning of a replacement tag '{{'.
</summary>
</member>
<member name="F:PowerArgs.DocumentTokenType.EndReplacementSegment">
<summary>
Indicates the end of a replacement segment '}}'
</summary>
</member>
<member name="F:PowerArgs.DocumentTokenType.BeginTerminateReplacementSegment">
<summary>
Indicates the beginning of a termination segment '!{{'
</summary>
</member>
<member name="F:PowerArgs.DocumentTokenType.QuickTerminateReplacementSegment">
<summary>
Indicates that a replacement segment has no body and this is the end of the segment '!}}'
</summary>
</member>
<member name="T:PowerArgs.DocumentToken">
<summary>
A class that represents a token in a templated document
</summary>
</member>
<member name="M:PowerArgs.DocumentToken.#ctor(System.String,System.Int32,System.Int32,System.Int32)">
<summary>
Creates a new document token
</summary>
<param name="initialValue">The initial value of the token</param>
<param name="startIndex">the zero based character index of this token in a document template</param>
<param name="line">The line number of this token in a document template (starts at 1)</param>
<param name="col">The column number of this token in a document template (starts at 1)</param>
</member>
<member name="M:PowerArgs.DocumentToken.GetTokenTypeValue(PowerArgs.DocumentTokenType)">
<summary>
Gets the constant string value of a given token type. This method will throw an exception if the
type provided does not map to a constant string value.
</summary>
<param name="type">The type to lookup</param>
<returns>The literal string value expected of a token of the given type</returns>
</member>
<member name="M:PowerArgs.DocumentToken.TryGetTokenTypeValue(PowerArgs.DocumentTokenType,System.String@)">
<summary>
Tries to get the constant string value of a given token type. This method will return false for types that don't
map to a constant string value.
</summary>
<param name="type">The type to lookup</param>
<param name="val">The literal string value expected of a token of the given type</param>
<returns>true if 'val' was populated, false otherwise</returns>
</member>
<member name="M:PowerArgs.DocumentToken.TryParseDocumentTokenType(System.String,PowerArgs.DocumentTokenType@)">
<summary>
Tries to parse a literal string value to a well known document token type.
</summary>
<param name="stringVal">The value to try to parse</param>
<param name="type">The reference to populate if parsing is successful</param>
<returns>True if the string could be successfully mapped to a DocumentTokenType, false otherwise</returns>
</member>
<member name="M:PowerArgs.DocumentToken.Tokenize(System.String,System.String)">
<summary>
Tokenizes the given text into a list of DocumentToken objects.
</summary>
<param name="text">The text to tokenize</param>
<param name="sourceLocation">A string describing the source of the text. This could be a text file path or some other identifier.</param>
<returns>A list of tokens</returns>
</member>
<member name="P:PowerArgs.DocumentToken.TokenType">
<summary>
The type of this token
</summary>
</member>
<member name="T:PowerArgs.IfExpression">
<summary>
An expression that allows a portion of a document template to be rendered only if some condition is true
</summary>
</member>
<member name="M:PowerArgs.IfExpression.#ctor(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates a new if expression given a conditional token and a body
</summary>
<param name="ifExpressionToken">The token containing the conditional expression</param>
<param name="body">The body of the document to render only if the condition evaluates to true</param>
</member>
<member name="M:PowerArgs.IfExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
Evaluates the conditional expression against the given data context, rendering the body only if it is true.
</summary>
<param name="context">The data context to use when evaluating the conditional expression</param>
<returns>The rendered body if the conditional was true, an empty string otherwise</returns>
</member>
<member name="P:PowerArgs.IfExpression.IfExpressionToken">
<summary>
The token representing the conditional expression.
</summary>
</member>
<member name="P:PowerArgs.IfExpression.Body">
<summary>
The contents of the expression to render only if the condition is true
</summary>
</member>
<member name="T:PowerArgs.IfNotExpression">
<summary>
An expression that allows a portion of a document template to be rendered only if some condition is not true
</summary>
</member>
<member name="M:PowerArgs.IfNotExpression.#ctor(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates a new ifnot expression given a conditional token and a body
</summary>
<param name="ifExpressionToken">The token containing the conditional expression</param>
<param name="body">The body of the document to render only if the condition evaluates to false</param>
</member>
<member name="M:PowerArgs.IfNotExpression.Evaluate(PowerArgs.DocumentRendererContext)">
<summary>
Evaluates the conditional expression against the given data context, rendering the body only if it is false.
</summary>
<param name="context">The data context to use when evaluating the conditional expression</param>
<returns>The rendered body if the conditional was false, an empty string otherwise</returns>
</member>
<member name="T:PowerArgs.IfExpressionProvider">
<summary>
An expression provider that can provide either an If expresison or an IfNot expression.
</summary>
</member>
<member name="M:PowerArgs.IfExpressionProvider.#ctor(System.Boolean)">
<summary>
Creates a new provider, indicating whether or not this provider should provide if or ifnot expressions.
</summary>
<param name="not">If true, this provider will provide if expressions, otherwise it will provide ifnot expressions</param>
</member>
<member name="M:PowerArgs.IfExpressionProvider.CreateExpression(PowerArgs.DocumentToken,System.Collections.Generic.List{PowerArgs.DocumentToken},System.Collections.Generic.List{PowerArgs.DocumentToken})">
<summary>
Creates either an if or an ifnot expression, based on its configuration, using the given document info.
</summary>
<param name="replacementKeyToken">The replacement key token whose value is either 'if' or 'ifnot'</param>
<param name="parameters">There should be no parameters to an if or ifnot expression</param>
<param name="body">The body which will be conditionally rendered.</param>
<returns>The expression, either an if or an ifnot expression</returns>
</member>
<member name="T:PowerArgs.DocumentRenderException">
<summary>
An exception that is thrown while trying to render a templated document
</summary>
</member>
<member name="M:PowerArgs.DocumentRenderException.#ctor(System.String,PowerArgs.DocumentToken)">
<summary>
Creates an exception given a message and the offending token
</summary>
<param name="msg">The exception message</param>
<param name="offendingToken">The offending token</param>
</member>
<member name="M:PowerArgs.DocumentRenderException.#ctor(System.String,PowerArgs.DocumentRenderException.NoTokenReason)">
<summary>
Creates an exception given a message and a reason why no token was provided
</summary>
<param name="msg">The exception message</param>
<param name="reason">The reason why no token was provided</param>
</member>
<member name="T:PowerArgs.DocumentRenderException.NoTokenReason">
<summary>
A reason why a token was not provided when creating this exception
</summary>
</member>
<member name="F:PowerArgs.DocumentRenderException.NoTokenReason.EndOfString">
<summary>
Indicates that there is no token specified because there was an unexpected end of string.
</summary>
</member>
<member name="T:PowerArgs.DocumentTemplateInfo">
<summary>
A class that describes a document template
</summary>
</member>
<member name="P:PowerArgs.DocumentTemplateInfo.Value">
<summary>
The template text value
</summary>
</member>
<member name="P:PowerArgs.DocumentTemplateInfo.SourceLocation">
<summary>
The template's source location. This is usually a file location, but it does not have to be.
</summary>
</member>
<member name="T:PowerArgs.DocumentRenderer">
<summary>
A class used to render template documents.
</summary>
</member>
<member name="M:PowerArgs.DocumentRenderer.#ctor">
<summary>
Creates a new DocumentRenderer.
</summary>
</member>
<member name="M:PowerArgs.DocumentRenderer.Render(PowerArgs.DocumentTemplateInfo,System.Object)">
<summary>
Renders a document from a template, using a plain old .NET object as a data source.
</summary>
<param name="template">The template to use</param>
<param name="data">The data source to use for template replacements</param>
<returns></returns>
</member>
<member name="M:PowerArgs.DocumentRenderer.Render(System.String,System.Object,System.String)">
<summary>
Renders a document from a template, using a plain old .NET object as a data source.
</summary>
<param name="template">The template to use</param>
<param name="data">The data source to use for template replacements</param>
<param name="sourceFileLocation">The source of the template, used when reporting back errors</param>
<returns>The rendered document</returns>
</member>
<member name="M:PowerArgs.DocumentRenderer.RegisterTemplate(System.String,PowerArgs.DocumentTemplateInfo)">
<summary>
Register a named tamplate that can be accessed by other templates
</summary>
<param name="name">The unique name of the template</param>
<param name="info">The template info</param>
</member>
<member name="M:PowerArgs.DocumentRenderer.UnregisterTemplate(System.String)">
<summary>
Unregister a named template.
</summary>
<param name="name">The name of the template to unregister</param>
</member>
<member name="P:PowerArgs.DocumentRenderer.ExpressionParser">
<summary>
Gets the underlying expression parser
</summary>
</member>
<member name="T:PowerArgs.ObjectPathTokenType">
<summary>
An enum used to add type metadata to object path expression tokens
</summary>
</member>
<member name="F:PowerArgs.ObjectPathTokenType.IndexerOpen">
<summary>
Indicates the start of an index navigation for objects like arrays, lists, and dictionaries. '['
</summary>
</member>
<member name="F:PowerArgs.ObjectPathTokenType.IndexerClose">
<summary>
Indicates the end of an index navigation for objects like arrays, lists, and dictionaries. ']'
</summary>
</member>
<member name="F:PowerArgs.ObjectPathTokenType.NavigationElement">
<summary>
Indicates a property navigation for an object.
</summary>
</member>
<member name="F:PowerArgs.ObjectPathTokenType.Identifier">
<summary>
Indicates a property identifier
</summary>
</member>
<member name="F:PowerArgs.ObjectPathTokenType.Whitespace">
<summary>
Indicates whitespace
</summary>
</member>
<member name="F:PowerArgs.ObjectPathTokenType.StringLiteral">
<summary>
Indicates a string literal inside of double quotes
</summary>
</member>
<member name="T:PowerArgs.ObjectPathToken">
<summary>
A token that is a part of an object path expression string
</summary>
</member>
<member name="M:PowerArgs.ObjectPathToken.#ctor(System.String,System.Int32,System.Int32,System.Int32)">
<summary>
Creates an object path token
</summary>
<param name="initialValue">The initial value of the token</param>
<param name="startIndex">The start index of the token in the source string</param>
<param name="line">The line number that this token is on</param>
<param name="col">The column within the line that this token is on</param>
</member>
<member name="M:PowerArgs.ObjectPathToken.TokenFactoryImpl(PowerArgs.Token,System.Collections.Generic.List{PowerArgs.ObjectPathToken})">
<summary>
A method that can determine which type of token the given value is
</summary>
<param name="token">The token to classify</param>
<param name="previous">Previously classified tokens in the source string</param>
<returns>The classified token</returns>
</member>
<member name="P:PowerArgs.ObjectPathToken.TokenType">
<summary>
Gets the type of token
</summary>
</member>
<member name="T:PowerArgs.ObjectPathExpression">
<summary>
An object that represents navigation into an object properties or indexed elements
</summary>
</member>
<member name="M:PowerArgs.ObjectPathExpression.#ctor(System.Collections.Generic.IEnumerable{PowerArgs.IObjectPathElement})">
<summary>
Create a path expression given a collection of path elements
</summary>
<param name="elements">The path elements</param>
</member>
<member name="M:PowerArgs.ObjectPathExpression.Parse(System.String)">
<summary>
Parses an object path expression from a string.
</summary>
<param name="expression">The expression text to parse</param>
<returns>The parsed expression</returns>
</member>
<member name="M:PowerArgs.ObjectPathExpression.Evaluate(System.Object)">
<summary>
Evaluates the expression and returns the value
</summary>
<param name="root">the object to evaluate against</param>
<returns>The result of the evaluation</returns>
</member>
<member name="M:PowerArgs.ObjectPathExpression.EvaluateAndTrace(System.Object)">
<summary>
Evaluates the expression, returning the object that corresponds to each element in the path.
</summary>
<param name="root">the object to evaluate against</param>
<returns>A list of object where each object corresponds to an element in the path</returns>
</member>
<member name="P:PowerArgs.ObjectPathExpression.Elements">
<summary>
The path elements for this expression
</summary>
</member>
<member name="T:PowerArgs.IObjectPathElement">
<summary>
An object that represents a path element
</summary>
</member>
<member name="T:PowerArgs.PropertyPathElement">
<summary>
A path element that represents an object's property
</summary>
</member>
<member name="M:PowerArgs.PropertyPathElement.#ctor(System.String)">
<summary>
Creates a property path element given a property name
</summary>
<param name="propertyName">the name of the property</param>
</member>
<member name="M:PowerArgs.PropertyPathElement.ToString">
<summary>
Returns the property name
</summary>
<returns>the property name</returns>
</member>
<member name="P:PowerArgs.PropertyPathElement.PropertyName">
<summary>
Gets the name of the property
</summary>
</member>
<member name="T:PowerArgs.IndexerPathElement">
<summary>
A path element that represents an index navigation
</summary>
</member>
<member name="M:PowerArgs.IndexerPathElement.#ctor(System.Object)">
<summary>
Creates an indexer element given an indexer value
</summary>
<param name="index"></param>
</member>
<member name="M:PowerArgs.IndexerPathElement.FindMatchingProperty(System.Object)">
<summary>
Finds the matching property info that represents an indexer property (do not use for strings or arrays).
</summary>
<param name="target">The object to search</param>
<returns>The matching property</returns>
</member>
<member name="M:PowerArgs.IndexerPathElement.ToString">
<summary>
returns '[' + the index value + ']'
</summary>
<returns>'[' + the index value + ']'</returns>
</member>
<member name="P:PowerArgs.IndexerPathElement.Index">
<summary>
The indexer value, either a literal string or an integer
</summary>
</member>
<member name="T:PowerArgs.TokenizerException">
<summary>
An exception that will be thrown if there was an error while tokenizing a string.
</summary>
</member>
<member name="M:PowerArgs.TokenizerException.#ctor(System.String)">
<summary>
Creates a new tokenizer exception given a message
</summary>
<param name="message">The exception message</param>
</member>
<member name="T:PowerArgs.WhitespaceBehavior">
<summary>
An enum describing the different ways the tokenizer can handle whitespace
</summary>
</member>
<member name="F:PowerArgs.WhitespaceBehavior.DelimitAndInclude">
<summary>
Treats whitespace as a delimiter and includes the whitespace tokens in the output list of tokens
</summary>
</member>
<member name="F:PowerArgs.WhitespaceBehavior.DelimitAndExclude">
<summary>
Treats whitespace as a delimiter, but excludes the whitespace tokens from the output list of tokens
</summary>
</member>
<member name="F:PowerArgs.WhitespaceBehavior.Include">
<summary>
Includes whitespace in the output and does not treat it as a delimiter
</summary>
</member>
<member name="T:PowerArgs.DoubleQuoteBehavior">
<summary>
An enum describing the different ways the tokenizer can handle double quotes
</summary>
</member>
<member name="F:PowerArgs.DoubleQuoteBehavior.NoSpecialHandling">
<summary>
No special handling. Double quotes will be treated like any normal character. You can include the double quote in the delimiters list.
</summary>
</member>
<member name="F:PowerArgs.DoubleQuoteBehavior.IncludeQuotedTokensAsStringLiterals">
<summary>
Treat values within double quotes as string literals.
</summary>
</member>
<member name="T:PowerArgs.Tokenizer`1">
<summary>
A general purpose string tokenizer
</summary>
<typeparam name="T">The type of tokens that this tokenizer should output</typeparam>
</member>
<member name="M:PowerArgs.Tokenizer`1.#ctor">
<summary>
Creates a new tokenizer
</summary>
</member>
<member name="M:PowerArgs.Tokenizer`1.Tokenize(System.String)">
<summary>
Tokenizes the given string into a list of tokens
</summary>
<param name="input">The string to tokenize</param>
<returns>The list of tokens</returns>
</member>
<member name="P:PowerArgs.Tokenizer`1.Delimiters">
<summary>
strings to treat as delimiters. Delimiters with longer lengths will take preference over
those with shorter lengths. For example if you add delimiters '{{' and '{' and the document
contains '{{Hello' then you'll get 2 tokens, first '{{', then 'hello'
</summary>
</member>
<member name="P:PowerArgs.Tokenizer`1.TokenFactory">
<summary>
A function that given a plain token can transform it into the strongly typed token
</summary>
</member>
<member name="P:PowerArgs.Tokenizer`1.WhitespaceBehavior">
<summary>
Gets or sets the option that describes how whitespace should be treated.
</summary>
</member>
<member name="P:PowerArgs.Tokenizer`1.DoubleQuoteBehavior">
<summary>
Gets or sets the option that describes how double quotes should be treated.
</summary>
</member>
<member name="P:PowerArgs.Tokenizer`1.EscapeSequenceIndicator">
<summary>
An escape sequence identifier. By default it is '\'
</summary>
</member>
<member name="P:PowerArgs.Tokenizer`1.SourceFileLocation">
<summary>
A string that describes the source location for the given document
</summary>
</member>
<member name="T:PowerArgs.ArgHiddenFromUsage">
<summary>
Use this attribute to hide an argument from the usage output. Users will still be able to provide
the argument, but it will be undocumented. This is useful if you want to invlude some secret commands
or diagnostic commands.
</summary>
</member>
<member name="M:PowerArgs.ArgHiddenFromUsage.BeforeGenerateUsage(PowerArgs.ArgumentUsageInfo)">
<summary>
Sets the ignore flag on the info context so the usage generator skips this argument.
</summary>
<param name="info">The info about the argument we're hiding</param>
</member>
<member name="T:PowerArgs.ArgHook">
<summary>
An abstract class that you can implement if you want to hook into various parts of the
parsing pipeline.
</summary>
</member>
<member name="M:PowerArgs.ArgHook.BeforeParse(PowerArgs.ArgHook.HookContext)">
<summary>
This hook is called before the parser ever looks at the command line. You can do some preprocessing of the
raw string arguments here.
</summary>
<param name="context">An object that has useful context. See the documentation of each property for information about when those properties are populated.</param>
</member>
<member name="M:PowerArgs.ArgHook.BeforePopulateProperties(PowerArgs.ArgHook.HookContext)">
<summary>
This hook is called before the arguments defined in a class are populated. For actions (or sub commands) this hook will
get called once for the main class and once for the specified action.
</summary>
<param name="context">An object that has useful context. See the documentation of each property for information about when those properties are populated.</param>
</member>
<member name="M:PowerArgs.ArgHook.BeforePopulateProperty(PowerArgs.ArgHook.HookContext)">
<summary>
This hook is called before an argument is transformed from a string into a proper type and validated.
</summary>
<param name="context">An object that has useful context. See the documentation of each property for information about when those properties are populated.</param>
</member>
<member name="M:PowerArgs.ArgHook.AfterPopulateProperty(PowerArgs.ArgHook.HookContext)">
<summary>
This hook is called after an argument is transformed from a string into a proper type and validated.
</summary>
<param name="context">An object that has useful context. See the documentation of each property for information about when those properties are populated.</param>
</member>
<member name="M:PowerArgs.ArgHook.AfterPopulateProperties(PowerArgs.ArgHook.HookContext)">
<summary>
This hook is called after the arguments defined in a class are populated. For actions (or sub commands) this hook will
get called once for the main class and once for the specified action.
</summary>
<param name="context">An object that has useful context. See the documentation of each property for information about when those properties are populated.</param>
</member>
<member name="M:PowerArgs.ArgHook.BeforeInvoke(PowerArgs.ArgHook.HookContext)">
<summary>
This hook is called after parsing is complete, but before any Action or Main method is invoked.
</summary>
<param name="context">An object that has useful context. See the documentation of each property for information about when those properties are populated.</param>
</member>
<member name="M:PowerArgs.ArgHook.AfterInvoke(PowerArgs.ArgHook.HookContext)">
<summary>
This hook is called after any Action or Main method is invoked.
</summary>
<param name="context">An object that has useful context. See the documentation of each property for information about when those properties are populated.</param>
</member>
<member name="M:PowerArgs.ArgHook.AfterCancel(PowerArgs.ArgHook.HookContext)">
<summary>
This hook is called if CancelAllProcessing() is called on a HookContext object.
</summary>
<param name="context">An object that has useful context. See the documentation of each property for information about when those properties are populated.</param>
</member>
<member name="P:PowerArgs.ArgHook.BeforeParsePriority">
<summary>
The priority of the BeforeParse hook. Higher numbers execute first.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.BeforePopulatePropertiesPriority">
<summary>
The priority of the BeforePopulateProperties hook. Higher numbers execute first.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.BeforePopulatePropertyPriority">
<summary>
The priority of the BeforePopulateProperty hook. Higher numbers execute first.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.AfterPopulatePropertyPriority">
<summary>
The priority of the AfterPopulateProperty hook. Higher numbers execute first.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.AfterPopulatePropertiesPriority">
<summary>
The priority of the AfterPopulateProperties hook. Higher numbers execute first.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.BeforeInvokePriority">
<summary>
The priority of the BeforeInvoke hook. Higher numbers execute first.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.AfterInvokePriority">
<summary>
The priority of the AfterInvoke hook. Higher numbers execute first.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.AfterCancelPriority">
<summary>
The priority of the AfterCancel hook. Higher numbers execute first.
</summary>
</member>
<member name="T:PowerArgs.ArgHook.HookContext">
<summary>
Context that is passed to your hook. Different parts of the context will be available
depending on which part of the pipeline you're hooking into.
</summary>
</member>
<member name="F:PowerArgs.ArgHook.HookContext.CmdLineArgs">
<summary>
The command line arguments that were passed to the Args class. This is always available and you
can modify it in the BeforeParse hook at your own risk.
</summary>
</member>
<member name="F:PowerArgs.ArgHook.HookContext.ArgumentValue">
<summary>
The string value that was specified for the current argument. This will align with the value of ArgHook.CurrentArgument.
This is not available during BeforePopulateProperties or
AfterPopulateProperties.
</summary>
</member>
<member name="F:PowerArgs.ArgHook.HookContext.RevivedProperty">
<summary>
This is the value of the current property after it has been converted into its proper .NET type. It is only available
to the AfterPopulateProperty hook.
</summary>
</member>
<member name="M:PowerArgs.ArgHook.HookContext.GetProperty``1(System.String)">
<summary>
Get a value from the context's property bag.
</summary>
<typeparam name="T">The type of value you are expecting</typeparam>
<param name="key">The key for the property you want to get</param>
<returns>The value or default(T) if no value was found.</returns>
</member>
<member name="M:PowerArgs.ArgHook.HookContext.SetProperty``1(System.String,``0)">
<summary>
Set a value in the context's property bag.
</summary>
<typeparam name="T"></typeparam>
<param name="key">The key for the property you want to set</param>
<param name="value">The value of the property to set</param>
</member>
<member name="M:PowerArgs.ArgHook.HookContext.HasProperty(System.String)">
<summary>
Returns true if the context has a value for the given property.
</summary>
<param name="key">The key to check</param>
<returns>true if the context has a value for the given property, false otherwise</returns>
</member>
<member name="M:PowerArgs.ArgHook.HookContext.ClearProperty(System.String)">
<summary>
Clear a value in the context's property bag.
</summary>
<param name="key">The key for the property you want to clear.</param>
</member>
<member name="M:PowerArgs.ArgHook.HookContext.CancelAllProcessing">
<summary>
Stops all argument processing, hooks, and action invocation as soon as is feasable. You
can implement an ArgHook that receives an event when this is called.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.HookContext.Current">
<summary>
Gets the context for the current parse operation happening on the current thread or
null if no parse is happening on the current thread.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.HookContext.Property">
<summary>
The current property being operating on. This is not available during BeforePopulateProperties or
AfterPopulateProperties.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.HookContext.CurrentArgument">
<summary>
The current argument being operating on.
AfterPopulateProperties.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.HookContext.SpecifiedAction">
<summary>
Gets the action that was specified on the command line or null if no action was specified or if the definition exposes no actions.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.HookContext.Args">
<summary>
This is the instance of your argument class. The amount that it is populated will depend on how far along in the pipeline
the parser is.
</summary>
</member>
<member name="P:PowerArgs.ArgHook.HookContext.Definition">
<summary>
The definition that's being used throughout the parsing process
</summary>
</member>
<member name="P:PowerArgs.ArgHook.HookContext.ParserData">
<summary>
The raw parser data. This is not available to the BeforeParse hook. It may be useful for you to look at, but you should rarely have to change the values.
Modify the content of this at your own risk.
</summary>
</member>
<member name="T:PowerArgs.DefaultValueAttribute">
<summary>
Use this attribute to set the default value for a parameter. Note that this only
works for simple types since only compile time constants can be passed to an attribute.
</summary>
</member>
<member name="M:PowerArgs.DefaultValueAttribute.#ctor(System.Object)">
<summary>
Creates a new DefaultValueAttribute with the given value. Note that the value will get
converted to a string and then fed into the parser to be revived.
</summary>
<param name="value">The default value for the property</param>
</member>
<member name="M:PowerArgs.DefaultValueAttribute.BeforePopulateProperty(PowerArgs.ArgHook.HookContext)">
<summary>
Before the property is revived and validated, if the user didn't specify a value,
then substitue the default value.
</summary>
<param name="Context"></param>
</member>
<member name="P:PowerArgs.DefaultValueAttribute.Value">
<summary>
The default value that was specified on the attribute. Note that the value will get
converted to a string and then fed into the parser to be revived.
</summary>
</member>
<member name="T:PowerArgs.HelpHook">
<summary>
A hook that lets you turn a boolean property into a command line switch that short circuits processing and displays help.
</summary>
</member>
<member name="M:PowerArgs.HelpHook.#ctor">
<summary>
Creates a new help hook instance
</summary>
</member>
<member name="M:PowerArgs.HelpHook.BeforePopulateProperty(PowerArgs.ArgHook.HookContext)">
<summary>
Makes sure the target is a boolean
</summary>
<param name="context">Context passed by the parser</param>
</member>
<member name="M:PowerArgs.HelpHook.AfterPopulateProperty(PowerArgs.ArgHook.HookContext)">
<summary>
This gets called after the target property is populated. It cancels processing.
</summary>
<param name="context">Context passed by the parser</param>
</member>
<member name="M:PowerArgs.HelpHook.AfterCancel(PowerArgs.ArgHook.HookContext)">
<summary>
Writes the help as long as WriteHelp is true
</summary>
<param name="context">Context passed by the parser</param>
</member>
<member name="P:PowerArgs.HelpHook.EXEName">
<summary>
Optional. The name of the EXE that is displayed by the help. By default it will use the entry assembly exe name.
</summary>
</member>
<member name="P:PowerArgs.HelpHook.ShowTypeColumn">
<summary>
Optionally show the TYPE column in the auto generated usage. Defaults to true.
</summary>
</member>
<member name="P:PowerArgs.HelpHook.ShowPositionColumn">
<summary>
Optionally show the POSITION column in the auto generated usage. Defaults to true.
</summary>
</member>
<member name="P:PowerArgs.HelpHook.ShowPossibleValues">
<summary>
Set to true to list possible values (usually for enums). Defaults to true.
</summary>
</member>
<member name="P:PowerArgs.HelpHook.UsageTemplateProviderType">
<summary>
A type that should implement IUsageTemplateProvider. When specified the help hook will use the GenerateUsageFromTemplate function rather than the obsolete GenerateStyledUsage function.
</summary>
</member>
<member name="P:PowerArgs.HelpHook.WriteHelp">
<summary>
If true (which it is by default) the hook will write the help after the target property is populated. If false, processing will still stop, but
the help will not be written (yoy will have to do it yourself).
</summary>
</member>
<member name="E:PowerArgs.HelpHook.UsageWritten">
<summary>
An event that fires when the hook writes usage to the console
</summary>
</member>
<member name="T:PowerArgs.StickyArg">
<summary>
A useful arg hook that will store the last used value for an argument and repeat it the next time.
</summary>
</member>
<member name="M:PowerArgs.StickyArg.#ctor">
<summary>
Marks a property as a sticky arg. Use the default location to store sticky arguments (AppData/Roaming/PowerArgs/EXE_NAME.txt)
</summary>
</member>
<member name="M:PowerArgs.StickyArg.#ctor(System.String)">
<summary>
Marks a property as a sticky arg. Use the provided location to store sticky arguments (AppData/Roaming/PowerArgs/EXE_NAME.txt)
</summary>
</member>
<member name="M:PowerArgs.StickyArg.BeforePopulateProperty(PowerArgs.ArgHook.HookContext)">
<summary>
If the user didn't specify a value on the command line then the StickyArg will try to load the last used
value.
</summary>
<param name="Context">Used to see if the property was specified.</param>
</member>
<member name="M:PowerArgs.StickyArg.AfterPopulateProperty(PowerArgs.ArgHook.HookContext)">
<summary>
If the given property has a non null value then that value is persisted for the next use.
</summary>
<param name="Context">Used to see if the property was specified.</param>
</member>
<member name="T:PowerArgs.IStickyArgPersistenceProvider">
<summary>
An interface used to implement custom saving and loading of persistent (sticky) args.
</summary>
</member>
<member name="M:PowerArgs.IStickyArgPersistenceProvider.Save(System.Collections.Generic.Dictionary{System.String,System.String},System.String)">
<summary>
This method is called when it is time to save the sticky args.
</summary>
<param name="stickyArgs">The names and values of the arguments to save.</param>
<param name="pathInfo">The string that was passed to the StickyArg attribue (usually a file path).</param>
</member>
<member name="M:PowerArgs.IStickyArgPersistenceProvider.Load(System.String)">
<summary>
This method is called when it is time to load the sticky args.
</summary>
<param name="pathInfo">The string that was passed to the StickyArg attribue (usually a file path).</param>
<returns>The loaded sticky args.</returns>
</member>
<member name="T:PowerArgs.StickyArgPersistence">
<summary>
An attribute you can put on a type in order to override how StickyArg properties are saved and loaded.
</summary>
</member>
<member name="M:PowerArgs.StickyArgPersistence.#ctor(System.Type)">
<summary>
Creates a new StickyArgPersistence attribute given the type of the persistence provider.
</summary>
<param name="persistenceProviderType">The type that implements IStickyArgPersistenceProvider and defines a default constructor.</param>
</member>
<member name="P:PowerArgs.StickyArgPersistence.PersistenceProvider">
<summary>
Gets the provider that will be used to save and load sticky args.
</summary>
</member>
<member name="T:PowerArgs.ArgActionMethod">
<summary>
Use this attribute to annotate methods that represent your program's actions.
</summary>
</member>
<member name="T:PowerArgs.ArgActionType">
<summary>
Use this attribute if your action implementation methods are defined in a type other than the
type being passed to Args.ParseAction() or Args.InvokeAction().
</summary>
</member>
<member name="M:PowerArgs.ArgActionType.#ctor(System.Type)">
<summary>
Creates a new ArgActionType attribute given the type that contains the action implementation.
</summary>
<param name="t">The type that implements your action methods.</param>
</member>
<member name="P:PowerArgs.ArgActionType.ActionType">
<summary>
The type that implements your action methods.
</summary>
</member>
<member name="T:PowerArgs.NonInteractiveIndicator">
<summary>
An attribute that can be specified on a boolean argument to indicate a non interactive session.
When used, it sets IsNonInteractive on the current definition.
</summary>
</member>
<member name="M:PowerArgs.NonInteractiveIndicator.#ctor">
<summary>
Creates a new NonInteractiveIndicator attribute
</summary>
</member>
<member name="M:PowerArgs.NonInteractiveIndicator.BeforeParse(PowerArgs.ArgHook.HookContext)">
<summary>
If the current argument is a boolean and it is specified on the command line then
this hook sets the IsNonInteractive flag on the current argument definition.
</summary>
<param name="context"></param>
</member>
<member name="T:PowerArgs.ArgDescription">
<summary>
Use this attribute to describe your argument property. This will show up in the auto generated
usage documentation.
</summary>
</member>
<member name="M:PowerArgs.ArgDescription.#ctor(System.String)">
<summary>
Creates a new ArgDescription attribute.
</summary>
<param name="description">A brief description of your argument property.</param>
</member>
<member name="P:PowerArgs.ArgDescription.Description">
<summary>
A brief description of your argument property.
</summary>
</member>
<member name="T:PowerArgs.ArgExample">
<summary>
Use this attribute to provide an example of how to use your program.
</summary>
</member>
<member name="M:PowerArgs.ArgExample.#ctor(System.String,System.String)">
<summary>
Creates a new ArgExample class
</summary>
<param name="example">The example command line.</param>
<param name="description">A brief description of what this example does.</param>
</member>
<member name="P:PowerArgs.ArgExample.Title">
<summary>
An optional title for this example
</summary>
</member>
<member name="P:PowerArgs.ArgExample.Example">
<summary>
The example command line.
</summary>
</member>
<member name="P:PowerArgs.ArgExample.Description">
<summary>
A brief description of what this example does.
</summary>
</member>
<member name="T:PowerArgs.ArgExceptionPolicy">
<summary>
Enum used to specify how user errors (ArgExceptions) should be handled by the parser.
</summary>
</member>
<member name="F:PowerArgs.ArgExceptionPolicy.DontHandleExceptions">
<summary>
The default, PowerArgs will throw these exceptions for your program to handle.
</summary>
</member>
<member name="F:PowerArgs.ArgExceptionPolicy.StandardExceptionHandling">
<summary>
PowerArgs will print the user friendly error message as well as the auto-generated usage documentation
for the program.
</summary>
</member>
<member name="T:PowerArgs.ArgExceptionBehavior">
<summary>
Use this attrbiute to opt into standard error handling of user input errors.
</summary>
</member>
<member name="M:PowerArgs.ArgExceptionBehavior.#ctor(PowerArgs.ArgExceptionPolicy)">
<summary>
Creates a new ArgExceptionBehavior attributes with the given policy.
</summary>
<param name="policy">The policy to use, defaults to DontHandleExceptions.</param>
</member>
<member name="P:PowerArgs.ArgExceptionBehavior.Policy">
<summary>
The policy to use, defaults to DontHandleExceptions.
</summary>
</member>
<member name="P:PowerArgs.ArgExceptionBehavior.ShowTypeColumn">
<summary>
Optionally show the TYPE column in the auto generated usage. Defaults to true.
</summary>
</member>
<member name="P:PowerArgs.ArgExceptionBehavior.ShowPositionColumn">
<summary>
Optionally show the POSITION column in the auto generated usage. Defaults to true.
</summary>
</member>
<member name="P:PowerArgs.ArgExceptionBehavior.ShowPossibleValues">
<summary>
Set to true to list possible values (usually for enums). Defaults to true.
</summary>
</member>
<member name="P:PowerArgs.ArgExceptionBehavior.ExeName">
<summary>
Optionally override the ExeName. You need to do this in unit tests. In a real console app the
value will be detected automatically if you leave this as null.
</summary>
</member>
<member name="P:PowerArgs.ArgExceptionBehavior.UsageTemplateFile">
<summary>
The usage template to use to display usage information. You can leave this null if you want to use the default template.
</summary>
</member>
<member name="P:PowerArgs.ArgExceptionBehavior.UsageTemplateProviderType">
<summary>
A type that should implement IUsageTemplateProvider. When specified the help hook will use the GenerateUsageFromTemplate function rather than the obsolete GenerateStyledUsage function.
</summary>
</member>
<member name="T:PowerArgs.ArgIgnoreAttribute">
<summary>
Use this attribute if you want PowerArgs to ignore a property completely.
</summary>
</member>
<member name="T:PowerArgs.IArgumentOrActionMetadata">
<summary>
Represents IArgMetadata that is valid for CommandLineArguments or CommandLineActions
</summary>
</member>
<member name="T:PowerArgs.ArgIgnoreCase">
<summary>
Use this argument on your class, property, or action method to enforce case sensitivity. By default,
case is ignored.
</summary>
</member>
<member name="M:PowerArgs.ArgIgnoreCase.#ctor(System.Boolean)">
<summary>
Create a new ArgIgnoreCase attribute.
</summary>
<param name="ignore">Whether or not to ignore case</param>
</member>
<member name="P:PowerArgs.ArgIgnoreCase.IgnoreCase">
<summary>
Flag to set whether or not case is ignored.
</summary>
</member>
<member name="T:PowerArgs.ArgEnforceCase">
<summary>
Use this argument on your class or property to enforce case sensitivity. By default,
case is ignored.
</summary>
</member>
<member name="M:PowerArgs.ArgEnforceCase.#ctor">
<summary>
Create a new ArgEnforceCase attribute.
</summary>
</member>
<member name="T:PowerArgs.ArgPosition">
<summary>
Use this attribute if you want users to be able to specify an argument without specifying the name,
but rather by it's position on the command line. All positioned arguments must come before any named arguments.
Zero '0' represents the first position. If you are using the Action framework then subcommands must start at
position 1.
</summary>
</member>
<member name="M:PowerArgs.ArgPosition.#ctor(System.Int32)">
<summary>
Creates a new ArgPositionAttribute
</summary>
<param name="pos">The expected position of this argument</param>
</member>
<member name="P:PowerArgs.ArgPosition.Position">
<summary>
The expected position of this argument
</summary>
</member>
<member name="T:PowerArgs.ArgReviverAttribute">
<summary>
The attribute used when you want to create an arg reviver. You should put this on public static methods
that take 2 string parameters (the first represents the name of the property, the second represents the string value
and the return type is the type that you are reviving (or converting) the string into.
</summary>
</member>
<member name="T:PowerArgs.ArgShortcutPolicy">
<summary>
An enum to represent argument shortcut policies
</summary>
</member>
<member name="F:PowerArgs.ArgShortcutPolicy.Default">
<summary>
No special behavior.
</summary>
</member>
<member name="F:PowerArgs.ArgShortcutPolicy.NoShortcut">
<summary>
Pass this value to the ArgShortcut attribute's constructor to indicate that the given property
does not support a shortcut.
</summary>
</member>
<member name="F:PowerArgs.ArgShortcutPolicy.ShortcutsOnly">
<summary>
This indicates that the .NET property named should not be used as an indicator. Instead,
only the values in the other ArgShortcut attributes should be used.
</summary>
</member>
<member name="T:PowerArgs.ArgShortcut">
<summary>
Use this attribute to override the shortcut that PowerArgs automatically assigns to each property.
</summary>
</member>
<member name="M:PowerArgs.ArgShortcut.#ctor(System.String)">
<summary>
Creates a new ArgShortcut attribute with a specified value.
</summary>
<param name="shortcut">The value of the new shortcut.</param>
</member>
<member name="M:PowerArgs.ArgShortcut.#ctor(PowerArgs.ArgShortcutPolicy)">
<summary>
Creates a new ArgShortcut using the given policy
</summary>
<param name="policy"></param>
</member>
<member name="P:PowerArgs.ArgShortcut.Shortcut">
<summary>
The shortcut for the given property
</summary>
</member>
<member name="P:PowerArgs.ArgShortcut.Policy">
<summary>
Get the ShortcutPolicy for this attribute.
</summary>
</member>
<member name="T:PowerArgs.ArgLongForm">
<summary>
An attribute used to define long form aliases for argument
names. For example, --log-level instead of -log.
It also supports an alternate syntax for providing the values.
For example: --log-level=error instead of -log error or /log:error.
</summary>
</member>
<member name="M:PowerArgs.ArgLongForm.#ctor(System.String)">
<summary>
Creates a new instance of an ArgLongForm attribute given the shortcut value.
</summary>
<param name="value">The shortcut value</param>
</member>
<member name="T:PowerArgs.ArgStyle">
<summary>
Obsolete, both the -name value and /name:value styles are supported automatically.
</summary>
</member>
<member name="F:PowerArgs.ArgStyle.PowerShell">
<summary>
Obsolete, both the -name value and /name:value styles are supported automatically.
</summary>
</member>
<member name="F:PowerArgs.ArgStyle.SlashColon">
<summary>
Obsolete, both the -name value and /name:value styles are supported automatically.
</summary>
</member>
<member name="T:PowerArgs.ArgStyleAttribute">
<summary>
Obsolete - Don't use this. Both the -name value and /name:value styles are now both supported automatically.
</summary>
</member>
<member name="M:PowerArgs.ArgStyleAttribute.#ctor(PowerArgs.ArgStyle)">
<summary>
Obsolete - Don't use this. Both the -name value and /name:value styles are now both supported automatically.
</summary>
<param name="style">obsolete</param>
</member>
<member name="P:PowerArgs.ArgStyleAttribute.Style">
<summary>
Obsolete - Don't use this. Both the -name value and /name:value styles are now both supported automatically.
</summary>
</member>
<member name="T:PowerArgs.OmitFromUsageDocs">
<summary>
An attribute that, when placed on a property or action method, makes sure that property/action does not appear
in the output created by the ArgUsage class (the class that auto generates usage documentation).
</summary>
</member>
<member name="M:PowerArgs.OmitFromUsageDocs.BeforeGenerateUsage(PowerArgs.ArgumentUsageInfo)">
<summary>
sets the ignroe flag on the info object
</summary>
<param name="info">the context used to modify the usage documentation</param>
</member>
<member name="T:PowerArgs.CommandLineAction">
<summary>
A class that represents command line actions that users can specify on the command line. This is useful for programs like git
where users first specify an action like 'push' and then the remaining arguments are either global or specific to 'push'.
</summary>
</member>
<member name="M:PowerArgs.CommandLineAction.#ctor(System.Action{PowerArgs.CommandLineArgumentsDefinition})">
<summary>
Creates a new command line action given an implementation.
</summary>
<param name="actionHandler">The implementation of the action.</param>
</member>
<member name="M:PowerArgs.CommandLineAction.ToString">
<summary>
Gets a string representation of this action.
</summary>
<returns>a string representation of this action</returns>
</member>
<member name="M:PowerArgs.CommandLineAction.Equals(System.Object)">
<summary>
Determines if 2 actions are the same based on their source.
</summary>
<param name="obj">The other action</param>
<returns>True if equal, false otherwise</returns>
</member>
<member name="M:PowerArgs.CommandLineAction.FindMatchingArgument(System.String,System.Boolean)">
<summary>
Finds the first CommandLineArgument that matches the given key.
</summary>
<param name="key">The key as if it was typed in on the command line. This can also be an alias. </param>
<param name="throwIfMoreThanOneMatch">If set to true then this method will throw and InvalidArgDeginitionException if more than 1 match is found</param>
<returns>The first argument that matches the key.</returns>
</member>
<member name="P:PowerArgs.CommandLineAction.Aliases">
<summary>
The values that the user can specify on the command line to specify this action.
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.Arguments">
<summary>
The action specific arguments that are applicable to the end user should they specify this action.
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.UsageSummary">
<summary>
Creates a usage summary string that is specific to this action and accounts for positional argument, etc.
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.UsageSummaryHTMLEncoded">
<summary>
Creates a usage summary string that is specific to this action and accounts for positional argument, etc. where the
brackets are html encoded
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.Description">
<summary>
The description that will be shown in the auto generated usage.
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.Source">
<summary>
The method or property that was used to define this action.
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.IsSpecifiedAction">
<summary>
This will be set by the parser if the parse was successful and this was the action the user specified.
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.IgnoreCase">
<summary>
Indicates whether or not the parser should ignore case when matching a user string with this action.
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.DefaultAlias">
<summary>
The first alias or null if there are no aliases.
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.Metadata">
<summary>
The list of metadata that can be used to inject behavior into the action
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.ActionMethod">
<summary>
The implementation of the action that can be invoked by the parser if the user specifies this action.
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.HasExamples">
<summary>
Returns true if there is at least 1 ArgExample metadata on this action
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.HasArguments">
<summary>
Returns true if this action has at least 1 action specific argument
</summary>
</member>
<member name="P:PowerArgs.CommandLineAction.Examples">
<summary>
Examples that show users how to use this action.
</summary>
</member>
<member name="T:PowerArgs.CommandLineArgument">
<summary>
Instances of this class represent a single command line argument that users can specify on the command line.
Supported syntaxes include:
-argumentName argumentValue
/argumentName:argumentValue
-argumentName - If the argument is a boolean it will be true in this case.
--argumentName=argumentValue - Only works if you have added an alias that starts with --.
argumentValue - Only works if this argument defines the Position property as >= 0
</summary>
</member>
<member name="M:PowerArgs.CommandLineArgument.#ctor(System.Type,System.String,System.Boolean)">
<summary>
Creates a command line argument of the given type and sets the first default alias.
</summary>
<param name="t">The CLR type of the argument</param>
<param name="defaultAlias">The default name that users will use to specify this argument</param>
<param name="ignoreCase">If true, the parser will match this argument even if the specifier doesn't match case. True by default.</param>
</member>
<member name="M:PowerArgs.CommandLineArgument.ToString">
<summary>
Gets the string representation of this argument.
</summary>
<returns>the string representation of this argument.</returns>
</member>
<member name="P:PowerArgs.CommandLineArgument.Aliases">
<summary>
The values that can be used as specifiers for this argument on the command line
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.Metadata">
<summary>
Metadata that has been injected into this Argument
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.FriendlyTypeName">
<summary>
Gets a friendly type name for this argument.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.ArgumentType">
<summary>
The CLR type of this argument.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.IgnoreCase">
<summary>
Specifies whether or not the parser should ignore case when trying to find a match for this argument on the command line. Defaults to true.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.Position">
<summary>
If this is a positional argument then set this value >= 0 and users can specify a value without specifying an argument alias. Defaults to -1.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.HasDefaultValue">
<summary>
Returns true if a default value has been explicitly registered for this argument
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.DefaultValue">
<summary>
The default value for this argument in the event it is optional and the user did not specify it.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.EnumValuesAndDescriptions">
<summary>
Only works if the ArgumentType is an enum. Returns a list where each element is a string containing an
enum value and optionally its description. Each enum value is represented in the list.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.Description">
<summary>
The description for this argument that appears in the auto generated usage.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.IsRequired">
<summary>
Gets or sets whether or not this argument is required.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.Source">
<summary>
If this argument was inferred from a type then the source is either a PropertyInfo or a ParameterInfo. If this argument
was created manually then this value will be null.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.RevivedValue">
<summary>
This property will contain the parsed value of the command line argument if parsing completed successfully.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgument.DefaultAlias">
<summary>
The first alias of this argument or null if no aliases are defined.
</summary>
</member>
<member name="T:PowerArgs.CommandLineArgumentsDefinition">
<summary>
This is the root class used to define a program's command line arguments. You can start with an empty definition and
programatically add arguments or you can start from a Type that you have defined and have the definition inferred from it.
</summary>
</member>
<member name="M:PowerArgs.CommandLineArgumentsDefinition.#ctor">
<summary>
Creates an empty command line arguments definition.
</summary>
</member>
<member name="M:PowerArgs.CommandLineArgumentsDefinition.#ctor(System.Type)">
<summary>
Creates a command line arguments definition and infers things like Arguments, Actions, etc. from the type's metadata.
</summary>
<param name="t">The argument scaffold type used to infer the definition</param>
</member>
<member name="M:PowerArgs.CommandLineArgumentsDefinition.FindMatchingArgument(System.String,System.Boolean)">
<summary>
Finds the first CommandLineArgument that matches the given key.
</summary>
<param name="key">The key as if it was typed in on the command line. This can also be an alias. </param>
<param name="throwIfMoreThanOneMatch">If set to true then this method will throw and InvalidArgDeginitionException if more than 1 match is found</param>
<returns>The first argument that matches the key.</returns>
</member>
<member name="M:PowerArgs.CommandLineArgumentsDefinition.FindMatchingAction(System.String,System.Boolean)">
<summary>
Finds the first CommandLineAction that matches the given key
</summary>
<param name="key">The key as if it was typed in on the command line. This can also be an alias. </param>
<param name="throwIfMoreThanOneMatch">If set to true then this method will throw and InvalidArgDeginitionException if more than 1 match is found</param>
<returns>The first action that matches the key.</returns>
</member>
<member name="M:PowerArgs.CommandLineArgumentsDefinition.CreateVariableResolver">
<summary>
Gives you an object that you can use to tell if a particular argument was specified on the command line.
</summary>
<returns>object that you can use to tell if a particular argument was specified on the command line</returns>
</member>
<member name="M:PowerArgs.CommandLineArgumentsDefinition.ToString">
<summary>
Gets a basic string representation of the definition.
</summary>
<returns>a basic string representation of the definition</returns>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.ExeName">
<summary>
Gets or sets the ExeName for this command line argument definition's program. If not specified the entry assembly's file name
is used, without the file extension.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.Description">
<summary>
Gets the description from ArgDescriptionMetadata if it exists, or empty string if it does not.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.HasGlobalArguments">
<summary>
Returns true if there is at least 1 global argument, false otherwise
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.HasActions">
<summary>
Returns true if there is at least 1 action, false otherwise
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.UsageSummary">
<summary>
Creates a usage summary string that takes into account actions, positional argument, etc.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.UsageSummaryHTMLEncoded">
<summary>
Creates a usage summary string that takes into account actions, positional argument, etc. where the
brackets are html encoded
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.IsNonInteractive">
<summary>
When set to true, TabCompletion is completely disabled and required fields will ignore the PromptIfMissing flag.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.ArgumentScaffoldType">
<summary>
The type that was used to generate this definition. This will only be populated if you use the constructor that takes in a type and the definition is inferred.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.Arguments">
<summary>
The command line arguments that are global to this definition.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.AllGlobalAndActionArguments">
<summary>
Gets all global command line arguments as well as all arguments of any actions in this definition
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.Hooks">
<summary>
Global hooks that can execute all hook override methods except those that target a particular argument.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.Actions">
<summary>
Actions that are defined for this definition. If you have at least one action then the end user must specify the action as the first argument to your program.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.Metadata">
<summary>
Arbitrary metadata that has been added to the definition
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.HasExamples">
<summary>
Returns true if there is at least 1 example registered for this definition
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.Examples">
<summary>
Examples that show users how to use your program.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.ExceptionBehavior">
<summary>
Determines how end user errors should be handled by the parser. By default all exceptions flow through to your program.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.SpecifiedAction">
<summary>
If your definition declares actions and has been successfully parsed then this property will be populated
with the action that the end user specified.
</summary>
</member>
<member name="P:PowerArgs.CommandLineArgumentsDefinition.HasSpecifiedAction">
<summary>
Returns true if this definition has been processed and an action was specified
</summary>
</member>
<member name="T:PowerArgs.Query">
<summary>
A hook you can use to easily query a data source. See an example here: https://github.com/adamabdelhamed/PowerArgs#data-source-queries
</summary>
</member>
<member name="M:PowerArgs.Query.#ctor(System.Type,System.String[])">
<summary>
Creates a new query hook given a data source type and optional reference assemblies.
</summary>
<param name="dataSourceType">Your data source implementation. he query will create a new instance of this type and use a property that matches the property name of the PowerArgs property this attribute is on in order to get the data.</param>
<param name="referencedAssemblies">The names (if in the GAC) or full paths to assemblies you would like to include. We will automatically add dlls in your bin folder.</param>
</member>
<member name="M:PowerArgs.Query.AfterPopulateProperties(PowerArgs.ArgHook.HookContext)">
<summary>
After PowerArgs does most of its work this hook looks for string properties on the parsed object called Skip, Take,
Where, OrderBy, and OrderByDescending. These properties are used to construct a linq query that is dynamically compiled
and executed against the provided data source.
</summary>
<param name="context">The context used to detect the query parameters.</param>
</member>
<member name="P:PowerArgs.Query.DataSourceType">
<summary>
Your data source implementation. The query will create a new instance of this type and use a property
that matches the property name of the PowerArgs property this attribute is on in order to get the data.
</summary>
</member>
<member name="T:PowerArgs.SecureStringArgument">
<summary>
A PowerArgs argument type that can be used to accept user input without that input appearing on the command line.
It uses secure strings under the hood.
</summary>
</member>
<member name="M:PowerArgs.SecureStringArgument.ConvertToNonsecureString">
<summary>
Converts the underlying secure string to a regular string.
</summary>
<returns>A normal string representation of the user's input.</returns>
</member>
<member name="P:PowerArgs.SecureStringArgument.SecureString">
<summary>
The secure string value. The first time your code accesses this property is when the user will be presented with
the secure input prompt.
</summary>
</member>
<member name="T:PowerArgs.ArgumentAwareTabCompletionSource">
<summary>
An abstract class that can be used to implement tab completion logic that is specific to a given argument.
</summary>
</member>
<member name="M:PowerArgs.ArgumentAwareTabCompletionSource.TryComplete(System.Boolean,System.String,System.String,System.String@)">
<summary>
Internal implementation that determines whether or not the context matches the target command line argument
</summary>
<param name="shift">true if the shift key was pressed along with the tab key</param>
<param name="context">the completed token that appeared on the command line before the current, incomplete token that's being tabbed through</param>
<param name="soFar">the incomplete token</param>
<param name="completion">the completion to populate</param>
<returns>true if completion was successful, false otherwise</returns>
</member>
<member name="M:PowerArgs.ArgumentAwareTabCompletionSource.TryComplete(System.Boolean,PowerArgs.CommandLineArgument,System.String,System.String@)">
<summary>
The abstract method that should be implemented to perform some tab completion logic
</summary>
<param name="shift">true if the shift key was pressed along with the tab key</param>
<param name="target">the command line argument that the soFar token is going to apply to</param>
<param name="soFar">the incomplete token</param>
<param name="completion">the completion to populate</param>
<returns>true if completion was successful, false otherwise</returns>
</member>
<member name="M:PowerArgs.ArgumentAwareTabCompletionSource.TryComplete(System.Boolean,System.String,System.String@)">
<summary>
Not implemented
</summary>
<param name="shift">Not implemented</param>
<param name="soFar">Not implemented</param>
<param name="completion">Not implemented</param>
<returns>throws NotImplementedException</returns>
</member>
<member name="T:PowerArgs.CycledTabCompletionManager">
<summary>
This helper class can be leveraged when implementing custom tab completion logic. It knows how to cycle through multple
candidates and support tabbing forward and shift/tabbing backwards. You just pass values from the tab completion methods
and then provide an evaluation function that knows how to get the list of possible matches.
</summary>
</member>
<member name="M:PowerArgs.CycledTabCompletionManager.Cycle(System.Boolean,System.String@,System.Func{System.Collections.Generic.List{System.String}},System.String@)">
<summary>
Cycles through the candidates provided by the given evaluation function using the arguments passed through from
the tab completion system.
</summary>
<param name="shift">You should pass true if the shift key was pressed during the tab</param>
<param name="soFar">You should pass through a reference to the soFar value that was sent by the tab completion system</param>
<param name="evaluation">A function that looks at 'soFar' and determines which values might be a match</param>
<param name="completion">The completion to populate if the conditions all work out</param>
<returns>True if completion was populated, false otherwise</returns>
</member>
<member name="P:PowerArgs.CycledTabCompletionManager.MinCharsBeforeCyclingBegins">
<summary>
If the value of soFar is a string that's less than this value then no completion will be returned.
</summary>
</member>
<member name="T:PowerArgs.GroupedRegexArg">
<summary>
An abstract class that lets you create custom argument types that match a regular expression. The
class also makes it easy to extract named groups from the regular expression for use by your application.
</summary>
</member>
<member name="F:PowerArgs.GroupedRegexArg.exactMatch">
<summary>
The match that exactly matches the given regular expression
</summary>
</member>
<member name="M:PowerArgs.GroupedRegexArg.#ctor(System.String,System.String,System.String)">
<summary>
Creates a new grouped regular expression argument instance.
</summary>
<param name="regex">The regular expression to enforce</param>
<param name="input">The user input that was provided</param>
<param name="errorMessage">An error message to show in the case of a non match</param>
</member>
<member name="M:PowerArgs.GroupedRegexArg.Group(System.String,System.String)">
<summary>
A helper function you can use to group a particular regular expression.
</summary>
<param name="regex">Your regular expression that you would like to put in a group.</param>
<param name="groupName">The name of the group that you can use to extract the group value later.</param>
<returns></returns>
</member>
<member name="P:PowerArgs.GroupedRegexArg.Item(System.String)">
<summary>
Gets the value of the regex group from the exact match.
</summary>
<param name="groupName">The name of the group to lookup</param>
<returns></returns>
</member>
<member name="P:PowerArgs.GroupedRegexArg.Item(System.Int32)">
<summary>
Gets the value of the regex group from the exact match.
</summary>
<param name="groupNumber">The index of the group to lookup</param>
<returns></returns>
</member>
<member name="T:PowerArgs.MultiTabCompletionSource">
<summary>
An aggregate tab completion source that cycles through it's inner sources looking for matches.
</summary>
</member>
<member name="M:PowerArgs.MultiTabCompletionSource.#ctor(PowerArgs.ITabCompletionSource[])">
<summary>
Create a new MultiTabCompletionSource given an array of sources.
</summary>
<param name="sources">The sources to wrap</param>
</member>
<member name="M:PowerArgs.MultiTabCompletionSource.#ctor(System.Collections.Generic.IEnumerable{PowerArgs.ITabCompletionSource})">
<summary>
Create a new MultiTabCompletionSource given an IEnumerable of sources.
</summary>
<param name="sources">The sources to wrap</param>
</member>
<member name="M:PowerArgs.MultiTabCompletionSource.TryComplete(System.Boolean,System.String,System.String@)">
<summary>
Not implemented since this type implements ITabCompletionSourceWithContext
</summary>
<param name="shift"></param>
<param name="soFar"></param>
<param name="completion"></param>
<returns></returns>
</member>
<member name="M:PowerArgs.MultiTabCompletionSource.TryComplete(System.Boolean,System.String,System.String,System.String@)">
<summary>
Iterates over the wrapped sources looking for a match
</summary>
<param name="shift">Indicates if shift was being pressed</param>
<param name="soFar">The text token that the user has typed before pressing tab.</param>
<param name="context"></param>
<param name="completion">The variable that you should assign the completed string to if you find a match.</param>
<returns></returns>
</member>
<member name="T:PowerArgs.SimpleTabCompletionSource">
<summary>
A simple tab completion source implementation that looks for matches over a set of pre-determined strings.
</summary>
</member>
<member name="M:PowerArgs.SimpleTabCompletionSource.#ctor(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Creates a new completion source given an enumeration of string candidates
</summary>
<param name="candidates"></param>
</member>
<member name="M:PowerArgs.SimpleTabCompletionSource.#ctor(System.Func{System.Collections.Generic.IEnumerable{System.String}})">
<summary>
Creates a simple tab completion source given a function used to evaluate the candidates.
</summary>
<param name="candidateFunction">The function used to evaluate the completions where the input is a string parameter that represents the incomplete token</param>
</member>
<member name="M:PowerArgs.SimpleTabCompletionSource.TryComplete(System.Boolean,System.String,System.String@)">
<summary>
Not implemented since this type implements ITabCompletionSourceWithContext
</summary>
<param name="shift"></param>
<param name="soFar"></param>
<param name="completion"></param>
<returns></returns>
</member>
<member name="M:PowerArgs.SimpleTabCompletionSource.TryComplete(System.Boolean,System.String,System.String,System.String@)">
<summary>
Iterates through the candidates to try to find a match. If there are multiple possible matches it
supports cycling through tem as the user continually presses tab.
</summary>
<param name="shift">Indicates if shift was being pressed</param>
<param name="soFar">The text token that the user has typed before pressing tab.</param>
<param name="context"></param>
<param name="completion">The variable that you should assign the completed string to if you find a match.</param>
<returns></returns>
</member>
<member name="P:PowerArgs.SimpleTabCompletionSource.MinCharsBeforeCyclingBegins">
<summary>
Require that the user type this number of characters before the source starts cycling through ambiguous matches. The default is 3.
</summary>
</member>
<member name="T:PowerArgs.USPhoneNumber">
<summary>
An example of a custom type that uses regular expressions to extract values from the command line
and implements an ArgReviver to transform the text input into a complex type.
This class represents a US phone number.
</summary>
</member>
<member name="M:PowerArgs.USPhoneNumber.#ctor(System.String)">
<summary>
Creates a phone number object from a string
</summary>
<param name="phoneNumber"></param>
</member>
<member name="M:PowerArgs.USPhoneNumber.ToString">
<summary>
Gets the default string representation of the phone number in the format '1-(aaa)-bbb-cccc'.
</summary>
<returns></returns>
</member>
<member name="M:PowerArgs.USPhoneNumber.ToString(System.String)">
<summary>
Formats the phone number as a string.
</summary>
<param name="format">Use '{aaa}' for the area code, use {bbb} for the first grouping, and use {cccc} for the second grouping.</param>
<returns>A formatted phone number string</returns>
</member>
<member name="M:PowerArgs.USPhoneNumber.Revive(System.String,System.String)">
<summary>
Custom PowerArgs reviver that converts a string parameter into a custom phone number
</summary>
<param name="key">The name of the argument (not used)</param>
<param name="val">The value specified on the command line</param>
<returns>A USPhoneNumber object based on the user input</returns>
</member>
<member name="P:PowerArgs.USPhoneNumber.AreaCode">
<summary>
The three digit area code of the phone number.
</summary>
</member>
<member name="P:PowerArgs.USPhoneNumber.FirstDigits">
<summary>
The three digit first segment of the phone number
</summary>
</member>
<member name="P:PowerArgs.USPhoneNumber.SecondDigits">
<summary>
The four digit second segment of the phone number.
</summary>
</member>
<member name="T:PowerArgs.ArgumentAwareTabCompletionAttribute">
<summary>
An attribute that can be placed on an argument property that adds argument aware tab completion for users who press the tab key while
in the context of the targeted argument.
</summary>
</member>
<member name="M:PowerArgs.ArgumentAwareTabCompletionAttribute.#ctor(System.Type)">
<summary>
Creates a new ArgumentAwareTabCompletionAttribute given a completion source type
</summary>
<param name="completionSourceType"></param>
</member>
<member name="P:PowerArgs.ArgumentAwareTabCompletionAttribute.CompletionSourceType">
<summary>
The tab completion source type that will be used to implement tab completion
</summary>
</member>
<member name="T:PowerArgs.TabCompletion">
<summary>
A hook that takes over the command line and provides tab completion for known strings when the user presses
the tab key.
</summary>
</member>
<member name="M:PowerArgs.TabCompletion.#ctor(System.String)">
<summary>
Creates a new tab completion hook.
</summary>
<param name="indicator">When this indicator is the only argument the user specifies that triggers the hook to enhance the command prompt. By default, the indicator is the empty string.</param>
</member>
<member name="M:PowerArgs.TabCompletion.#ctor(System.Type,System.String)">
<summary>
Creates a new tab completion hook given a custom tab completion implementation.
</summary>
<param name="completionSource">A type that implements ITabCompletionSource such as SimpleTabCompletionSource</param>
<param name="indicator">When this indicator is the only argument the user specifies that triggers the hook to enhance the command prompt. By default, the indicator is the empty string.</param>
</member>
<member name="M:PowerArgs.TabCompletion.BeforeParse(PowerArgs.ArgHook.HookContext)">
<summary>
Before PowerArgs parses the args, this hook inspects the command line for the indicator and if found
takes over the command line and provides tab completion.
</summary>
<param name="context">The context used to inspect the command line arguments.</param>
</member>
<member name="M:PowerArgs.TabCompletion.ClearHistory">
<summary>
Clears all history saved on disk
</summary>
</member>
<member name="P:PowerArgs.TabCompletion.Indicator">
<summary>
When this indicator is the only argument the user specifies that triggers the hook to enhance the command prompt. By default, the indicator is the empty string.
</summary>
</member>
<member name="P:PowerArgs.TabCompletion.HistoryToSave">
<summary>
If this is > 0 then PowerArgs will save this many previous executions of the command line to your application data folder.
Users can then access the history by pressing arrow up or down from the enhanced command prompt.
</summary>
</member>
<member name="P:PowerArgs.TabCompletion.HistoryFileName">
<summary>
The location of the history file name (AppData/PowerArgs/EXE_NAME.TabCompletionHistory.txt
</summary>
</member>
<member name="P:PowerArgs.TabCompletion.ExeName">
<summary>
The name of your program (leave null and PowerArgs will try to detect it automatically)
</summary>
</member>
<member name="P:PowerArgs.TabCompletion.REPL">
<summary>
If true, then you must use Args.InvokeAction or Args.InvokeMain instead of Args.Parse. Your user
will get an interactive prompt that loops until they specify the REPLExitIndicator.
</summary>
</member>
<member name="P:PowerArgs.TabCompletion.REPLExitIndicator">
<summary>
The string users can specify in order to exit the REPL (defaults to string.Empty)
</summary>
</member>
<member name="P:PowerArgs.TabCompletion.REPLWelcomeMessage">
<summary>
The message to display to the user when the REPL starts. The default is Type a command or '{{Indicator}}' to exit.
You can customize this message and use {{Indicator}} for the placeholder for your exit indicator.
</summary>
</member>
<member name="T:PowerArgs.ArgCantBeCombinedWith">
<summary>
Argument metadata that lets you declare that a particular argument is not allowed if one or more other arguments are specified by the user.
</summary>
</member>
<member name="M:PowerArgs.ArgCantBeCombinedWith.#ctor(System.String)">
<summary>
Creates a new ArgCantBeCombinedWith hook given an expression. This can either be an alias argument or a boolean expression of arguments (e.g. Argument1 | Argument2). Valid operators are
and '&', or '|', and not '!'. Grouping with parentheses is also supported. Example: "(Argument1 & Argumrnt2) | Argument3".
If the expression evaluates to true after all arguments have been populated then an UnexpectedArgumentException is thrown.
</summary>
<param name="expression">This can either be an alias argument or a boolean expression of arguments (e.g. Argument1 | Argument2). Valid operators are
and '&', or '|', and not '!'. Grouping with parentheses is also supported. Example: "(Argument1 & Argumrnt2) | Argument3".</param>
</member>
<member name="M:PowerArgs.ArgCantBeCombinedWith.IsCurrentArgumentAllowed(PowerArgs.ArgHook.HookContext)">
<summary>
Determines if the current argument is allowed to be populated based on which other arguments are present and based on the expression passed to the constructor.
</summary>
<param name="context">The current PowerArgs processing context</param>
<returns>True if this argument can be specified, false otherwise</returns>
</member>
<member name="M:PowerArgs.ArgCantBeCombinedWith.AfterPopulateProperties(PowerArgs.ArgHook.HookContext)">
<summary>
Checks to see if the current argument is allowed to have a value based on which other arguments are present and based on the expression
passed to the constructor. If it's not allowed and has been specified then an UnexpectedArgException is thrown.
</summary>
<param name="context">The current PowerArgs processing context</param>
</member>
<member name="P:PowerArgs.ArgCantBeCombinedWith.ExpressionText">
<summary>
The expression text that was passed into the constructor. This can either be an alias argument or a boolean expression of arguments (e.g. Argument1 | Argument2). Valid operators are
and '&', or '|', and not '!'. Grouping with parentheses is also supported. Example: "(Argument1 & Argumrnt2) | Argument3".
</summary>
</member>
<member name="T:PowerArgs.ArgExistingDirectory">
<summary>
Validates that if the user specifies a value for a property that the value represents a directory that exists
as determined by System.IO.Directory.Exists(directory).
</summary>
</member>
<member name="T:PowerArgs.ArgValidator">
<summary>
An abstract class that all validators should extend to validate user input from the command line.
</summary>
</member>
<member name="M:PowerArgs.ArgValidator.Validate(System.String,System.String@)">
<summary>
Most validators should just override this method. It ONLY gets called if the user specified the
given argument on the command line, meaning you will never get a null for 'arg'.
If you want your validator to run even if the user did not specify the argument on the command line
(for example if you were building something like [ArgRequired] then you should do 3 things.
1 - Override the boolean ImplementsValidateAlways property so that it returns true
2 - Override the ValidateAlways() method instead
3 - Don't override the Validate() method since it will no longer be called
</summary>
<param name="name"></param>
<param name="arg">The value specified on the command line. If the user specified the property name, but not a value then arg will equal string.Empty. The value will never be null.</param>
</member>
<member name="M:PowerArgs.ArgValidator.ValidateAlways(System.Reflection.PropertyInfo,System.String@)">
<summary>
Always validates the given property, even if it was not specified by the user (arg will be null in this case).
If you override this method then you should also override ImplementsValidateAlways so it returns true.
</summary>
<param name="property">The property that the attribute was placed on.</param>
<param name="arg">The value specified on the command line or null if the user didn't actually specify a value for the property. If the user specified the property name, but not a value then arg will equal string.Empty</param>
</member>
<member name="M:PowerArgs.ArgValidator.ValidateAlways(PowerArgs.CommandLineArgument,System.String@)">
<summary>
Always validates the given argument, even if it was not specified by the user (arg will be null in this case).
If you override this method then you should also override ImplementsValidateAlways so it returns true.
</summary>
<param name="argument">The argument that the attribute was placed on.</param>
<param name="arg">The value specified on the command line or null if the user didn't actually specify a value for the argument. If the user specified the argument name, but not a value then arg will equal string.Empty</param>
</member>
<member name="P:PowerArgs.ArgValidator.Priority">
<summary>
Determines the order in which validators are executed. Higher numbers execute first.
</summary>
</member>
<member name="P:PowerArgs.ArgValidator.ImplementsValidateAlways">
<summary>
If implemented in a derived class then ValidateAlways will be called for each property,
even if that property wasn't specified by the user on the command line. In this case the value
will always be null. This is useful for implementing validators such as [ArgRequired].
By default, the Validate(string,ref string) method is called unless a validator opts into ValidateAlways
</summary>
</member>
<member name="M:PowerArgs.ArgExistingDirectory.Validate(System.String,System.String@)">
<summary>
Validates that the given directory exists and cleans up the argument so that the application has access
to the full path.
</summary>
<param name="name">the name of the property being populated. This validator doesn't do anything with it.</param>
<param name="arg">The value specified on the command line</param>
</member>
<member name="T:PowerArgs.ArgExistingFile">
<summary>
Validates that if the user specifies a value for a property that the value represents a file that exists
as determined by System.IO.File.Exists(file).
</summary>
</member>
<member name="M:PowerArgs.ArgExistingFile.Validate(System.String,System.String@)">
<summary>
Validates that the given file exists and cleans up the argument so that the application has access
to the full path.
</summary>
<param name="name">the name of the property being populated. This validator doesn't do anything with it.</param>
<param name="arg">The value specified on the command line</param>
</member>
<member name="T:PowerArgs.ArgRange">
<summary>
Validates that the value is a number between the min and max (both inclusive) specified
</summary>
</member>
<member name="M:PowerArgs.ArgRange.#ctor(System.Double,System.Double)">
<summary>
Creates a new ArgRange validator.
</summary>
<param name="min">The minimum value (inclusive)</param>
<param name="max">The maximum value (inclusive by default, set MaxIsExclusive to true to override)</param>
</member>
<member name="M:PowerArgs.ArgRange.Validate(System.String,System.String@)">
<summary>
Validates that the value is a number between the min and max (both inclusive) specifie
</summary>
<param name="name">the name of the property being populated. This validator doesn't do anything with it.</param>
<param name="arg">The value specified on the command line</param>
</member>
<member name="P:PowerArgs.ArgRange.MaxIsExclusive">
<summary>
Set to true if your max is exclusive. This value is false by default.
</summary>
</member>
<member name="T:PowerArgs.ArgRegex">
<summary>
Performs regular expression validation on a property.
</summary>
</member>
<member name="F:PowerArgs.ArgRegex.regex">
<summary>
The regular expression to match
</summary>
</member>
<member name="F:PowerArgs.ArgRegex.errorMessage">
<summary>
A prefix for the error message to show in the case of a match.
</summary>
</member>
<member name="F:PowerArgs.ArgRegex.exactMatch">
<summary>
The exact match that was found.
</summary>
</member>
<member name="M:PowerArgs.ArgRegex.#ctor(System.String,System.String)">
<summary>
Creates a new ArgRegex validator.
</summary>
<param name="regex">The regular expression that requires an exact match to be valid</param>
<param name="errorMessage">A prefix for the error message to show in the case of a match.</param>
</member>
<member name="M:PowerArgs.ArgRegex.Validate(System.String,System.String@)">
<summary>
Validates that the given arg exactly matches the regular expression provided.
</summary>
<param name="name">the name of the property being populated. This validator doesn't do anything with it.</param>
<param name="arg">The value specified on the command line.</param>
</member>
<member name="T:PowerArgs.ArgRequired">
<summary>
Validates that the user actually provided a value for the given property on the command line.
</summary>
</member>
<member name="M:PowerArgs.ArgRequired.#ctor">
<summary>
Creates a new ArgRequired attribute.
</summary>
</member>
<member name="M:PowerArgs.ArgRequired.ValidateAlways(PowerArgs.CommandLineArgument,System.String@)">
<summary>
Validates that the user actually specified a value and optionally prompts them when it is missing.
</summary>
<param name="argument">The argument being populated. This validator doesn't do anything with it.</param>
<param name="arg">The value specified on the command line or null if it wasn't specified</param>
</member>
<member name="P:PowerArgs.ArgRequired.ImplementsValidateAlways">
<summary>
Determines whether or not the validator should run even if the user doesn't specify a value on the command line.
This value is always true for this validator.
</summary>
</member>
<member name="P:PowerArgs.ArgRequired.If">
<summary>
A valid command line alias or boolean expression of aliases (and/or/not supported as and '&', or '|', and not '!').
When specified the target argument is only required if the referenced argument(s) were specified on the command line.
</summary>
</member>
<member name="P:PowerArgs.ArgRequired.IfNot">
<summary>
A valid command line alias or boolean expression of aliases (and/or/not supported as and '&', or '|', and not '!').
When specified the target argument is only required if the referenced argument(s) were not specified on the command line.
</summary>
</member>
<member name="P:PowerArgs.ArgRequired.IsConditionallyRequired">
<summary>
Determines if this metadata represents an argument conditionionally required. This will be true if you've set the If or the IfNot property.
</summary>
</member>
<member name="P:PowerArgs.ArgRequired.PromptIfMissing">
<summary>
If you set this to true and the user didn't specify a value then the command line will prompt the user for the value.
</summary>
</member>
</members>
</doc>
param(
[Parameter(Position=0,Mandatory=0)]
[string[]]$tasklist = @('Default'),
[Parameter(Position=1,Mandatory=0)]
[string]$configuration = 'Debug',
[int]$build_number = 0,
[switch]$teamcity_build,
[string]$chocolatey_api_key = "",
[string]$chocolatey_api_url = ""
)
Write-Host $teamcityBuild
$scriptPath = Split-Path $MyInvocation.InvocationName
Import-Module (join-path $scriptPath 'build\psake.psm1')
Invoke-Psake -framework '4.0' -buildFile (join-path $scriptPath 'build\default.ps1') -taskList $tasklist -properties @{
"configuration"="$configuration";
"build_number"="$build_number";
"teamcityBuild"="$($teamcity_build.ToBool())";
"chocolateyApiKey" = "$chocolatey_api_key";
"chocolateyApiUrl" = "$chocolatey_api_url";
"verbose" = "$($PSBoundParameters['Verbose'])"}
param(
[string]$build_dir
)
Import-Module (Join-Path $build_dir "modules/buildtasks.psm1") -Force
Import-Module (Join-Path $build_dir "modules/contextclass.psm1") -Force
Import-Module (Join-Path $build_dir "modules/chocolateytasks.psm1") -Force
properties{
$configuration = "Debug"
$build_number = 0
[switch]$teamcityBuild = $false
$chocolateyApiKey = ""
$chocolateyApiUrl = ""
[switch]$verbose = $false
}
$build_dir = (Split-Path $psake.build_script_file)
$add_includes = Join-Path $build_dir "add-includes.ps1"
& $add_includes @($build_dir)
FormatTaskName (("-"*25) + "[{0}]" + ("-"*25))
Task TeamCityBuildStep -Depends PatchAssemblyInfo, BuildSolution, Test, ChocolateyPublishPackage
Task Default -Depends BuildSolution, Test
Task BuildSolution -Depends Clean, Build
Task SetupContext {
$global:context = ContextClass -psake_build_script_dir $build_dir -relative_solution_path %context.SolutionPath% -props $properties
$global:context
}
Task NugetExists {
$nugetFile = Join-Path "$($global:context.build_dir)" NuGet.exe
if (Test-Path $nugetFile){
return
}
((new-object net.webclient).DownloadFile('http://www.nuget.org/nuget.exe', $nugetFile))
}
Task Clean -Depends SetupContext {
Write-Host "Creating build-output directory" -ForegroundColor Green
if (Test-Path $($global:context.build_artifacts_dir)){
rd $($global:context.build_artifacts_dir) -rec -force | out-null
}
mkdir $($global:context.build_artifacts_dir) | out-null
Write-Host "Cleaning $($global:context.sln_file_info.Name) ($($global:context.configuration))" -ForegroundColor Green
Exec { msbuild $($global:context.sln_file_info.FullName) /t:Clean /p:Configuration=$($global:context.configuration) /v:quiet }
}
Task NugetRestore -Depends SetupContext, NugetExists {
& "$($global:context.build_dir)\nuget.exe" @('restore', $($global:context.sln_file_info.FullName))
}
Task Build -Depends SetupContext, Clean, NugetRestore{
Write-Host "Building $($global:context.sln_file_info.Name) ($($global:context.configuration))" -ForegroundColor Green
$verboseLevel = "quiet"
if ($verbose) {
$verboseLevel = "normal"
}
Exec { msbuild "$($global:context.sln_file_info.FullName)" /t:ReBuild /p:Configuration=$($global:context.configuration) /v:$verboseLevel /p:OutDir=$($global:context.build_artifacts_dir) }
}
Task Test -Depends SetupContext {
$xunit_consoleRunner = Join-Path $($global:context.sln_file_info.Directory.FullName) "\packages\xunit.runners.**\tools\xunit.console.clr4.exe"
Get-ChildItem -Path $($global:context.build_artifacts_dir) -Filter *.Tests.dll |
% {
Debug("$xunit_consoleRunner @($($_.FullName), '/silent')")
& $xunit_consoleRunner @($_.FullName, '/silent')
if($LastExitCode -ne 0){
throw "failed executing tests $_.FullName. See last error."
}
}
}
function Debug($message){
Write-Verbose $message
}
function Get-GitCommit{
$gitLog = git log --oneline -1
return $gitLog.Split(' ')[0]
}
function Get-VersionFromGitTag{
$gitTag = git describe --tags --abbrev=0
return $gitTag.Replace("v", "") + ".0"
}
function Read-GitCommitMessage{
$gitLog = git log --oneline -1
if ($LASTEXITCODE -gt 0)
{
return ""
}
return $gitLog
}
function Invoke-GenerateAssemblyInfo{
param(
[string]$title,
[string]$description,
[string]$company,
[string]$product,
[string]$copyright,
[string]$version,
[string]$file = $(throw "file is a required parameter.")
)
if ($($global:context.is_git_repo)){
$commit = Read-GitCommitMessage
$versionInfo = "$version / $commit"
}else{
$versionInfo = "$version"
}
$asmInfo = "using System;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
[assembly: ComVisibleAttribute(false)]
[assembly: AssemblyTitleAttribute(""$title"")]
[assembly: AssemblyDescriptionAttribute(""$description"")]
[assembly: AssemblyCompanyAttribute(""$company"")]
[assembly: AssemblyProductAttribute(""$product"")]
[assembly: AssemblyCopyrightAttribute(""$copyright"")]
[assembly: AssemblyVersionAttribute(""$version"")]
[assembly: AssemblyInformationalVersionAttribute(""$versionInfo"")]
[assembly: AssemblyFileVersionAttribute(""$version"")]
[assembly: AssemblyDelaySignAttribute(false)]
"
$dir = [System.IO.Path]::GetDirectoryName($file)
if ([System.IO.Directory]::Exists($dir) -eq $false){
Write-Host "Creating directory $dir"
[System.IO.Directory]::CreateDirectory($dir)
}
Write-Host "Generating assembly info file: $file"
Write-Output $asmInfo > $file
}
Task PatchAssemblyInfo -Depends SetupContext {
$version = $global:context.build_version
$assemblyInfoFiles = Get-ChildItem -Path $($global:context.root_dir) -Filter "AssemblyInfo.cs" -Recurse |
Where { -not $_.FullName.Contains("Templates\") -and -not $_.FullName.Contains("\bin\") }
ForEach ($assemblyInfoFile in $assemblyInfoFiles){
$assemblyTitle = $assemblyInfoFile.Directory.Parent.Name
$assemblyDescription = $assemblyTitle.Replace(".", " ") + " functionality"
Invoke-GenerateAssemblyInfo -title $assemblyTitle -description $assemblyDescription -version $version -file $assemblyInfoFile.FullName
}
if ($($global:context.teamcity_build)) {
Write-Host "##teamcity[buildNumber '$version']"
}
}
Task ChocolateyExists{
try{
& choco
}catch{
iex ((new-object net.webclient).DownloadString('https://chocolatey.org/install.ps1'))
}
}
Task ChocolateyBuildPackage -Depends ChocolateyExists{
$choco_output_dir = "$($global:context.root_dir)\chocolatey-output"
$choco_nuspec = "$choco_output_dir\crane.nuspec"
Remove-Item $choco_output_dir -Recurse -Force -ErrorAction SilentlyContinue
New-Item -ItemType directory -Path $choco_output_dir -Force
$nuspectemplate = Get-Content "$($global:context.root_dir)\src\Crane.Chocolatey\crane.nuspec" | Out-String
$nuspectemplate = $nuspectemplate.Replace("##version_number##", $($global:context.build_version))
$nuspectemplate = $nuspectemplate.Replace("##build_output##", $($global:context.build_artifacts_dir))
New-Item -Path $choco_nuspec -ItemType File -Value $nuspectemplate
& cpack @($choco_nuspec)
Move-Item *.nupkg $choco_output_dir
}
Task ChocolateyPublishPackage -Depends ChocolateyBuildPackage{
Get-ChildItem "$($global:context.root_dir)\chocolatey-output" -Filter *.nupkg |
Foreach-Object{
& "$($global:context.build_dir)\nuget.exe" @('push', $_.FullName, "-s", $($global:context.chocolatey_api_url), $($global:context.chocolatey_api_key))
}
}
$contextclass = new-object psobject -Property @{
root_dir = $null
build_dir = $null
sln_file_info = $null
build_version = $null
build_artifacts_dir = $null
configuration = $null
chocolatey_api_key = $null
chocolatey_api_url = $null
teamcity_build = $null
is_git_repo = $null
}
function ContextClass {
param(
[Parameter(Mandatory=$true)]
[String]$psake_build_script_dir,
[Parameter(Mandatory=$true)]
[String]$relative_solution_path,
$props
)
$context = $ContextClass.psobject.copy()
$context.root_dir = Resolve-Path "$psake_build_script_dir\.."
$context.build_dir = $psake_build_script_dir
$context.sln_file_info = Get-Item -Path (Resolve-Path (Join-Path $psake_build_script_dir $relative_solution_path))
$context.build_version = "$(Get-Content -Path "$($context.root_dir)\VERSION.txt").$($props.build_number)"
$context.build_artifacts_dir = "$($context.root_dir)\build-output"
$context.is_git_repo = Test-Path (Join-Path $context.root_dir '.git')
$context.configuration = $props.configuration
$context.chocolatey_api_key = $props.chocolateyApiKey
$context.chocolatey_api_url = $props.chocolateyApiUrl
$context.teamcity_build = $props.teamcityBuild
$context
}
Export-ModuleMember -function ContextClass
param(
[int]$buildNumber = 0
)
if(Test-Path Env:\APPVEYOR_BUILD_NUMBER){
$buildNumber = [int]$Env:APPVEYOR_BUILD_NUMBER
Write-Host "Using APPVEYOR_BUILD_NUMBER"
}
"Build number $buildNumber"
$scriptpath = $MyInvocation.MyCommand.Path
$dir = Split-Path $scriptpath
$psakeVersion = (gc $dir\psake.psm1 | Select-String -Pattern "$psake.Version = " | Select-Object -first 1).Line
$start = $psakeVersion.IndexOf('"') + 1
$end = $psakeVersion.IndexOf('"',$start)
$psakeVersion = $psakeVersion.Substring($start, $end - $start)
$nugetVersion = "$psakeVersion-build" + $buildNumber.ToString().PadLeft(5, '0')
"psake version $psakeVersion"
"nuget version $nugetVersion"
$destDir = "$dir\bin"
if (Test-Path $destDir -PathType container) {
Remove-Item $destDir -Recurse -Force
}
Copy-Item -Recurse $dir\nuget $destDir
Copy-Item -Recurse $dir\en-US $destDir\tools\en-US
Copy-Item -Recurse $dir\examples $destDir\tools\examples
@( "psake.cmd", "psake.ps1", "psake.psm1", "psake-config.ps1", "README.markdown", "license.txt") |
% { Copy-Item $dir\$_ $destDir\tools }
.\nuget pack "$destDir\psake.nuspec" -Verbosity quiet -Version $nugetVersion
function Main()
{
write-host "Running psake build tests" -ForeGroundColor GREEN
remove-module psake -ea SilentlyContinue
import-module .\psake.psm1
$psake.run_by_psake_build_tester = $true
$results = runBuilds
remove-module psake
""
$results | Sort 'Name' | % { if ($_.Result -eq "Passed") { write-host ($_.Name + " (Passed)") -ForeGroundColor 'GREEN'} else { write-host ($_.Name + " (Failed)") -ForeGroundColor 'RED'}}
""
$failed = $results | ? { $_.Result -eq "Failed" }
if ($failed)
{
write-host "One or more of the build files failed" -ForeGroundColor RED
exit 1
}
else
{
write-host "All Builds Passed" -ForeGroundColor GREEN
exit 0
}
}
function runBuilds()
{
$buildFiles = ls specs\*.ps1
$testResults = @()
#Add a fake build file to the $buildFiles array so that we can verify
#that Invoke-psake fails
$non_existant_buildfile = "" | select Name, FullName
$non_existant_buildfile.Name = "specifying_a_non_existant_buildfile_should_fail.ps1"
$non_existant_buildfile.FullName = "c:\specifying_a_non_existant_buildfile_should_fail.ps1"
$buildFiles += $non_existant_buildfile
foreach($buildFile in $buildFiles)
{
$testResult = "" | select Name, Result
$testResult.Name = $buildFile.Name
invoke-psake $buildFile.FullName -Parameters @{'p1'='v1'; 'p2'='v2'} -Properties @{'x'='1'; 'y'='2'} -Initialization { if(!$container) { $container = @{}; } $container.bar = "bar"; $container.baz = "baz"; $bar = 2; $baz = 3 } | Out-Null
$testResult.Result = (getResult $buildFile.Name $psake.build_success)
$testResults += $testResult
if ($testResult.Result -eq "Passed")
{
write-host "." -ForeGroundColor GREEN -NoNewLine
}
else
{
write-host "F" -ForeGroundColor RED -NoNewLine
}
}
return $testResults
}
function getResult([string]$fileName, [bool]$buildSucceeded)
{
$shouldSucceed = $null
if ($fileName.EndsWith("_should_pass.ps1"))
{
$shouldSucceed = $true
}
elseif ($fileName.EndsWith("_should_fail.ps1"))
{
$shouldSucceed = $false
}
else
{
throw "Invalid specification syntax. Specs should end with _should_pass or _should_fail. $fileName"
}
if ($buildSucceeded -eq $shouldSucceed)
{
"Passed"
}
else
{
"Failed"
}
}
main
<#
-------------------------------------------------------------------
Defaults
-------------------------------------------------------------------
$config.buildFileName="default.ps1"
$config.framework = "4.0"
$config.taskNameFormat="Executing {0}"
$config.verboseError=$false
$config.coloredOutput = $true
$config.modules=$null
-------------------------------------------------------------------
Load modules from .\modules folder and from file my_module.psm1
-------------------------------------------------------------------
$config.modules=(".\modules\*.psm1",".\my_module.psm1")
-------------------------------------------------------------------
Use scriptblock for taskNameFormat
-------------------------------------------------------------------
$config.taskNameFormat= { param($taskName) "Executing $taskName at $(get-date)" }
#>
@echo off
rem Helper script for those who want to run psake from cmd.exe
rem Example run from cmd.exe:
rem psake "default.ps1" "BuildHelloWord" "4.0"
if '%1'=='/?' goto help
if '%1'=='-help' goto help
if '%1'=='-h' goto help
powershell -NoProfile -ExecutionPolicy Bypass -Command "& '%~dp0\psake.ps1' %*; if ($psake.build_success -eq $false) { exit 1 } else { exit 0 }"
exit /B %errorlevel%
:help
powershell -NoProfile -ExecutionPolicy Bypass -Command "& '%~dp0\psake.ps1' -help"
# Helper script for those who want to run psake without importing the module.
# Example run from PowerShell:
# .\psake.ps1 "default.ps1" "BuildHelloWord" "4.0"
# Must match parameter definitions for psake.psm1/invoke-psake
# otherwise named parameter binding fails
param(
[Parameter(Position=0,Mandatory=0)]
[string]$buildFile,
[Parameter(Position=1,Mandatory=0)]
[string[]]$taskList = @(),
[Parameter(Position=2,Mandatory=0)]
[string]$framework,
[Parameter(Position=3,Mandatory=0)]
[switch]$docs = $false,
[Parameter(Position=4,Mandatory=0)]
[System.Collections.Hashtable]$parameters = @{},
[Parameter(Position=5, Mandatory=0)]
[System.Collections.Hashtable]$properties = @{},
[Parameter(Position=6, Mandatory=0)]
[alias("init")]
[scriptblock]$initialization = {},
[Parameter(Position=7, Mandatory=0)]
[switch]$nologo = $false,
[Parameter(Position=8, Mandatory=0)]
[switch]$help = $false,
[Parameter(Position=9, Mandatory=0)]
[string]$scriptPath,
[Parameter(Position=10,Mandatory=0)]
[switch]$detailedDocs = $false
)
# setting $scriptPath here, not as default argument, to support calling as "powershell -File psake.ps1"
if (!$scriptPath) {
$scriptPath = $(Split-Path -parent $MyInvocation.MyCommand.path)
}
# '[p]sake' is the same as 'psake' but $Error is not polluted
remove-module [p]sake
import-module (join-path $scriptPath psake.psm1)
if ($help) {
Get-Help Invoke-psake -full
return
}
if ($buildFile -and (-not(test-path $buildFile))) {
$absoluteBuildFile = (join-path $scriptPath $buildFile)
if (test-path $absoluteBuildFile) {
$buildFile = $absoluteBuildFile
}
}
Invoke-psake $buildFile $taskList $framework $docs $parameters $properties $initialization $nologo $detailedDocs
# psake
# Copyright (c) 2012 James Kovacs
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#Requires -Version 2.0
#-- Public Module Functions --#
# .ExternalHelp psake.psm1-help.xml
function Invoke-Task
{
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)] [string]$taskName
)
Assert $taskName ($msgs.error_invalid_task_name)
$taskKey = $taskName.ToLower()
if ($currentContext.aliases.Contains($taskKey)) {
$taskName = $currentContext.aliases.$taskKey.Name
$taskKey = $taskName.ToLower()
}
$currentContext = $psake.context.Peek()
Assert ($currentContext.tasks.Contains($taskKey)) ($msgs.error_task_name_does_not_exist -f $taskName)
if ($currentContext.executedTasks.Contains($taskKey)) { return }
Assert (!$currentContext.callStack.Contains($taskKey)) ($msgs.error_circular_reference -f $taskName)
$currentContext.callStack.Push($taskKey)
$task = $currentContext.tasks.$taskKey
$precondition_is_valid = & $task.Precondition
if (!$precondition_is_valid) {
WriteColoredOutput ($msgs.precondition_was_false -f $taskName) -foregroundcolor Cyan
} else {
if ($taskKey -ne 'default') {
if ($task.PreAction -or $task.PostAction) {
Assert ($task.Action -ne $null) ($msgs.error_missing_action_parameter -f $taskName)
}
if ($task.Action) {
try {
foreach($childTask in $task.DependsOn) {
Invoke-Task $childTask
}
$stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
$currentContext.currentTaskName = $taskName
& $currentContext.taskSetupScriptBlock
if ($task.PreAction) {
& $task.PreAction
}
if ($currentContext.config.taskNameFormat -is [ScriptBlock]) {
& $currentContext.config.taskNameFormat $taskName
} else {
WriteColoredOutput ($currentContext.config.taskNameFormat -f $taskName) -foregroundcolor Cyan
}
foreach ($variable in $task.requiredVariables) {
Assert ((test-path "variable:$variable") -and ((get-variable $variable).Value -ne $null)) ($msgs.required_variable_not_set -f $variable, $taskName)
}
& $task.Action
if ($task.PostAction) {
& $task.PostAction
}
& $currentContext.taskTearDownScriptBlock
$task.Duration = $stopwatch.Elapsed
} catch {
if ($task.ContinueOnError) {
"-"*70
WriteColoredOutput ($msgs.continue_on_error -f $taskName,$_) -foregroundcolor Yellow
"-"*70
$task.Duration = $stopwatch.Elapsed
} else {
throw $_
}
}
} else {
# no action was specified but we still execute all the dependencies
foreach($childTask in $task.DependsOn) {
Invoke-Task $childTask
}
}
} else {
foreach($childTask in $task.DependsOn) {
Invoke-Task $childTask
}
}
Assert (& $task.Postcondition) ($msgs.postcondition_failed -f $taskName)
}
$poppedTaskKey = $currentContext.callStack.Pop()
Assert ($poppedTaskKey -eq $taskKey) ($msgs.error_corrupt_callstack -f $taskKey,$poppedTaskKey)
$currentContext.executedTasks.Push($taskKey)
}
# .ExternalHelp psake.psm1-help.xml
function Exec
{
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)][scriptblock]$cmd,
[Parameter(Position=1,Mandatory=0)][string]$errorMessage = ($msgs.error_bad_command -f $cmd),
[Parameter(Position=2,Mandatory=0)][int]$maxRetries = 0,
[Parameter(Position=3,Mandatory=0)][string]$retryTriggerErrorPattern = $null
)
$tryCount = 1
do {
try {
$global:lastexitcode = 0
& $cmd
if ($lastexitcode -ne 0) {
throw ("Exec: " + $errorMessage)
}
break
}
catch [Exception]
{
if ($tryCount -gt $maxRetries) {
throw $_
}
if ($retryTriggerErrorPattern -ne $null) {
$isMatch = [regex]::IsMatch($_.Exception.Message, $retryTriggerErrorPattern)
if ($isMatch -eq $false) {
throw $_
}
}
Write-Host "Try $tryCount failed, retrying again in 1 second..."
$tryCount++
[System.Threading.Thread]::Sleep([System.TimeSpan]::FromSeconds(1))
}
}
while ($true)
}
# .ExternalHelp psake.psm1-help.xml
function Assert
{
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)]$conditionToCheck,
[Parameter(Position=1,Mandatory=1)]$failureMessage
)
if (!$conditionToCheck) {
throw ("Assert: " + $failureMessage)
}
}
# .ExternalHelp psake.psm1-help.xml
function Task
{
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)][string]$name = $null,
[Parameter(Position=1,Mandatory=0)][scriptblock]$action = $null,
[Parameter(Position=2,Mandatory=0)][scriptblock]$preaction = $null,
[Parameter(Position=3,Mandatory=0)][scriptblock]$postaction = $null,
[Parameter(Position=4,Mandatory=0)][scriptblock]$precondition = {$true},
[Parameter(Position=5,Mandatory=0)][scriptblock]$postcondition = {$true},
[Parameter(Position=6,Mandatory=0)][switch]$continueOnError = $false,
[Parameter(Position=7,Mandatory=0)][string[]]$depends = @(),
[Parameter(Position=8,Mandatory=0)][string[]]$requiredVariables = @(),
[Parameter(Position=9,Mandatory=0)][string]$description = $null,
[Parameter(Position=10,Mandatory=0)][string]$alias = $null,
[Parameter(Position=11,Mandatory=0)][string]$maxRetries = 0,
[Parameter(Position=12,Mandatory=0)][string]$retryTriggerErrorPattern = $null
)
if ($name -eq 'default') {
Assert (!$action) ($msgs.error_default_task_cannot_have_action)
}
$newTask = @{
Name = $name
DependsOn = $depends
PreAction = $preaction
Action = $action
PostAction = $postaction
Precondition = $precondition
Postcondition = $postcondition
ContinueOnError = $continueOnError
Description = $description
Duration = [System.TimeSpan]::Zero
RequiredVariables = $requiredVariables
Alias = $alias
MaxRetries = $maxRetries
RetryTriggerErrorPattern = $retryTriggerErrorPattern
}
$taskKey = $name.ToLower()
$currentContext = $psake.context.Peek()
Assert (!$currentContext.tasks.ContainsKey($taskKey)) ($msgs.error_duplicate_task_name -f $name)
$currentContext.tasks.$taskKey = $newTask
if($alias)
{
$aliasKey = $alias.ToLower()
Assert (!$currentContext.aliases.ContainsKey($aliasKey)) ($msgs.error_duplicate_alias_name -f $alias)
$currentContext.aliases.$aliasKey = $newTask
}
}
# .ExternalHelp psake.psm1-help.xml
function Properties {
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)][scriptblock]$properties
)
$psake.context.Peek().properties += $properties
}
# .ExternalHelp psake.psm1-help.xml
function Include {
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)][string]$fileNamePathToInclude
)
Assert (test-path $fileNamePathToInclude -pathType Leaf) ($msgs.error_invalid_include_path -f $fileNamePathToInclude)
$psake.context.Peek().includes.Enqueue((Resolve-Path $fileNamePathToInclude));
}
# .ExternalHelp psake.psm1-help.xml
function FormatTaskName {
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)]$format
)
$psake.context.Peek().config.taskNameFormat = $format
}
# .ExternalHelp psake.psm1-help.xml
function TaskSetup {
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)][scriptblock]$setup
)
$psake.context.Peek().taskSetupScriptBlock = $setup
}
# .ExternalHelp psake.psm1-help.xml
function TaskTearDown {
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)][scriptblock]$teardown
)
$psake.context.Peek().taskTearDownScriptBlock = $teardown
}
# .ExternalHelp psake.psm1-help.xml
function Framework {
[CmdletBinding()]
param(
[Parameter(Position=0,Mandatory=1)][string]$framework
)
$psake.context.Peek().config.framework = $framework
ConfigureBuildEnvironment
}
# .ExternalHelp psake.psm1-help.xml
function Invoke-psake {
[CmdletBinding()]
param(
[Parameter(Position = 0, Mandatory = 0)][string] $buildFile,
[Parameter(Position = 1, Mandatory = 0)][string[]] $taskList = @(),
[Parameter(Position = 2, Mandatory = 0)][string] $framework,
[Parameter(Position = 3, Mandatory = 0)][switch] $docs = $false,
[Parameter(Position = 4, Mandatory = 0)][hashtable] $parameters = @{},
[Parameter(Position = 5, Mandatory = 0)][hashtable] $properties = @{},
[Parameter(Position = 6, Mandatory = 0)][alias("init")][scriptblock] $initialization = {},
[Parameter(Position = 7, Mandatory = 0)][switch] $nologo = $false,
[Parameter(Position = 8, Mandatory = 0)][switch] $detailedDocs = $false
)
try {
if (-not $nologo) {
"psake version {0}`nCopyright (c) 2010-2014 James Kovacs & Contributors`n" -f $psake.version
}
if (!$buildFile) {
$buildFile = $psake.config_default.buildFileName
}
elseif (!(test-path $buildFile -pathType Leaf) -and (test-path $psake.config_default.buildFileName -pathType Leaf)) {
# If the $config.buildFileName file exists and the given "buildfile" isn 't found assume that the given
# $buildFile is actually the target Tasks to execute in the $config.buildFileName script.
$taskList = $buildFile.Split(', ')
$buildFile = $psake.config_default.buildFileName
}
# Execute the build file to set up the tasks and defaults
Assert (test-path $buildFile -pathType Leaf) ($msgs.error_build_file_not_found -f $buildFile)
$psake.build_script_file = get-item $buildFile
$psake.build_script_dir = $psake.build_script_file.DirectoryName
$psake.build_success = $false
$psake.context.push(@{
"taskSetupScriptBlock" = {};
"taskTearDownScriptBlock" = {};
"executedTasks" = new-object System.Collections.Stack;
"callStack" = new-object System.Collections.Stack;
"originalEnvPath" = $env:path;
"originalDirectory" = get-location;
"originalErrorActionPreference" = $global:ErrorActionPreference;
"tasks" = @{};
"aliases" = @{};
"properties" = @();
"includes" = new-object System.Collections.Queue;
"config" = CreateConfigurationForNewContext $buildFile $framework
})
LoadConfiguration $psake.build_script_dir
$stopwatch = [System.Diagnostics.Stopwatch]::StartNew()
set-location $psake.build_script_dir
LoadModules
$frameworkOldValue = $framework
. $psake.build_script_file.FullName
$currentContext = $psake.context.Peek()
if ($framework -ne $frameworkOldValue) {
writecoloredoutput $msgs.warning_deprecated_framework_variable -foregroundcolor Yellow
$currentContext.config.framework = $framework
}
ConfigureBuildEnvironment
while ($currentContext.includes.Count -gt 0) {
$includeFilename = $currentContext.includes.Dequeue()
. $includeFilename
}
if ($docs -or $detailedDocs) {
WriteDocumentation($detailedDocs)
CleanupEnvironment
return
}
foreach ($key in $parameters.keys) {
if (test-path "variable:\$key") {
set-item -path "variable:\$key" -value $parameters.$key -WhatIf:$false -Confirm:$false | out-null
} else {
new-item -path "variable:\$key" -value $parameters.$key -WhatIf:$false -Confirm:$false | out-null
}
}
# The initial dot (.) indicates that variables initialized/modified in the propertyBlock are available in the parent scope.
foreach ($propertyBlock in $currentContext.properties) {
. $propertyBlock
}
foreach ($key in $properties.keys) {
if (test-path "variable:\$key") {
set-item -path "variable:\$key" -value $properties.$key -WhatIf:$false -Confirm:$false | out-null
}
}
# Simple dot sourcing will not work. We have to force the script block into our
# module's scope in order to initialize variables properly.
. $MyInvocation.MyCommand.Module $initialization
# Execute the list of tasks or the default task
if ($taskList) {
foreach ($task in $taskList) {
invoke-task $task
}
} elseif ($currentContext.tasks.default) {
invoke-task default
} else {
throw $msgs.error_no_default_task
}
WriteColoredOutput ("`n" + $msgs.build_success + "`n") -foregroundcolor Green
WriteTaskTimeSummary $stopwatch.Elapsed
$psake.build_success = $true
} catch {
$currentConfig = GetCurrentConfigurationOrDefault
if ($currentConfig.verboseError) {
$error_message = "{0}: An Error Occurred. See Error Details Below: `n" -f (Get-Date)
$error_message += ("-" * 70) + "`n"
$error_message += "Error: {0}`n" -f (ResolveError $_ -Short)
$error_message += ("-" * 70) + "`n"
$error_message += ResolveError $_
$error_message += ("-" * 70) + "`n"
$error_message += "Script Variables" + "`n"
$error_message += ("-" * 70) + "`n"
$error_message += get-variable -scope script | format-table | out-string
} else {
# ($_ | Out-String) gets error messages with source information included.
$error_message = "Error: {0}: `n{1}" -f (Get-Date), (ResolveError $_ -Short)
}
$psake.build_success = $false
# if we are running in a nested scope (i.e. running a psake script from a psake script) then we need to re-throw the exception
# so that the parent script will fail otherwise the parent script will report a successful build
$inNestedScope = ($psake.context.count -gt 1)
if ( $inNestedScope ) {
throw $_
} else {
if (!$psake.run_by_psake_build_tester) {
WriteColoredOutput $error_message -foregroundcolor Red
}
}
} finally {
CleanupEnvironment
}
}
#-- Private Module Functions --#
function WriteColoredOutput {
param(
[string] $message,
[System.ConsoleColor] $foregroundcolor
)
$currentConfig = GetCurrentConfigurationOrDefault
if ($currentConfig.coloredOutput -eq $true) {
if (($Host.UI -ne $null) -and ($Host.UI.RawUI -ne $null) -and ($Host.UI.RawUI.ForegroundColor -ne $null)) {
$previousColor = $Host.UI.RawUI.ForegroundColor
$Host.UI.RawUI.ForegroundColor = $foregroundcolor
}
}
$message
if ($previousColor -ne $null) {
$Host.UI.RawUI.ForegroundColor = $previousColor
}
}
function LoadModules {
$currentConfig = $psake.context.peek().config
if ($currentConfig.modules) {
$scope = $currentConfig.moduleScope
$global = [string]::Equals($scope, "global", [StringComparison]::CurrentCultureIgnoreCase)
$currentConfig.modules | foreach {
resolve-path $_ | foreach {
"Loading module: $_"
$module = import-module $_ -passthru -DisableNameChecking -global:$global
if (!$module) {
throw ($msgs.error_loading_module -f $_.Name)
}
}
}
""
}
}
function LoadConfiguration {
param(
[string] $configdir = $PSScriptRoot
)
$psakeConfigFilePath = (join-path $configdir "psake-config.ps1")
if (test-path $psakeConfigFilePath -pathType Leaf) {
try {
$config = GetCurrentConfigurationOrDefault
. $psakeConfigFilePath
} catch {
throw "Error Loading Configuration from psake-config.ps1: " + $_
}
}
}
function GetCurrentConfigurationOrDefault() {
if ($psake.context.count -gt 0) {
return $psake.context.peek().config
} else {
return $psake.config_default
}
}
function CreateConfigurationForNewContext {
param(
[string] $buildFile,
[string] $framework
)
$previousConfig = GetCurrentConfigurationOrDefault
$config = new-object psobject -property @{
buildFileName = $previousConfig.buildFileName;
framework = $previousConfig.framework;
taskNameFormat = $previousConfig.taskNameFormat;
verboseError = $previousConfig.verboseError;
coloredOutput = $previousConfig.coloredOutput;
modules = $previousConfig.modules;
moduleScope = $previousConfig.moduleScope;
}
if ($framework) {
$config.framework = $framework;
}
if ($buildFile) {
$config.buildFileName = $buildFile;
}
return $config
}
function ConfigureBuildEnvironment {
$framework = $psake.context.peek().config.framework
if ($framework -cmatch '^((?:\d+\.\d+)(?:\.\d+){0,1})(x86|x64){0,1}$') {
$versionPart = $matches[1]
$bitnessPart = $matches[2]
} else {
throw ($msgs.error_invalid_framework -f $framework)
}
$versions = $null
$buildToolsVersions = $null
switch ($versionPart) {
'1.0' {
$versions = @('v1.0.3705')
}
'1.1' {
$versions = @('v1.1.4322')
}
'2.0' {
$versions = @('v2.0.50727')
}
'3.0' {
$versions = @('v2.0.50727')
}
'3.5' {
$versions = @('v3.5', 'v2.0.50727')
}
'4.0' {
$versions = @('v4.0.30319')
}
'4.5.1' {
$versions = @('v4.0.30319')
$buildToolsVersions = @('14.0', '12.0')
}
default {
throw ($msgs.error_unknown_framework -f $versionPart, $framework)
}
}
$bitness = 'Framework'
if ($versionPart -ne '1.0' -and $versionPart -ne '1.1') {
switch ($bitnessPart) {
'x86' {
$bitness = 'Framework'
$buildToolsKey = 'MSBuildToolsPath32'
}
'x64' {
$bitness = 'Framework64'
$buildToolsKey = 'MSBuildToolsPath'
}
{ [string]::IsNullOrEmpty($_) } {
$ptrSize = [System.IntPtr]::Size
switch ($ptrSize) {
4 {
$bitness = 'Framework'
$buildToolsKey = 'MSBuildToolsPath32'
}
8 {
$bitness = 'Framework64'
$buildToolsKey = 'MSBuildToolsPath'
}
default {
throw ($msgs.error_unknown_pointersize -f $ptrSize)
}
}
}
default {
throw ($msgs.error_unknown_bitnesspart -f $bitnessPart, $framework)
}
}
}
$frameworkDirs = @()
if ($buildToolsVersions -ne $null) {
$frameworkDirs = @($buildToolsVersions | foreach { (Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\MSBuild\ToolsVersions\$_" -Name $buildToolsKey).$buildToolsKey })
}
$frameworkDirs = $frameworkDirs + @($versions | foreach { "$env:windir\Microsoft.NET\$bitness\$_\" })
for ($i = 0; $i -lt $frameworkDirs.Count; $i++) {
$dir = $frameworkDirs[$i]
if ($dir -Match "\$\(Registry:HKEY_LOCAL_MACHINE(.*?)@(.*)\)") {
$key = "HKLM:" + $matches[1]
$name = $matches[2]
$dir = (Get-ItemProperty -Path $key -Name $name).$name
$frameworkDirs[$i] = $dir
}
}
$frameworkDirs | foreach { Assert (test-path $_ -pathType Container) ($msgs.error_no_framework_install_dir_found -f $_)}
$env:path = ($frameworkDirs -join ";") + ";$env:path"
# if any error occurs in a PS function then "stop" processing immediately
# this does not effect any external programs that return a non-zero exit code
$global:ErrorActionPreference = "Stop"
}
function CleanupEnvironment {
if ($psake.context.Count -gt 0) {
$currentContext = $psake.context.Peek()
$env:path = $currentContext.originalEnvPath
Set-Location $currentContext.originalDirectory
$global:ErrorActionPreference = $currentContext.originalErrorActionPreference
[void] $psake.context.Pop()
}
}
function SelectObjectWithDefault
{
[CmdletBinding()]
param(
[Parameter(ValueFromPipeline=$true)]
[PSObject]
$InputObject,
[string]
$Name,
$Value
)
process {
if ($_ -eq $null) { $Value }
elseif ($_ | Get-Member -Name $Name) {
$_.$Name
}
elseif (($_ -is [Hashtable]) -and ($_.Keys -contains $Name)) {
$_.$Name
}
else { $Value }
}
}
# borrowed from Jeffrey Snover http://blogs.msdn.com/powershell/archive/2006/12/07/resolve-error.aspx
# modified to better handle SQL errors
function ResolveError
{
[CmdletBinding()]
param(
[Parameter(ValueFromPipeline=$true)]
$ErrorRecord=$Error[0],
[Switch]
$Short
)
process {
if ($_ -eq $null) { $_ = $ErrorRecord }
$ex = $_.Exception
if (-not $Short) {
$error_message = "`nErrorRecord:{0}ErrorRecord.InvocationInfo:{1}Exception:`n{2}"
$formatted_errorRecord = $_ | format-list * -force | out-string
$formatted_invocationInfo = $_.InvocationInfo | format-list * -force | out-string
$formatted_exception = ''
$i = 0
while ($ex -ne $null) {
$i++
$formatted_exception += ("$i" * 70) + "`n" +
($ex | format-list * -force | out-string) + "`n"
$ex = $ex | SelectObjectWithDefault -Name 'InnerException' -Value $null
}
return $error_message -f $formatted_errorRecord, $formatted_invocationInfo, $formatted_exception
}
$lastException = @()
while ($ex -ne $null) {
$lastMessage = $ex | SelectObjectWithDefault -Name 'Message' -Value ''
$lastException += ($lastMessage -replace "`n", '')
if ($ex -is [Data.SqlClient.SqlException]) {
$lastException += "(Line [$($ex.LineNumber)] " +
"Procedure [$($ex.Procedure)] Class [$($ex.Class)] " +
" Number [$($ex.Number)] State [$($ex.State)] )"
}
$ex = $ex | SelectObjectWithDefault -Name 'InnerException' -Value $null
}
$shortException = $lastException -join ' --> '
$header = $null
$current = $_
$header = (($_.InvocationInfo |
SelectObjectWithDefault -Name 'PositionMessage' -Value '') -replace "`n", ' '),
($_ | SelectObjectWithDefault -Name 'Message' -Value ''),
($_ | SelectObjectWithDefault -Name 'Exception' -Value '') |
? { -not [String]::IsNullOrEmpty($_) } |
Select -First 1
$delimiter = ''
if ((-not [String]::IsNullOrEmpty($header)) -and
(-not [String]::IsNullOrEmpty($shortException)))
{ $delimiter = ' [<<==>>] ' }
return "$($header)$($delimiter)Exception: $($shortException)"
}
}
function WriteDocumentation($showDetailed) {
$currentContext = $psake.context.Peek()
if ($currentContext.tasks.default) {
$defaultTaskDependencies = $currentContext.tasks.default.DependsOn
} else {
$defaultTaskDependencies = @()
}
$docs = $currentContext.tasks.Keys | foreach-object {
if ($_ -eq "default") {
return
}
$task = $currentContext.tasks.$_
new-object PSObject -property @{
Name = $task.Name;
Alias = $task.Alias;
Description = $task.Description;
"Depends On" = $task.DependsOn -join ", "
Default = if ($defaultTaskDependencies -contains $task.Name) { $true }
}
}
if ($showDetailed) {
$docs | sort 'Name' | format-list -property Name,Alias,Description,"Depends On",Default
} else {
$docs | sort 'Name' | format-table -autoSize -wrap -property Name,Alias,"Depends On",Default,Description
}
}
function WriteTaskTimeSummary($invokePsakeDuration) {
"-" * 70
"Build Time Report"
"-" * 70
$list = @()
$currentContext = $psake.context.Peek()
while ($currentContext.executedTasks.Count -gt 0) {
$taskKey = $currentContext.executedTasks.Pop()
$task = $currentContext.tasks.$taskKey
if ($taskKey -eq "default") {
continue
}
$list += new-object PSObject -property @{
Name = $task.Name;
Duration = $task.Duration
}
}
[Array]::Reverse($list)
$list += new-object PSObject -property @{
Name = "Total:";
Duration = $invokePsakeDuration
}
# using "out-string | where-object" to filter out the blank line that format-table prepends
$list | format-table -autoSize -property Name,Duration | out-string -stream | where-object { $_ }
}
DATA msgs {
convertfrom-stringdata @'
error_invalid_task_name = Task name should not be null or empty string.
error_task_name_does_not_exist = Task {0} does not exist.
error_circular_reference = Circular reference found for task {0}.
error_missing_action_parameter = Action parameter must be specified when using PreAction or PostAction parameters for task {0}.
error_corrupt_callstack = Call stack was corrupt. Expected {0}, but got {1}.
error_invalid_framework = Invalid .NET Framework version, {0} specified.
error_unknown_framework = Unknown .NET Framework version, {0} specified in {1}.
error_unknown_pointersize = Unknown pointer size ({0}) returned from System.IntPtr.
error_unknown_bitnesspart = Unknown .NET Framework bitness, {0}, specified in {1}.
error_no_framework_install_dir_found = No .NET Framework installation directory found at {0}.
error_bad_command = Error executing command {0}.
error_default_task_cannot_have_action = 'default' task cannot specify an action.
error_duplicate_task_name = Task {0} has already been defined.
error_duplicate_alias_name = Alias {0} has already been defined.
error_invalid_include_path = Unable to include {0}. File not found.
error_build_file_not_found = Could not find the build file {0}.
error_no_default_task = 'default' task required.
error_loading_module = Error loading module {0}.
warning_deprecated_framework_variable = Warning: Using global variable $framework to set .NET framework version used is deprecated. Instead use Framework function or configuration file psake-config.ps1.
required_variable_not_set = Variable {0} must be set to run task {1}.
postcondition_failed = Postcondition failed for task {0}.
precondition_was_false = Precondition was false, not executing task {0}.
continue_on_error = Error in task {0}. {1}
build_success = Build Succeeded!
'@
}
import-localizeddata -bindingvariable msgs -erroraction silentlycontinue
$script:psake = @{}
$psake.version = "4.4.0" # contains the current version of psake
$psake.context = new-object system.collections.stack # holds onto the current state of all variables
$psake.run_by_psake_build_tester = $false # indicates that build is being run by psake-BuildTester
$psake.config_default = new-object psobject -property @{
buildFileName = "default.ps1";
framework = "4.0";
taskNameFormat = "Executing {0}";
verboseError = $false;
coloredOutput = $true;
modules = $null;
moduleScope = "";
} # contains default configuration, can be overriden in psake-config.ps1 in directory with psake.psm1 or in directory with current build script
$psake.build_success = $false # indicates that the current build was successful
$psake.build_script_file = $null # contains a System.IO.FileInfo for the current build script
$psake.build_script_dir = "" # contains a string with fully-qualified path to current build script
LoadConfiguration
export-modulemember -function Invoke-psake, Invoke-Task, Task, Properties, Include, FormatTaskName, TaskSetup, TaskTearDown, Framework, Assert, Exec -variable psake
0.0.0
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="FluentAssertions" version="3.2.1" targetFramework="net45" />
<package id="Xbehave" version="1.1.0" targetFramework="net45" />
<package id="xunit" version="1.9.2" targetFramework="net45" />
<package id="xunit.extensions" version="1.9.2" targetFramework="net45" />
</packages>
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="xunit.runners" version="1.9.2" />
</packages>
<?xml version="1.0"?>
<doc>
<assembly>
<name>Xbehave</name>
</assembly>
<members>
<member name="T:Xbehave.BackgroundAttribute">
<summary>
Applied to a method to indicate a background for each scenario defined in the same feature class.
</summary>
</member>
<member name="M:Xbehave.BackgroundAttribute.CreateBackgroundCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Creates the commands representing the backgrounds defined by the <paramref name="method"/>.
</summary>
<param name="method">The test method.</param>
<returns>An instance of <see cref="T:System.Collections.Generic.IEnumerable`1"/> representing the backgrounds defined by the <paramref name="method"/>.</returns>
</member>
<member name="M:Xbehave.BackgroundAttribute.EnumerateBackgroundCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Enumerates the commands representing the backgrounds defined by the <paramref name="method"/>.
</summary>
<param name="method">The test method.</param>
<returns>An instance of <see cref="T:System.Collections.Generic.IEnumerable`1"/> representing the backgrounds defined by the <paramref name="method"/>.</returns>
</member>
<member name="T:Xbehave.ContinueOnFailureAfterAttribute">
<summary>
Allows step execution within a scenario to continue after a failed step.
<example>
To allow step execution to continue after any failed step:
<code>[ContinueOnFailureAfter(StepType.Any)]</code>.
</example>
<example>
To allow step execution to continue after a failed step but only after the execution of the first "Then" step, use
<code>[ContinueOnFailureAfter(StepType.Then)]</code>.
</example>
The default setting is <c>StepType.None</c>.
This attribute can be applied at the level of method (scenario), class (feature) or assembly (product).
</summary>
</member>
<member name="M:Xbehave.ContinueOnFailureAfterAttribute.#ctor(Xbehave.StepType)">
<summary>
Initializes a new instance of the <see cref="T:Xbehave.ContinueOnFailureAfterAttribute"/> class.
</summary>
<param name="stepType">Type of the step.</param>
</member>
<member name="P:Xbehave.ContinueOnFailureAfterAttribute.StepType">
<summary>
Gets the type of the step.
</summary>
<value>
The type of the step.
</value>
</member>
<member name="T:Xbehave.DisposableExtensions">
<summary>
<see cref="T:System.IDisposable"/> extensions.
</summary>
</member>
<member name="M:Xbehave.DisposableExtensions.Using``1(``0)">
<summary>
Immediately registers the <see cref="T:System.IDisposable"/> object for disposal after all steps in the current scenario have been executed.
</summary>
<typeparam name="T">The type of the object.</typeparam>
<param name="obj">The object to be disposed.</param>
<returns>The object.</returns>
</member>
<member name="M:Xbehave.DisposableExtensions.Using``1(``0,Xbehave.IStepContext)">
<summary>
Immediately registers the <see cref="T:System.IDisposable"/> object for disposal after all steps in the current scenario have been executed.
</summary>
<typeparam name="T">The type of the object.</typeparam>
<param name="obj">The object to be disposed.</param>
<param name="stepContext">The execution context for the current step.</param>
<returns>The object.</returns>
</member>
<member name="T:Xbehave.ExampleAttribute">
<summary>
Provides example values for a scenario passed as arguments to the scenario method.
This attribute is designed as a synonym of <see cref="T:Xunit.Extensions.InlineDataAttribute"/>,
which is the most commonly used data attribute, but you can also use any type of attribute derived from
<see cref="T:Xunit.Extensions.DataAttribute"/> to provide a data source for a scenario.
E.g. <see cref="T:Xunit.Extensions.ClassDataAttribute"/>,
<see cref="T:Xunit.Extensions.OleDbDataAttribute"/>,
<see cref="T:Xunit.Extensions.SqlServerDataAttribute"/>,
<see cref="T:Xunit.Extensions.ExcelDataAttribute"/> or
<see cref="T:Xunit.Extensions.PropertyDataAttribute"/>.
</summary>
</member>
<member name="M:Xbehave.ExampleAttribute.#ctor(System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Xbehave.ExampleAttribute"/> class.
This attribute is designed as a synonym of <see cref="T:Xunit.Extensions.InlineDataAttribute"/>,
which is the most commonly used data attribute, but you can also use any type of attribute derived from
<see cref="T:Xunit.Extensions.DataAttribute"/> to provide a data source for a scenario.
E.g. <see cref="T:Xunit.Extensions.ClassDataAttribute"/>,
<see cref="T:Xunit.Extensions.OleDbDataAttribute"/>,
<see cref="T:Xunit.Extensions.SqlServerDataAttribute"/>,
<see cref="T:Xunit.Extensions.ExcelDataAttribute"/> or
<see cref="T:Xunit.Extensions.PropertyDataAttribute"/>.
</summary>
<param name="dataValues">The data values to pass to the scenario.</param>
</member>
<member name="T:Xbehave.Fluent.IStep">
<summary>
A scenario step.
</summary>
</member>
<member name="M:Xbehave.Fluent.IStep.And">
<summary>
An optional fluent conjunction.
</summary>
<returns>An instance of <see cref="T:Xbehave.Fluent.IStep"/>.</returns>
</member>
<member name="M:Xbehave.Fluent.IStep.WithTimeout(System.Int32)">
<summary>
Indicate that execution of the defined step should be cancelled after a specified timeout.
</summary>
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite"/> (-1) to wait indefinitely.</param>
<returns>An instance of <see cref="T:Xbehave.Fluent.IStep"/>.</returns>
</member>
<member name="M:Xbehave.Fluent.IStep.InIsolation">
<summary>
Indicates that an isolated context will be created containing this step and a copy of all preceding steps.
</summary>
<returns>An instance of <see cref="T:Xbehave.Fluent.IStep"/>.</returns>
</member>
<member name="M:Xbehave.Fluent.IStep.Skip(System.String)">
<summary>
Indicates that the step will not be executed.
</summary>
<param name="reason">The reason for not executing the step.</param>
<returns>An instance of <see cref="T:Xbehave.Fluent.IStep"/>.</returns>
</member>
<member name="M:Xbehave.Fluent.IStep.Teardown(System.Action)">
<summary>
Declares a teardown action (related to this step and/or previous steps) which will be executed after all steps in the current scenario have been executed.
</summary>
<param name="action">The action.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="T:Xbehave.IStepContext">
<summary>
A scenario step context.
</summary>
</member>
<member name="M:Xbehave.IStepContext.Using(System.IDisposable)">
<summary>
Immediately registers the <see cref="T:System.IDisposable"/> object for disposal after all steps in the current scenario have been executed.
</summary>
<param name="disposable">The object to be disposed.</param>
<returns>The current <see cref="T:Xbehave.IStepContext"/>.</returns>
</member>
<member name="T:Xbehave.OmitArgumentsFromScenarioNamesAttribute">
<summary>
Omits arguments passed to scenario methods (e.g. using <see cref="T:Xbehave.ExampleAttribute"/>) from scenario names in test output.
Disabled by default.
This attribute can be applied at the level of method (scenario), class (feature) or assembly (product).
</summary>
</member>
<member name="M:Xbehave.OmitArgumentsFromScenarioNamesAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Xbehave.OmitArgumentsFromScenarioNamesAttribute"/> class.
</summary>
<param name="enabled">If set to <c>true</c> [enabled].</param>
</member>
<member name="P:Xbehave.OmitArgumentsFromScenarioNamesAttribute.Enabled">
<summary>
Gets a value indicating whether this <see cref="T:Xbehave.OmitArgumentsFromScenarioNamesAttribute"/> is enabled.
</summary>
<value>
<c>true</c> if enabled; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Xbehave.ScenarioAttribute">
<summary>
Applied to a method to indicate the definition of a scenario.
A scenario can also be fed examples from a data source, mapping to parameters on the scenario method.
If the data source contains multiple rows, then the scenario method is executed multiple times (once with each data row).
Examples can be fed to the scenario by applying one or more instances of <see cref="T:Xbehave.ExampleAttribute"/>
or any other attribute inheriting from <see cref="T:Xunit.Extensions.DataAttribute"/>.
E.g. <see cref="T:Xunit.Extensions.ClassDataAttribute"/>,
<see cref="T:Xunit.Extensions.OleDbDataAttribute"/>,
<see cref="T:Xunit.Extensions.SqlServerDataAttribute"/>,
<see cref="T:Xunit.Extensions.ExcelDataAttribute"/> or
<see cref="T:Xunit.Extensions.PropertyDataAttribute"/>.
</summary>
</member>
<member name="M:Xbehave.ScenarioAttribute.EnumerateTestCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Enumerates the test commands representing the background and scenario steps for each isolated context.
</summary>
<param name="method">The scenario method.</param>
<returns>An instance of <see cref="T:System.Collections.Generic.IEnumerable`1"/> representing the background and scenario steps for each isolated context.</returns>
</member>
<member name="M:Xbehave.ScenarioAttribute.EnumerateBackgroundCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Enumerates the commands representing the backgrounds associated with the <paramref name="method"/>.
</summary>
<param name="method">The scenario method.</param>
<returns>An instance of <see cref="T:System.Collections.Generic.IEnumerable`1"/> representing the backgrounds associated with the <paramref name="method"/>.</returns>
</member>
<member name="M:Xbehave.ScenarioAttribute.EnumerateScenarioCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Enumerates the commands representing the scenarios defined by the <paramref name="method"/>.
</summary>
<param name="method">The scenario method.</param>
<returns>An instance of <see cref="T:System.Collections.Generic.IEnumerable`1"/> representing the scenarios defined by the <paramref name="method"/>.</returns>
<remarks>This method may be overridden.</remarks>
</member>
<member name="P:Xbehave.ScenarioAttribute.Timeout">
<summary>
Gets or sets a timeout which, if exceeded, indicates that the scenario has failed.
</summary>
<remarks>This property is deprecated in favor of timeouts on specific steps.</remarks>
</member>
<member name="T:Xbehave.StepExtensions">
<summary>
<see cref="T:Xbehave.Fluent.IStep"/> extensions.
</summary>
</member>
<member name="M:Xbehave.StepExtensions.When(Xbehave.Fluent.IStep,System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="stepDefinition">The step definition.</param>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StepExtensions.Then(Xbehave.Fluent.IStep,System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="stepDefinition">The step definition.</param>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StepExtensions.And(Xbehave.Fluent.IStep,System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="stepDefinition">The step definition.</param>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StepExtensions.But(Xbehave.Fluent.IStep,System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="stepDefinition">The step definition.</param>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StepExtensions.When(Xbehave.Fluent.IStep,System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="stepDefinition">The step definition.</param>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StepExtensions.Then(Xbehave.Fluent.IStep,System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="stepDefinition">The step definition.</param>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StepExtensions.And(Xbehave.Fluent.IStep,System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="stepDefinition">The step definition.</param>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StepExtensions.But(Xbehave.Fluent.IStep,System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="stepDefinition">The step definition.</param>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="T:Xbehave.StepType">
<summary>
Represents the type of a step.
</summary>
</member>
<member name="F:Xbehave.StepType.Any">
<summary>
Represents any step type.
</summary>
</member>
<member name="F:Xbehave.StepType.None">
<summary>
Represents no step type.
</summary>
</member>
<member name="F:Xbehave.StepType.Given">
<summary>
Represents a "Given" step.
</summary>
</member>
<member name="F:Xbehave.StepType.When">
<summary>
Represents a "When" step.
</summary>
</member>
<member name="F:Xbehave.StepType.Then">
<summary>
Represents a "Then" step.
</summary>
</member>
<member name="F:Xbehave.StepType.And">
<summary>
Represents a "And" step.
</summary>
</member>
<member name="F:Xbehave.StepType.But">
<summary>
Represents a "But" step.
</summary>
</member>
<member name="T:Xbehave.StringExtensions">
<summary>
Provides access to step definition methods.
</summary>
<summary>
Provides access to step definition methods.
</summary>
</member>
<member name="M:Xbehave.StringExtensions.Given(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.When(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.Then(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.And(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.But(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.f(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions._(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.Given(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.When(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.Then(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.And(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.But(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.f(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions._(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.GetStepType(System.String)">
<summary>
Get the appropriate step type based on the the text.
</summary>
<param name="text">The step text.</param>
<returns>The appropriate step type based on the text.</returns>
</member>
<member name="M:Xbehave.StringExtensions.Given(System.String,System.Func{System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.When(System.String,System.Func{System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.Then(System.String,System.Func{System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.And(System.String,System.Func{System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.But(System.String,System.Func{System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.f(System.String,System.Func{System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions._(System.String,System.Func{System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.Given(System.String,System.Func{Xbehave.IStepContext,System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.When(System.String,System.Func{Xbehave.IStepContext,System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.Then(System.String,System.Func{Xbehave.IStepContext,System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.And(System.String,System.Func{Xbehave.IStepContext,System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.But(System.String,System.Func{Xbehave.IStepContext,System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions.f(System.String,System.Func{Xbehave.IStepContext,System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave.StringExtensions._(System.String,System.Func{Xbehave.IStepContext,System.Threading.Tasks.Task})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="T:Xbehave._">
<summary>
Provides access to step definition methods.
</summary>
</member>
<member name="M:Xbehave._.Given(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave._.When(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave._.Then(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave._.And(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave._.But(System.String,System.Action)">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave._.Given(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave._.When(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave._.Then(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave._.And(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="M:Xbehave._.But(System.String,System.Action{Xbehave.IStepContext})">
<summary>
Defines a step in the current scenario.
</summary>
<param name="text">The step text.</param>
<param name="body">The action that will perform the step.</param>
<returns>
An instance of <see cref="T:Xbehave.Fluent.IStep"/>.
</returns>
</member>
<member name="T:Xbehave.Guard">
<summary>
Provides guard clauses.
</summary>
</member>
<member name="M:Xbehave.Guard.AgainstNullArgument``1(System.String,``0)">
<summary>
Guards against a null argument.
</summary>
<typeparam name="TArgument">The type of the argument.</typeparam>
<param name="parameterName">Name of the parameter.</param>
<param name="argument">The argument.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="argument"/> is <c>null</c>.</exception>
<remarks><typeparamref name="TArgument"/> is restricted to reference types to avoid boxing of value type objects.</remarks>
</member>
<member name="M:Xbehave.Guard.AgainstNullArgumentIfNullable``1(System.String,``0)">
<summary>
Guards against a null argument if <typeparamref name="TArgument"/> can be <c>null</c>.
</summary>
<typeparam name="TArgument">The type of the argument.</typeparam>
<param name="parameterName">Name of the parameter.</param>
<param name="argument">The argument.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="argument"/> is <c>null</c>.</exception>
<remarks>
Performs a type check to avoid boxing of value type objects.
</remarks>
</member>
<member name="M:Xbehave.Guard.AgainstNullArgumentProperty``1(System.String,System.String,``0)">
<summary>
Guards against a null argument property value.
</summary>
<typeparam name="TProperty">The type of the property.</typeparam>
<param name="parameterName">Name of the parameter.</param>
<param name="propertyName">Name of the property.</param>
<param name="argumentProperty">The argument property.</param>
<exception cref="T:System.ArgumentException"><paramref name="argumentProperty"/> is <c>null</c>.</exception>
<remarks><typeparamref name="TProperty"/> is restricted to reference types to avoid boxing of value type objects.</remarks>
</member>
<member name="M:Xbehave.Guard.AgainstNullArgumentPropertyIfNullable``1(System.String,System.String,``0)">
<summary>
Guards against a null argument property value if <typeparamref name="TProperty"/> can be <c>null</c>.
</summary>
<typeparam name="TProperty">The type of the property.</typeparam>
<param name="parameterName">Name of the parameter.</param>
<param name="propertyName">Name of the property.</param>
<param name="argumentProperty">The argument property.</param>
<exception cref="T:System.ArgumentException"><paramref name="argumentProperty"/> is <c>null</c>.</exception>
<remarks>
Performs a type check to avoid boxing of value type objects.
</remarks>
</member>
<member name="M:Xbehave.Guard.IsNullableType(System.Type)">
<summary>
Determines whether the specified type is a nullable type.
</summary>
<param name="type">The type.</param>
<returns>
<c>true</c> if the specified type is a nullable type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Xbehave.Guard.ValidatedNotNullAttribute">
<summary>
When applied to a parameter, this attribute provides an indication to code analysis that the argument has been null checked.
</summary>
</member>
</members>
</doc>
<?xml version="1.0"?>
<doc>
<assembly>
<name>xunit.extensions</name>
</assembly>
<members>
<member name="T:Xunit.Extensions.Assertions">
<summary>
A wrapper for Assert which is used by <see cref="T:Xunit.Extensions.TestClass"/>.
</summary>
</member>
<member name="M:Xunit.Extensions.Assertions.Contains``1(``0,System.Collections.Generic.IEnumerable{``0})">
<summary>
Verifies that a collection contains a given object.
</summary>
<typeparam name="T">The type of the object to be verified</typeparam>
<param name="expected">The object expected to be in the collection</param>
<param name="collection">The collection to be inspected</param>
<exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Contains``1(``0,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that a collection contains a given object, using an equality comparer.
</summary>
<typeparam name="T">The type of the object to be verified</typeparam>
<param name="expected">The object expected to be in the collection</param>
<param name="collection">The collection to be inspected</param>
<param name="comparer">The comparer used to equate objects in the collection with the expected object</param>
<exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Contains(System.String,System.String)">
<summary>
Verifies that a string contains a given sub-string, using the current culture.
</summary>
<param name="expectedSubstring">The sub-string expected to be in the string</param>
<param name="actualString">The string to be inspected</param>
<exception cref="T:Xunit.Sdk.ContainsException">Thrown when the sub-string is not present inside the string</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Contains(System.String,System.String,System.StringComparison)">
<summary>
Verifies that a string contains a given sub-string, using the given comparison type.
</summary>
<param name="expectedSubstring">The sub-string expected to be in the string</param>
<param name="actualString">The string to be inspected</param>
<param name="comparisonType">The type of string comparison to perform</param>
<exception cref="T:Xunit.Sdk.ContainsException">Thrown when the sub-string is not present inside the string</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.DoesNotContain``1(``0,System.Collections.Generic.IEnumerable{``0})">
<summary>
Verifies that a collection does not contain a given object.
</summary>
<typeparam name="T">The type of the object to be compared</typeparam>
<param name="expected">The object that is expected not to be in the collection</param>
<param name="collection">The collection to be inspected</param>
<exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present inside the container</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.DoesNotContain``1(``0,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that a collection does not contain a given object, using an equality comparer.
</summary>
<typeparam name="T">The type of the object to be compared</typeparam>
<param name="expected">The object that is expected not to be in the collection</param>
<param name="collection">The collection to be inspected</param>
<param name="comparer">The comparer used to equate objects in the collection with the expected object</param>
<exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present inside the container</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.DoesNotContain(System.String,System.String)">
<summary>
Verifies that a string does not contain a given sub-string, using the current culture.
</summary>
<param name="expectedSubstring">The sub-string which is expected not to be in the string</param>
<param name="actualString">The string to be inspected</param>
<exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the sub-string is present inside the string</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.DoesNotContain(System.String,System.String,System.StringComparison)">
<summary>
Verifies that a string does not contain a given sub-string, using the current culture.
</summary>
<param name="expectedSubstring">The sub-string which is expected not to be in the string</param>
<param name="actualString">The string to be inspected</param>
<param name="comparisonType">The type of string comparison to perform</param>
<exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the sub-string is present inside the given string</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.DoesNotThrow(Xunit.Assert.ThrowsDelegate)">
<summary>
Verifies that a block of code does not throw any exceptions.
</summary>
<param name="testCode">A delegate to the code to be tested</param>
</member>
<member name="M:Xunit.Extensions.Assertions.Empty(System.Collections.IEnumerable)">
<summary>
Verifies that a collection is empty.
</summary>
<param name="collection">The collection to be inspected</param>
<exception cref="T:System.ArgumentNullException">Thrown when the collection is null</exception>
<exception cref="T:Xunit.Sdk.EmptyException">Thrown when the collection is not empty</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Equal``1(``0,``0)">
<summary>
Verifies that two objects are equal, using a default comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Equal``1(``0,``0,System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that two objects are equal, using a custom equatable comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<param name="comparer">The comparer used to compare the two objects</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Equal(System.Double,System.Double,System.Int32)">
<summary>
Verifies that two <see cref="T:System.Double"/> values are equal, within the number of decimal
places given by <paramref name="precision"/>.
</summary>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<param name="precision">The number of decimal places (valid values: 0-15)</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are not equal</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Equal(System.Decimal,System.Decimal,System.Int32)">
<summary>
Verifies that two <see cref="T:System.Decimal"/> values are equal, within the number of decimal
places given by <paramref name="precision"/>.
</summary>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<param name="precision">The number of decimal places (valid values: 0-15)</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are not equal</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.False(System.Boolean)">
<summary>
Verifies that the condition is false.
</summary>
<param name="condition">The condition to be tested</param>
<exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.False(System.Boolean,System.String)">
<summary>
Verifies that the condition is false.
</summary>
<param name="condition">The condition to be tested</param>
<param name="userMessage">The message to show when the condition is not false</param>
<exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.InRange``1(``0,``0,``0)">
<summary>
Verifies that a value is within a given range.
</summary>
<typeparam name="T">The type of the value to be compared</typeparam>
<param name="actual">The actual value to be evaluated</param>
<param name="low">The (inclusive) low value of the range</param>
<param name="high">The (inclusive) high value of the range</param>
<exception cref="T:Xunit.Sdk.InRangeException">Thrown when the value is not in the given range</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.InRange``1(``0,``0,``0,System.Collections.Generic.IComparer{``0})">
<summary>
Verifies that a value is within a given range, using a comparer.
</summary>
<typeparam name="T">The type of the value to be compared</typeparam>
<param name="actual">The actual value to be evaluated</param>
<param name="low">The (inclusive) low value of the range</param>
<param name="high">The (inclusive) high value of the range</param>
<param name="comparer">The comparer used to evaluate the value's range</param>
<exception cref="T:Xunit.Sdk.InRangeException">Thrown when the value is not in the given range</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.IsAssignableFrom``1(System.Object)">
<summary>
Verifies that an object is of the given type or a derived type.
</summary>
<typeparam name="T">The type the object should be</typeparam>
<param name="object">The object to be evaluated</param>
<returns>The object, casted to type T when successful</returns>
<exception cref="T:Xunit.Sdk.IsAssignableFromException">Thrown when the object is not the given type</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.IsAssignableFrom(System.Type,System.Object)">
<summary>
Verifies that an object is of the given type or a derived type.
</summary>
<param name="expectedType">The type the object should be</param>
<param name="object">The object to be evaluated</param>
<exception cref="T:Xunit.Sdk.IsAssignableFromException">Thrown when the object is not the given type</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.IsNotType``1(System.Object)">
<summary>
Verifies that an object is not exactly the given type.
</summary>
<typeparam name="T">The type the object should not be</typeparam>
<param name="object">The object to be evaluated</param>
<exception cref="T:Xunit.Sdk.IsNotTypeException">Thrown when the object is the given type</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.IsNotType(System.Type,System.Object)">
<summary>
Verifies that an object is not exactly the given type.
</summary>
<param name="expectedType">The type the object should not be</param>
<param name="object">The object to be evaluated</param>
<exception cref="T:Xunit.Sdk.IsNotTypeException">Thrown when the object is the given type</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.IsType``1(System.Object)">
<summary>
Verifies that an object is exactly the given type (and not a derived type).
</summary>
<typeparam name="T">The type the object should be</typeparam>
<param name="object">The object to be evaluated</param>
<returns>The object, casted to type T when successful</returns>
<exception cref="T:Xunit.Sdk.IsTypeException">Thrown when the object is not the given type</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.IsType(System.Type,System.Object)">
<summary>
Verifies that an object is exactly the given type (and not a derived type).
</summary>
<param name="expectedType">The type the object should be</param>
<param name="object">The object to be evaluated</param>
<exception cref="T:Xunit.Sdk.IsTypeException">Thrown when the object is not the given type</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.NotEmpty(System.Collections.IEnumerable)">
<summary>
Verifies that a collection is not empty.
</summary>
<param name="collection">The collection to be inspected</param>
<exception cref="T:System.ArgumentNullException">Thrown when a null collection is passed</exception>
<exception cref="T:Xunit.Sdk.NotEmptyException">Thrown when the collection is empty</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.NotEqual``1(``0,``0)">
<summary>
Verifies that two objects are not equal, using a default comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected object</param>
<param name="actual">The actual object</param>
<exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.NotEqual``1(``0,``0,System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that two objects are not equal, using a custom equality comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected object</param>
<param name="actual">The actual object</param>
<param name="comparer">The comparer used to examine the objects</param>
<exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.NotInRange``1(``0,``0,``0)">
<summary>
Verifies that a value is not within a given range, using the default comparer.
</summary>
<typeparam name="T">The type of the value to be compared</typeparam>
<param name="actual">The actual value to be evaluated</param>
<param name="low">The (inclusive) low value of the range</param>
<param name="high">The (inclusive) high value of the range</param>
<exception cref="T:Xunit.Sdk.NotInRangeException">Thrown when the value is in the given range</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.NotInRange``1(``0,``0,``0,System.Collections.Generic.IComparer{``0})">
<summary>
Verifies that a value is not within a given range, using a comparer.
</summary>
<typeparam name="T">The type of the value to be compared</typeparam>
<param name="actual">The actual value to be evaluated</param>
<param name="low">The (inclusive) low value of the range</param>
<param name="high">The (inclusive) high value of the range</param>
<param name="comparer">The comparer used to evaluate the value's range</param>
<exception cref="T:Xunit.Sdk.NotInRangeException">Thrown when the value is in the given range</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.NotNull(System.Object)">
<summary>
Verifies that an object reference is not null.
</summary>
<param name="object">The object to be validated</param>
<exception cref="T:Xunit.Sdk.NotNullException">Thrown when the object is not null</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.NotSame(System.Object,System.Object)">
<summary>
Verifies that two objects are not the same instance.
</summary>
<param name="expected">The expected object instance</param>
<param name="actual">The actual object instance</param>
<exception cref="T:Xunit.Sdk.NotSameException">Thrown when the objects are the same instance</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Null(System.Object)">
<summary>
Verifies that an object reference is null.
</summary>
<param name="object">The object to be inspected</param>
<exception cref="T:Xunit.Sdk.NullException">Thrown when the object reference is not null</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Same(System.Object,System.Object)">
<summary>
Verifies that two objects are the same instance.
</summary>
<param name="expected">The expected object instance</param>
<param name="actual">The actual object instance</param>
<exception cref="T:Xunit.Sdk.SameException">Thrown when the objects are not the same instance</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Single(System.Collections.IEnumerable)">
<summary>
Verifies that the given collection contains only a single
element of the given type.
</summary>
<param name="collection">The collection.</param>
<returns>The single item in the collection.</returns>
<exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
exactly one element.</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Single``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Verifies that the given collection contains only a single
element of the given type.
</summary>
<typeparam name="T">The collection type.</typeparam>
<param name="collection">The collection.</param>
<returns>The single item in the collection.</returns>
<exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
exactly one element.</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Throws``1(Xunit.Assert.ThrowsDelegate)">
<summary>
Verifies that the exact exception is thrown (and not a derived exception type).
</summary>
<typeparam name="T">The type of the exception expected to be thrown</typeparam>
<param name="testCode">A delegate to the code to be tested</param>
<returns>The exception that was thrown, when successful</returns>
<exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Throws``1(Xunit.Assert.ThrowsDelegateWithReturn)">
<summary>
Verifies that the exact exception is thrown (and not a derived exception type).
Generally used to test property accessors.
</summary>
<typeparam name="T">The type of the exception expected to be thrown</typeparam>
<param name="testCode">A delegate to the code to be tested</param>
<returns>The exception that was thrown, when successful</returns>
<exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Throws(System.Type,Xunit.Assert.ThrowsDelegate)">
<summary>
Verifies that the exact exception is thrown (and not a derived exception type).
</summary>
<param name="exceptionType">The type of the exception expected to be thrown</param>
<param name="testCode">A delegate to the code to be tested</param>
<returns>The exception that was thrown, when successful</returns>
<exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.Throws(System.Type,Xunit.Assert.ThrowsDelegateWithReturn)">
<summary>
Verifies that the exact exception is thrown (and not a derived exception type).
Generally used to test property accessors.
</summary>
<param name="exceptionType">The type of the exception expected to be thrown</param>
<param name="testCode">A delegate to the code to be tested</param>
<returns>The exception that was thrown, when successful</returns>
<exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.True(System.Boolean)">
<summary>
Verifies that an expression is true.
</summary>
<param name="condition">The condition to be inspected</param>
<exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
</member>
<member name="M:Xunit.Extensions.Assertions.True(System.Boolean,System.String)">
<summary>
Verifies that an expression is true.
</summary>
<param name="condition">The condition to be inspected</param>
<param name="userMessage">The message to be shown when the condition is false</param>
<exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
</member>
<member name="T:Xunit.Extensions.TestClass">
<summary>
A class which can be derived from for test classes, which bring an overridable version
of Assert (using the <see cref="T:Xunit.Extensions.Assertions"/> class.
</summary>
</member>
<member name="P:Xunit.Extensions.TestClass.Assert">
<summary>
Gets a class which provides assertions.
</summary>
</member>
<member name="T:Xunit.Extensions.AssumeIdentityAttribute">
<summary>
Apply this attribute to your test method to replace the
<see cref="P:System.Threading.Thread.CurrentPrincipal"/> with another role.
</summary>
</member>
<member name="M:Xunit.Extensions.AssumeIdentityAttribute.#ctor(System.String)">
<summary>
Replaces the identity of the current thread with <paramref name="name"/>.
</summary>
<param name="name">The role's name</param>
</member>
<member name="M:Xunit.Extensions.AssumeIdentityAttribute.After(System.Reflection.MethodInfo)">
<summary>
Restores the original <see cref="P:System.Threading.Thread.CurrentPrincipal"/>.
</summary>
<param name="methodUnderTest">The method under test</param>
</member>
<member name="M:Xunit.Extensions.AssumeIdentityAttribute.Before(System.Reflection.MethodInfo)">
<summary>
Stores the current <see cref="P:System.Threading.Thread.CurrentPrincipal"/> and replaces it with
a new role identified in constructor.
</summary>
<param name="methodUnderTest">The method under test</param>
</member>
<member name="P:Xunit.Extensions.AssumeIdentityAttribute.Name">
<summary>
Gets the name.
</summary>
</member>
<member name="T:Xunit.Extensions.AutoRollbackAttribute">
<summary>
Apply this attribute to your test method to automatically create a
<see cref="T:System.Transactions.TransactionScope"/> that is rolled back when the test is
finished.
</summary>
</member>
<member name="M:Xunit.Extensions.AutoRollbackAttribute.After(System.Reflection.MethodInfo)">
<summary>
Rolls back the transaction.
</summary>
</member>
<member name="M:Xunit.Extensions.AutoRollbackAttribute.Before(System.Reflection.MethodInfo)">
<summary>
Creates the transaction.
</summary>
</member>
<member name="P:Xunit.Extensions.AutoRollbackAttribute.IsolationLevel">
<summary>
Gets or sets the isolation level of the transaction.
Default value is <see cref="P:Xunit.Extensions.AutoRollbackAttribute.IsolationLevel"/>.Unspecified.
</summary>
</member>
<member name="P:Xunit.Extensions.AutoRollbackAttribute.ScopeOption">
<summary>
Gets or sets the scope option for the transaction.
Default value is <see cref="T:System.Transactions.TransactionScopeOption"/>.Required.
</summary>
</member>
<member name="P:Xunit.Extensions.AutoRollbackAttribute.TimeoutInMS">
<summary>
Gets or sets the timeout of the transaction, in milliseconds.
By default, the transaction will not timeout.
</summary>
</member>
<member name="T:Xunit.Extensions.ClassDataAttribute">
<summary>
Provides a data source for a data theory, with the data coming from a class
which must implement IEnumerable<object[]>.
</summary>
</member>
<member name="T:Xunit.Extensions.DataAttribute">
<summary>
Abstract attribute which represents a data source for a data theory.
Data source providers derive from this attribute and implement GetData
to return the data for the theory.
</summary>
</member>
<member name="M:Xunit.Extensions.DataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
<summary>
Returns the data to be used to test the theory.
</summary>
<remarks>
The <paramref name="parameterTypes"/> parameter is provided so that the
test data can be converted to the destination parameter type when necessary.
Generally, data should NOT be automatically converted, UNLESS the source data
format does not have rich types (for example, all numbers in Excel spreadsheets
are returned as <see cref="T:System.Double"/> even if they are integers). Derivers of
this class should NOT throw exceptions for mismatched types or mismatched number
of parameters; the test framework will throw these exceptions at the correct
time.
</remarks>
<param name="methodUnderTest">The method that is being tested</param>
<param name="parameterTypes">The types of the parameters for the test method</param>
<returns>The theory data</returns>
</member>
<member name="P:Xunit.Extensions.DataAttribute.TypeId">
<inheritdoc/>
</member>
<member name="M:Xunit.Extensions.ClassDataAttribute.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Extensions.ClassDataAttribute"/> class.
</summary>
<param name="class">The class that provides the data.</param>
</member>
<member name="M:Xunit.Extensions.ClassDataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
<inheritdoc/>
</member>
<member name="P:Xunit.Extensions.ClassDataAttribute.Class">
<summary>
Gets the type of the class that provides the data.
</summary>
</member>
<member name="T:Xunit.Extensions.DataAdapterDataAttribute">
<summary>
Represents an implementation of <see cref="T:Xunit.Extensions.DataAttribute"/> which uses an
instance of <see cref="T:System.Data.IDataAdapter"/> to get the data for a <see cref="T:Xunit.Extensions.TheoryAttribute"/>
decorated test method.
</summary>
</member>
<member name="M:Xunit.Extensions.DataAdapterDataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
<inheritdoc/>
</member>
<member name="M:Xunit.Extensions.DataAdapterDataAttribute.ConvertParameter(System.Object,System.Type)">
<summary>
Converts a parameter to its destination parameter type, if necessary.
</summary>
<param name="parameter">The parameter value</param>
<param name="parameterType">The destination parameter type (null if not known)</param>
<returns>The converted parameter value</returns>
</member>
<member name="P:Xunit.Extensions.DataAdapterDataAttribute.DataAdapter">
<summary>
Gets the data adapter to be used to retrieve the test data.
</summary>
</member>
<member name="T:Xunit.Extensions.InlineDataAttribute">
<summary>
Provides a data source for a data theory, with the data coming from inline values.
</summary>
</member>
<member name="M:Xunit.Extensions.InlineDataAttribute.#ctor(System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Extensions.InlineDataAttribute"/> class.
</summary>
<param name="dataValues">The data values to pass to the theory</param>
</member>
<member name="M:Xunit.Extensions.InlineDataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
<summary>
Returns the data to be used to test the theory.
</summary>
<param name="methodUnderTest">The method that is being tested</param>
<param name="parameterTypes">The types of the parameters for the test method</param>
<returns>The theory data, in table form</returns>
</member>
<member name="P:Xunit.Extensions.InlineDataAttribute.DataValues">
<summary>
Gets the data values.
</summary>
</member>
<member name="T:Xunit.Extensions.OleDbDataAttribute">
<summary>
Provides a data source for a data theory, with the data coming from an OLEDB connection.
</summary>
</member>
<member name="M:Xunit.Extensions.OleDbDataAttribute.#ctor(System.String,System.String)">
<summary>
Creates a new instance of <see cref="T:Xunit.Extensions.OleDbDataAttribute"/>.
</summary>
<param name="connectionString">The OLEDB connection string to the data</param>
<param name="selectStatement">The SELECT statement used to return the data for the theory</param>
</member>
<member name="P:Xunit.Extensions.OleDbDataAttribute.ConnectionString">
<summary>
Gets the connection string.
</summary>
</member>
<member name="P:Xunit.Extensions.OleDbDataAttribute.SelectStatement">
<summary>
Gets the select statement.
</summary>
</member>
<member name="P:Xunit.Extensions.OleDbDataAttribute.DataAdapter">
<inheritdoc/>
</member>
<member name="T:Xunit.Extensions.PropertyDataAttribute">
<summary>
Provides a data source for a data theory, with the data coming from a public static property on the test class.
The property must return IEnumerable<object[]> with the test data.
</summary>
</member>
<member name="M:Xunit.Extensions.PropertyDataAttribute.#ctor(System.String)">
<summary>
Creates a new instance of <see cref="T:Xunit.Extensions.PropertyDataAttribute"/>/
</summary>
<param name="propertyName">The name of the public static property on the test class that will provide the test data</param>
</member>
<member name="M:Xunit.Extensions.PropertyDataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
<summary>
Returns the data to be used to test the theory.
</summary>
<param name="methodUnderTest">The method that is being tested</param>
<param name="parameterTypes">The types of the parameters for the test method</param>
<returns>The theory data, in table form</returns>
</member>
<member name="P:Xunit.Extensions.PropertyDataAttribute.PropertyName">
<summary>
Gets the property name.
</summary>
</member>
<member name="P:Xunit.Extensions.PropertyDataAttribute.PropertyType">
<summary>
Gets or sets the type to retrieve the property data from. If not set, then the property will be
retrieved from the unit test class.
</summary>
</member>
<member name="T:Xunit.Extensions.SqlServerDataAttribute">
<summary>
Provides a data source for a data theory, with the data coming a Microsoft SQL Server.
</summary>
</member>
<member name="M:Xunit.Extensions.SqlServerDataAttribute.#ctor(System.String,System.String,System.String)">
<summary>
Creates a new instance of <see cref="T:Xunit.Extensions.SqlServerDataAttribute"/>, using a trusted connection.
</summary>
<param name="serverName">The server name of the Microsoft SQL Server</param>
<param name="databaseName">The database name</param>
<param name="selectStatement">The SQL SELECT statement to return the data for the data theory</param>
</member>
<member name="M:Xunit.Extensions.SqlServerDataAttribute.#ctor(System.String,System.String,System.String,System.String,System.String)">
<summary>
Creates a new instance of <see cref="T:Xunit.Extensions.SqlServerDataAttribute"/>, using the provided username and password.
</summary>
<param name="serverName">The server name of the Microsoft SQL Server</param>
<param name="databaseName">The database name</param>
<param name="username">The username for the server</param>
<param name="password">The password for the server</param>
<param name="selectStatement">The SQL SELECT statement to return the data for the data theory</param>
</member>
<member name="T:Xunit.Extensions.ExcelDataAttribute">
<summary>
Provides a data source for a data theory, with the data coming a Microsoft Excel (.xls) spreadsheet.
</summary>
</member>
<member name="M:Xunit.Extensions.ExcelDataAttribute.#ctor(System.String,System.String)">
<summary>
Creates a new instance of <see cref="T:Xunit.Extensions.ExcelDataAttribute"/>.
</summary>
<param name="filename">The filename of the XLS spreadsheet file; if the filename provided
is relative, then it is relative to the location of xunit.extensions.dll.</param>
<param name="selectStatement">The SELECT statement that returns the data for the theory</param>
</member>
<member name="M:Xunit.Extensions.ExcelDataAttribute.ConvertParameter(System.Object,System.Type)">
<inheritdoc/>
</member>
<member name="T:Xunit.Extensions.Clock">
<summary>
A wrapper around the static operations on <see cref="T:System.DateTime"/> which allows time
to be frozen using the <see cref="T:Xunit.Extensions.FreezeClockAttribute"/>. The clock begins in the
thawed state; that is, calls to <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and
<see cref="P:Xunit.Extensions.Clock.UtcNow"/> return current (non-frozen) values.
</summary>
</member>
<member name="M:Xunit.Extensions.Clock.Freeze">
<summary>
Freezes the clock with the current time.
Until <see cref="M:Xunit.Extensions.Clock.Thaw"/> is called, all calls to <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and
<see cref="P:Xunit.Extensions.Clock.UtcNow"/> will return the exact same values.
</summary>
</member>
<member name="M:Xunit.Extensions.Clock.FreezeLocal(System.DateTime)">
<summary>
Freezes the clock with the given date and time, considered to be local time.
Until <see cref="M:Xunit.Extensions.Clock.Thaw"/> is called, all calls to <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and
<see cref="P:Xunit.Extensions.Clock.UtcNow"/> will return the exact same values.
</summary>
<param name="localDateTime">The local date and time to freeze to</param>
</member>
<member name="M:Xunit.Extensions.Clock.FreezeUtc(System.DateTime)">
<summary>
Freezes the clock with the given date and time, considered to be Coordinated Universal Time (UTC).
Until <see cref="M:Xunit.Extensions.Clock.Thaw"/> is called, all calls to <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and
<see cref="P:Xunit.Extensions.Clock.UtcNow"/> will return the exact same values.
</summary>
<param name="utcDateTime">The UTC date and time to freeze to</param>
</member>
<member name="M:Xunit.Extensions.Clock.Thaw">
<summary>
Thaws the clock so that <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and <see cref="P:Xunit.Extensions.Clock.UtcNow"/>
return normal values.
</summary>
</member>
<member name="P:Xunit.Extensions.Clock.Now">
<summary>
Gets a <see cref="T:System.DateTime"/> object that is set to the current date and time on this computer,
expressed as the local time.
</summary>
</member>
<member name="P:Xunit.Extensions.Clock.Today">
<summary>
Gets the current date.
</summary>
</member>
<member name="P:Xunit.Extensions.Clock.UtcNow">
<summary>
Gets a <see cref="T:System.DateTime"/> object that is set to the current date and time on this computer,
expressed as the Coordinated Universal Time (UTC).
</summary>
</member>
<member name="T:Xunit.Extensions.FreezeClockAttribute">
<summary>
Apply this attribute to your test method to freeze the time represented by the
<see cref="T:Xunit.Extensions.Clock"/> class.
</summary>
</member>
<member name="M:Xunit.Extensions.FreezeClockAttribute.#ctor">
<summary>
Freeze the clock with the current date and time.
</summary>
</member>
<member name="M:Xunit.Extensions.FreezeClockAttribute.#ctor(System.Int32,System.Int32,System.Int32)">
<summary>
Freeze the clock with the given date, considered to be local time.
</summary>
<param name="year">The frozen year</param>
<param name="month">The frozen month</param>
<param name="day">The frozen day</param>
</member>
<member name="M:Xunit.Extensions.FreezeClockAttribute.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Freeze the clock with the given date and time, considered to be in local time.
</summary>
<param name="year">The frozen year</param>
<param name="month">The frozen month</param>
<param name="day">The frozen day</param>
<param name="hour">The frozen hour</param>
<param name="minute">The frozen minute</param>
<param name="second">The frozen second</param>
</member>
<member name="M:Xunit.Extensions.FreezeClockAttribute.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.DateTimeKind)">
<summary>
Freeze the clock with the given date and time, with the given kind of time.
</summary>
<param name="year">The frozen year</param>
<param name="month">The frozen month</param>
<param name="day">The frozen day</param>
<param name="hour">The frozen hour</param>
<param name="minute">The frozen minute</param>
<param name="second">The frozen second</param>
<param name="kind">The frozen time kind</param>
</member>
<member name="M:Xunit.Extensions.FreezeClockAttribute.After(System.Reflection.MethodInfo)">
<summary>
Thaws the clock.
</summary>
<param name="methodUnderTest">The method under test</param>
</member>
<member name="M:Xunit.Extensions.FreezeClockAttribute.Before(System.Reflection.MethodInfo)">
<summary>
Freezes the clock.
</summary>
<param name="methodUnderTest">The method under test</param>
</member>
<member name="T:Xunit.Extensions.TheoryAttribute">
<summary>
Marks a test method as being a data theory. Data theories are tests which are fed
various bits of data from a data source, mapping to parameters on the test method.
If the data source contains multiple rows, then the test method is executed
multiple times (once with each data row).
</summary>
</member>
<member name="M:Xunit.Extensions.TheoryAttribute.EnumerateTestCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Creates instances of <see cref="T:Xunit.Extensions.TheoryCommand"/> which represent individual intended
invocations of the test method, one per data row in the data source.
</summary>
<param name="method">The method under test</param>
<returns>An enumerator through the desired test method invocations</returns>
</member>
<member name="T:Xunit.Extensions.TheoryCommand">
<summary>
Represents a single invocation of a data theory test method.
</summary>
</member>
<member name="M:Xunit.Extensions.TheoryCommand.#ctor(Xunit.Sdk.IMethodInfo,System.Object[])">
<summary>
Creates a new instance of <see cref="T:Xunit.Extensions.TheoryCommand"/>.
</summary>
<param name="testMethod">The method under test</param>
<param name="parameters">The parameters to be passed to the test method</param>
</member>
<member name="M:Xunit.Extensions.TheoryCommand.#ctor(Xunit.Sdk.IMethodInfo,System.Object[],System.Type[])">
<summary>
Creates a new instance of <see cref="T:Xunit.Extensions.TheoryCommand"/> based on a generic theory.
</summary>
<param name="testMethod">The method under test</param>
<param name="parameters">The parameters to be passed to the test method</param>
<param name="genericTypes">The generic types that were used to resolved the generic method.</param>
</member>
<member name="M:Xunit.Extensions.TheoryCommand.Execute(System.Object)">
<inheritdoc/>
</member>
<member name="P:Xunit.Extensions.TheoryCommand.Parameters">
<summary>
Gets the parameter values that are passed to the test method.
</summary>
</member>
<member name="T:Xunit.Extensions.TraceAttribute">
<summary>
Apply to a test method to trace the method begin and end.
</summary>
</member>
<member name="M:Xunit.Extensions.TraceAttribute.Before(System.Reflection.MethodInfo)">
<summary>
This method is called before the test method is executed.
</summary>
<param name="methodUnderTest">The method under test</param>
</member>
<member name="M:Xunit.Extensions.TraceAttribute.After(System.Reflection.MethodInfo)">
<summary>
This method is called after the test method is executed.
</summary>
<param name="methodUnderTest">The method under test</param>
</member>
</members>
</doc>
<?xml version="1.0"?>
<doc>
<assembly>
<name>xunit</name>
</assembly>
<members>
<member name="T:Xunit.Assert">
<summary>
Contains various static methods that are used to verify that conditions are met during the
process of running tests.
</summary>
</member>
<member name="M:Xunit.Assert.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Assert"/> class.
</summary>
</member>
<member name="M:Xunit.Assert.Contains``1(``0,System.Collections.Generic.IEnumerable{``0})">
<summary>
Verifies that a collection contains a given object.
</summary>
<typeparam name="T">The type of the object to be verified</typeparam>
<param name="expected">The object expected to be in the collection</param>
<param name="collection">The collection to be inspected</param>
<exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
</member>
<member name="M:Xunit.Assert.Contains``1(``0,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that a collection contains a given object, using an equality comparer.
</summary>
<typeparam name="T">The type of the object to be verified</typeparam>
<param name="expected">The object expected to be in the collection</param>
<param name="collection">The collection to be inspected</param>
<param name="comparer">The comparer used to equate objects in the collection with the expected object</param>
<exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
</member>
<member name="M:Xunit.Assert.Contains(System.String,System.String)">
<summary>
Verifies that a string contains a given sub-string, using the current culture.
</summary>
<param name="expectedSubstring">The sub-string expected to be in the string</param>
<param name="actualString">The string to be inspected</param>
<exception cref="T:Xunit.Sdk.ContainsException">Thrown when the sub-string is not present inside the string</exception>
</member>
<member name="M:Xunit.Assert.Contains(System.String,System.String,System.StringComparison)">
<summary>
Verifies that a string contains a given sub-string, using the given comparison type.
</summary>
<param name="expectedSubstring">The sub-string expected to be in the string</param>
<param name="actualString">The string to be inspected</param>
<param name="comparisonType">The type of string comparison to perform</param>
<exception cref="T:Xunit.Sdk.ContainsException">Thrown when the sub-string is not present inside the string</exception>
</member>
<member name="M:Xunit.Assert.DoesNotContain``1(``0,System.Collections.Generic.IEnumerable{``0})">
<summary>
Verifies that a collection does not contain a given object.
</summary>
<typeparam name="T">The type of the object to be compared</typeparam>
<param name="expected">The object that is expected not to be in the collection</param>
<param name="collection">The collection to be inspected</param>
<exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present inside the container</exception>
</member>
<member name="M:Xunit.Assert.DoesNotContain``1(``0,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that a collection does not contain a given object, using an equality comparer.
</summary>
<typeparam name="T">The type of the object to be compared</typeparam>
<param name="expected">The object that is expected not to be in the collection</param>
<param name="collection">The collection to be inspected</param>
<param name="comparer">The comparer used to equate objects in the collection with the expected object</param>
<exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present inside the container</exception>
</member>
<member name="M:Xunit.Assert.DoesNotContain(System.String,System.String)">
<summary>
Verifies that a string does not contain a given sub-string, using the current culture.
</summary>
<param name="expectedSubstring">The sub-string which is expected not to be in the string</param>
<param name="actualString">The string to be inspected</param>
<exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the sub-string is present inside the string</exception>
</member>
<member name="M:Xunit.Assert.DoesNotContain(System.String,System.String,System.StringComparison)">
<summary>
Verifies that a string does not contain a given sub-string, using the current culture.
</summary>
<param name="expectedSubstring">The sub-string which is expected not to be in the string</param>
<param name="actualString">The string to be inspected</param>
<param name="comparisonType">The type of string comparison to perform</param>
<exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the sub-string is present inside the given string</exception>
</member>
<member name="M:Xunit.Assert.DoesNotThrow(Xunit.Assert.ThrowsDelegate)">
<summary>
Verifies that a block of code does not throw any exceptions.
</summary>
<param name="testCode">A delegate to the code to be tested</param>
</member>
<member name="M:Xunit.Assert.Empty(System.Collections.IEnumerable)">
<summary>
Verifies that a collection is empty.
</summary>
<param name="collection">The collection to be inspected</param>
<exception cref="T:System.ArgumentNullException">Thrown when the collection is null</exception>
<exception cref="T:Xunit.Sdk.EmptyException">Thrown when the collection is not empty</exception>
</member>
<member name="M:Xunit.Assert.Equal``1(``0,``0)">
<summary>
Verifies that two objects are equal, using a default comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
</member>
<member name="M:Xunit.Assert.Equal``1(``0,``0,System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that two objects are equal, using a custom equatable comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<param name="comparer">The comparer used to compare the two objects</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
</member>
<member name="M:Xunit.Assert.Equal(System.Double,System.Double,System.Int32)">
<summary>
Verifies that two <see cref="T:System.Double"/> values are equal, within the number of decimal
places given by <paramref name="precision"/>.
</summary>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<param name="precision">The number of decimal places (valid values: 0-15)</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are not equal</exception>
</member>
<member name="M:Xunit.Assert.Equal(System.Decimal,System.Decimal,System.Int32)">
<summary>
Verifies that two <see cref="T:System.Decimal"/> values are equal, within the number of decimal
places given by <paramref name="precision"/>.
</summary>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<param name="precision">The number of decimal places (valid values: 0-15)</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are not equal</exception>
</member>
<member name="M:Xunit.Assert.Equal``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0})">
<summary>
Verifies that two sequences are equivalent, using a default comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
</member>
<member name="M:Xunit.Assert.Equal``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that two sequences are equivalent, using a custom equatable comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected value</param>
<param name="actual">The value to be compared against</param>
<param name="comparer">The comparer used to compare the two objects</param>
<exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
</member>
<member name="M:Xunit.Assert.Equals(System.Object,System.Object)">
<summary>Do not call this method.</summary>
</member>
<member name="M:Xunit.Assert.False(System.Boolean)">
<summary>
Verifies that the condition is false.
</summary>
<param name="condition">The condition to be tested</param>
<exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
</member>
<member name="M:Xunit.Assert.False(System.Boolean,System.String)">
<summary>
Verifies that the condition is false.
</summary>
<param name="condition">The condition to be tested</param>
<param name="userMessage">The message to show when the condition is not false</param>
<exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
</member>
<member name="M:Xunit.Assert.InRange``1(``0,``0,``0)">
<summary>
Verifies that a value is within a given range.
</summary>
<typeparam name="T">The type of the value to be compared</typeparam>
<param name="actual">The actual value to be evaluated</param>
<param name="low">The (inclusive) low value of the range</param>
<param name="high">The (inclusive) high value of the range</param>
<exception cref="T:Xunit.Sdk.InRangeException">Thrown when the value is not in the given range</exception>
</member>
<member name="M:Xunit.Assert.InRange``1(``0,``0,``0,System.Collections.Generic.IComparer{``0})">
<summary>
Verifies that a value is within a given range, using a comparer.
</summary>
<typeparam name="T">The type of the value to be compared</typeparam>
<param name="actual">The actual value to be evaluated</param>
<param name="low">The (inclusive) low value of the range</param>
<param name="high">The (inclusive) high value of the range</param>
<param name="comparer">The comparer used to evaluate the value's range</param>
<exception cref="T:Xunit.Sdk.InRangeException">Thrown when the value is not in the given range</exception>
</member>
<member name="M:Xunit.Assert.IsAssignableFrom``1(System.Object)">
<summary>
Verifies that an object is of the given type or a derived type.
</summary>
<typeparam name="T">The type the object should be</typeparam>
<param name="object">The object to be evaluated</param>
<returns>The object, casted to type T when successful</returns>
<exception cref="T:Xunit.Sdk.IsAssignableFromException">Thrown when the object is not the given type</exception>
</member>
<member name="M:Xunit.Assert.IsAssignableFrom(System.Type,System.Object)">
<summary>
Verifies that an object is of the given type or a derived type.
</summary>
<param name="expectedType">The type the object should be</param>
<param name="object">The object to be evaluated</param>
<exception cref="T:Xunit.Sdk.IsAssignableFromException">Thrown when the object is not the given type</exception>
</member>
<member name="M:Xunit.Assert.IsNotType``1(System.Object)">
<summary>
Verifies that an object is not exactly the given type.
</summary>
<typeparam name="T">The type the object should not be</typeparam>
<param name="object">The object to be evaluated</param>
<exception cref="T:Xunit.Sdk.IsNotTypeException">Thrown when the object is the given type</exception>
</member>
<member name="M:Xunit.Assert.IsNotType(System.Type,System.Object)">
<summary>
Verifies that an object is not exactly the given type.
</summary>
<param name="expectedType">The type the object should not be</param>
<param name="object">The object to be evaluated</param>
<exception cref="T:Xunit.Sdk.IsNotTypeException">Thrown when the object is the given type</exception>
</member>
<member name="M:Xunit.Assert.IsType``1(System.Object)">
<summary>
Verifies that an object is exactly the given type (and not a derived type).
</summary>
<typeparam name="T">The type the object should be</typeparam>
<param name="object">The object to be evaluated</param>
<returns>The object, casted to type T when successful</returns>
<exception cref="T:Xunit.Sdk.IsTypeException">Thrown when the object is not the given type</exception>
</member>
<member name="M:Xunit.Assert.IsType(System.Type,System.Object)">
<summary>
Verifies that an object is exactly the given type (and not a derived type).
</summary>
<param name="expectedType">The type the object should be</param>
<param name="object">The object to be evaluated</param>
<exception cref="T:Xunit.Sdk.IsTypeException">Thrown when the object is not the given type</exception>
</member>
<member name="M:Xunit.Assert.NotEmpty(System.Collections.IEnumerable)">
<summary>
Verifies that a collection is not empty.
</summary>
<param name="collection">The collection to be inspected</param>
<exception cref="T:System.ArgumentNullException">Thrown when a null collection is passed</exception>
<exception cref="T:Xunit.Sdk.NotEmptyException">Thrown when the collection is empty</exception>
</member>
<member name="M:Xunit.Assert.NotEqual``1(``0,``0)">
<summary>
Verifies that two objects are not equal, using a default comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected object</param>
<param name="actual">The actual object</param>
<exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
</member>
<member name="M:Xunit.Assert.NotEqual``1(``0,``0,System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that two objects are not equal, using a custom equality comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected object</param>
<param name="actual">The actual object</param>
<param name="comparer">The comparer used to examine the objects</param>
<exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
</member>
<member name="M:Xunit.Assert.NotEqual``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0})">
<summary>
Verifies that two sequences are not equivalent, using a default comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected object</param>
<param name="actual">The actual object</param>
<exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
</member>
<member name="M:Xunit.Assert.NotEqual``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Verifies that two sequences are not equivalent, using a custom equality comparer.
</summary>
<typeparam name="T">The type of the objects to be compared</typeparam>
<param name="expected">The expected object</param>
<param name="actual">The actual object</param>
<param name="comparer">The comparer used to compare the two objects</param>
<exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
</member>
<member name="M:Xunit.Assert.NotInRange``1(``0,``0,``0)">
<summary>
Verifies that a value is not within a given range, using the default comparer.
</summary>
<typeparam name="T">The type of the value to be compared</typeparam>
<param name="actual">The actual value to be evaluated</param>
<param name="low">The (inclusive) low value of the range</param>
<param name="high">The (inclusive) high value of the range</param>
<exception cref="T:Xunit.Sdk.NotInRangeException">Thrown when the value is in the given range</exception>
</member>
<member name="M:Xunit.Assert.NotInRange``1(``0,``0,``0,System.Collections.Generic.IComparer{``0})">
<summary>
Verifies that a value is not within a given range, using a comparer.
</summary>
<typeparam name="T">The type of the value to be compared</typeparam>
<param name="actual">The actual value to be evaluated</param>
<param name="low">The (inclusive) low value of the range</param>
<param name="high">The (inclusive) high value of the range</param>
<param name="comparer">The comparer used to evaluate the value's range</param>
<exception cref="T:Xunit.Sdk.NotInRangeException">Thrown when the value is in the given range</exception>
</member>
<member name="M:Xunit.Assert.NotNull(System.Object)">
<summary>
Verifies that an object reference is not null.
</summary>
<param name="object">The object to be validated</param>
<exception cref="T:Xunit.Sdk.NotNullException">Thrown when the object is not null</exception>
</member>
<member name="M:Xunit.Assert.NotSame(System.Object,System.Object)">
<summary>
Verifies that two objects are not the same instance.
</summary>
<param name="expected">The expected object instance</param>
<param name="actual">The actual object instance</param>
<exception cref="T:Xunit.Sdk.NotSameException">Thrown when the objects are the same instance</exception>
</member>
<member name="M:Xunit.Assert.Null(System.Object)">
<summary>
Verifies that an object reference is null.
</summary>
<param name="object">The object to be inspected</param>
<exception cref="T:Xunit.Sdk.NullException">Thrown when the object reference is not null</exception>
</member>
<member name="M:Xunit.Assert.PropertyChanged(System.ComponentModel.INotifyPropertyChanged,System.String,Xunit.Assert.PropertyChangedDelegate)">
<summary>
Verifies that the provided object raised INotifyPropertyChanged.PropertyChanged
as a result of executing the given test code.
</summary>
<param name="object">The object which should raise the notification</param>
<param name="propertyName">The property name for which the notification should be raised</param>
<param name="testCode">The test code which should cause the notification to be raised</param>
<exception cref="T:Xunit.Sdk.PropertyChangedException">Thrown when the notification is not raised</exception>
</member>
<member name="M:Xunit.Assert.Same(System.Object,System.Object)">
<summary>
Verifies that two objects are the same instance.
</summary>
<param name="expected">The expected object instance</param>
<param name="actual">The actual object instance</param>
<exception cref="T:Xunit.Sdk.SameException">Thrown when the objects are not the same instance</exception>
</member>
<member name="M:Xunit.Assert.Single(System.Collections.IEnumerable)">
<summary>
Verifies that the given collection contains only a single
element of the given type.
</summary>
<param name="collection">The collection.</param>
<returns>The single item in the collection.</returns>
<exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
exactly one element.</exception>
</member>
<member name="M:Xunit.Assert.Single(System.Collections.IEnumerable,System.Object)">
<summary>
Verifies that the given collection contains only a single
element of the given value. The collection may or may not
contain other values.
</summary>
<param name="collection">The collection.</param>
<param name="expected">The value to find in the collection.</param>
<returns>The single item in the collection.</returns>
<exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
exactly one element.</exception>
</member>
<member name="M:Xunit.Assert.Single``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Verifies that the given collection contains only a single
element of the given type.
</summary>
<typeparam name="T">The collection type.</typeparam>
<param name="collection">The collection.</param>
<returns>The single item in the collection.</returns>
<exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
exactly one element.</exception>
</member>
<member name="M:Xunit.Assert.Single``1(System.Collections.Generic.IEnumerable{``0},System.Predicate{``0})">
<summary>
Verifies that the given collection contains only a single
element of the given type which matches the given predicate. The
collection may or may not contain other values which do not
match the given predicate.
</summary>
<typeparam name="T">The collection type.</typeparam>
<param name="collection">The collection.</param>
<param name="predicate">The item matching predicate.</param>
<returns>The single item in the filtered collection.</returns>
<exception cref="T:Xunit.Sdk.SingleException">Thrown when the filtered collection does
not contain exactly one element.</exception>
</member>
<member name="M:Xunit.Assert.Throws``1(Xunit.Assert.ThrowsDelegate)">
<summary>
Verifies that the exact exception is thrown (and not a derived exception type).
</summary>
<typeparam name="T">The type of the exception expected to be thrown</typeparam>
<param name="testCode">A delegate to the code to be tested</param>
<returns>The exception that was thrown, when successful</returns>
<exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
</member>
<member name="M:Xunit.Assert.Throws``1(Xunit.Assert.ThrowsDelegateWithReturn)">
<summary>
Verifies that the exact exception is thrown (and not a derived exception type).
Generally used to test property accessors.
</summary>
<typeparam name="T">The type of the exception expected to be thrown</typeparam>
<param name="testCode">A delegate to the code to be tested</param>
<returns>The exception that was thrown, when successful</returns>
<exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
</member>
<member name="M:Xunit.Assert.Throws(System.Type,Xunit.Assert.ThrowsDelegate)">
<summary>
Verifies that the exact exception is thrown (and not a derived exception type).
</summary>
<param name="exceptionType">The type of the exception expected to be thrown</param>
<param name="testCode">A delegate to the code to be tested</param>
<returns>The exception that was thrown, when successful</returns>
<exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
</member>
<member name="M:Xunit.Assert.Throws(System.Type,Xunit.Assert.ThrowsDelegateWithReturn)">
<summary>
Verifies that the exact exception is thrown (and not a derived exception type).
Generally used to test property accessors.
</summary>
<param name="exceptionType">The type of the exception expected to be thrown</param>
<param name="testCode">A delegate to the code to be tested</param>
<returns>The exception that was thrown, when successful</returns>
<exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
</member>
<member name="M:Xunit.Assert.True(System.Boolean)">
<summary>
Verifies that an expression is true.
</summary>
<param name="condition">The condition to be inspected</param>
<exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
</member>
<member name="M:Xunit.Assert.True(System.Boolean,System.String)">
<summary>
Verifies that an expression is true.
</summary>
<param name="condition">The condition to be inspected</param>
<param name="userMessage">The message to be shown when the condition is false</param>
<exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
</member>
<member name="T:Xunit.Assert.PropertyChangedDelegate">
<summary>
Used by the PropertyChanged.
</summary>
</member>
<member name="T:Xunit.Assert.ThrowsDelegate">
<summary>
Used by the Throws and DoesNotThrow methods.
</summary>
</member>
<member name="T:Xunit.Assert.ThrowsDelegateWithReturn">
<summary>
Used by the Throws and DoesNotThrow methods.
</summary>
</member>
<member name="T:Xunit.Sdk.ExceptionAndOutputCaptureCommand">
<summary>
This command sets up the necessary trace listeners and standard
output/error listeners to capture Assert/Debug.Trace failures,
output to stdout/stderr, and Assert/Debug.Write text. It also
captures any exceptions that are thrown and packages them as
FailedResults, including the possibility that the configuration
file is messed up (which is exposed when we attempt to manipulate
the trace listener list).
</summary>
</member>
<member name="T:Xunit.Sdk.DelegatingTestCommand">
<summary>
Base class used by commands which delegate to inner commands.
</summary>
</member>
<member name="T:Xunit.Sdk.ITestCommand">
<summary>
Interface which represents the ability to invoke of a test method.
</summary>
</member>
<member name="M:Xunit.Sdk.ITestCommand.Execute(System.Object)">
<summary>
Executes the test method.
</summary>
<param name="testClass">The instance of the test class</param>
<returns>Returns information about the test run</returns>
</member>
<member name="M:Xunit.Sdk.ITestCommand.ToStartXml">
<summary>
Creates the start XML to be sent to the callback when the test is about to start
running.
</summary>
<returns>Return the <see cref="T:System.Xml.XmlNode"/> of the start node, or null if the test
is known that it will not be running.</returns>
</member>
<member name="P:Xunit.Sdk.ITestCommand.DisplayName">
<summary>
Gets the display name of the test method.
</summary>
</member>
<member name="P:Xunit.Sdk.ITestCommand.ShouldCreateInstance">
<summary>
Determines if the test runner infrastructure should create a new instance of the
test class before running the test.
</summary>
</member>
<member name="P:Xunit.Sdk.ITestCommand.Timeout">
<summary>
Determines if the test should be limited to running a specific amount of time
before automatically failing.
</summary>
<returns>The timeout value, in milliseconds; if zero, the test will not have
a timeout.</returns>
</member>
<member name="M:Xunit.Sdk.DelegatingTestCommand.#ctor(Xunit.Sdk.ITestCommand)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.DelegatingTestCommand"/> class.
</summary>
<param name="innerCommand">The inner command to delegate to.</param>
</member>
<member name="M:Xunit.Sdk.DelegatingTestCommand.Execute(System.Object)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.DelegatingTestCommand.ToStartXml">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.DelegatingTestCommand.InnerCommand">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.DelegatingTestCommand.DisplayName">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.DelegatingTestCommand.ShouldCreateInstance">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.DelegatingTestCommand.Timeout">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.ExceptionAndOutputCaptureCommand.#ctor(Xunit.Sdk.ITestCommand,Xunit.Sdk.IMethodInfo)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.ExceptionAndOutputCaptureCommand"/>
class.
</summary>
<param name="innerCommand">The command that will be wrapped.</param>
<param name="method">The test method.</param>
</member>
<member name="M:Xunit.Sdk.ExceptionAndOutputCaptureCommand.Execute(System.Object)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.FactCommand">
<summary>
Represents an implementation of <see cref="T:Xunit.Sdk.ITestCommand"/> to be used with
tests which are decorated with the <see cref="T:Xunit.FactAttribute"/>.
</summary>
</member>
<member name="T:Xunit.Sdk.TestCommand">
<summary>
Represents an xUnit.net test command.
</summary>
</member>
<member name="F:Xunit.Sdk.TestCommand.testMethod">
<summary>
The method under test.
</summary>
</member>
<member name="M:Xunit.Sdk.TestCommand.#ctor(Xunit.Sdk.IMethodInfo,System.String,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.TestCommand"/> class.
</summary>
<param name="method">The method under test.</param>
<param name="displayName">The display name of the test.</param>
<param name="timeout">The timeout, in milliseconds.</param>
</member>
<member name="M:Xunit.Sdk.TestCommand.Execute(System.Object)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.TestCommand.ToStartXml">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.TestCommand.DisplayName">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.TestCommand.MethodName">
<summary>
Gets the name of the method under test.
</summary>
</member>
<member name="P:Xunit.Sdk.TestCommand.ShouldCreateInstance">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.TestCommand.Timeout">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.TestCommand.TypeName">
<summary>
Gets the name of the type under test.
</summary>
</member>
<member name="M:Xunit.Sdk.FactCommand.#ctor(Xunit.Sdk.IMethodInfo)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.FactCommand"/> class.
</summary>
<param name="method">The test method.</param>
</member>
<member name="M:Xunit.Sdk.FactCommand.Execute(System.Object)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.AssertActualExpectedException">
<summary>
Base class for exceptions that have actual and expected values
</summary>
</member>
<member name="T:Xunit.Sdk.AssertException">
<summary>
The base assert exception class
</summary>
</member>
<member name="M:Xunit.Sdk.AssertException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.AssertException"/> class.
</summary>
</member>
<member name="M:Xunit.Sdk.AssertException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.AssertException"/> class.
</summary>
<param name="userMessage">The user message to be displayed</param>
</member>
<member name="M:Xunit.Sdk.AssertException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.AssertException"/> class.
</summary>
<param name="userMessage">The user message to be displayed</param>
<param name="innerException">The inner exception</param>
</member>
<member name="M:Xunit.Sdk.AssertException.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.AssertException"/> class.
</summary>
<param name="userMessage">The user message to be displayed</param>
<param name="stackTrace">The stack trace to be displayed</param>
</member>
<member name="M:Xunit.Sdk.AssertException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.AssertException.ExcludeStackFrame(System.String)">
<summary>
Determines whether to exclude a line from the stack frame. By default, this method
removes all stack frames from methods beginning with Xunit.Assert or Xunit.Sdk.
</summary>
<param name="stackFrame">The stack frame to be filtered.</param>
<returns>Return true to exclude the line from the stack frame; false, otherwise.</returns>
</member>
<member name="M:Xunit.Sdk.AssertException.FilterStackTrace(System.String)">
<summary>
Filters the stack trace to remove all lines that occur within the testing framework.
</summary>
<param name="stack">The original stack trace</param>
<returns>The filtered stack trace</returns>
</member>
<member name="M:Xunit.Sdk.AssertException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.AssertException.StackTrace">
<summary>
Gets a string representation of the frames on the call stack at the time the current exception was thrown.
</summary>
<returns>A string that describes the contents of the call stack, with the most recent method call appearing first.</returns>
</member>
<member name="P:Xunit.Sdk.AssertException.UserMessage">
<summary>
Gets the user message
</summary>
</member>
<member name="M:Xunit.Sdk.AssertActualExpectedException.#ctor(System.Object,System.Object,System.String)">
<summary>
Creates a new instance of the <see href="AssertActualExpectedException"/> class.
</summary>
<param name="expected">The expected value</param>
<param name="actual">The actual value</param>
<param name="userMessage">The user message to be shown</param>
</member>
<member name="M:Xunit.Sdk.AssertActualExpectedException.#ctor(System.Object,System.Object,System.String,System.Boolean)">
<summary>
Creates a new instance of the <see href="AssertActualExpectedException"/> class.
</summary>
<param name="expected">The expected value</param>
<param name="actual">The actual value</param>
<param name="userMessage">The user message to be shown</param>
<param name="skipPositionCheck">Set to true to skip the check for difference position</param>
</member>
<member name="M:Xunit.Sdk.AssertActualExpectedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.AssertActualExpectedException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.AssertActualExpectedException.Actual">
<summary>
Gets the actual value.
</summary>
</member>
<member name="P:Xunit.Sdk.AssertActualExpectedException.Expected">
<summary>
Gets the expected value.
</summary>
</member>
<member name="P:Xunit.Sdk.AssertActualExpectedException.Message">
<summary>
Gets a message that describes the current exception. Includes the expected and actual values.
</summary>
<returns>The error message that explains the reason for the exception, or an empty string("").</returns>
<filterpriority>1</filterpriority>
</member>
<member name="T:Xunit.Sdk.ContainsException">
<summary>
Exception thrown when a collection unexpectedly does not contain the expected value.
</summary>
</member>
<member name="M:Xunit.Sdk.ContainsException.#ctor(System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.ContainsException"/> class.
</summary>
<param name="expected">The expected object value</param>
</member>
<member name="M:Xunit.Sdk.ContainsException.#ctor(System.Object,System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.ContainsException"/> class.
</summary>
<param name="expected">The expected object value</param>
<param name="actual">The actual value</param>
</member>
<member name="M:Xunit.Sdk.ContainsException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.ParameterCountMismatchException">
<summary>
Exception to be thrown from <see cref="M:Xunit.Sdk.IMethodInfo.Invoke(System.Object,System.Object[])"/> when the number of
parameter values does not the test method signature.
</summary>
</member>
<member name="M:Xunit.Sdk.ParameterCountMismatchException.#ctor">
<summary/>
</member>
<member name="M:Xunit.Sdk.ParameterCountMismatchException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary/>
</member>
<member name="T:Xunit.Sdk.PropertyChangedException">
<summary>
Exception thrown when code unexpectedly fails change a property.
</summary>
</member>
<member name="M:Xunit.Sdk.PropertyChangedException.#ctor(System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.PropertyChangedException"/> class. Call this constructor
when no exception was thrown.
</summary>
<param name="propertyName">The name of the property that was expected to be changed.</param>
</member>
<member name="M:Xunit.Sdk.PropertyChangedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.SingleException">
<summary>
Exception thrown when the collection did not contain exactly one element.
</summary>
</member>
<member name="M:Xunit.Sdk.SingleException.#ctor(System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.SingleException"/> class.
</summary>
<param name="count">The numbers of items in the collection.</param>
</member>
<member name="M:Xunit.Sdk.SingleException.#ctor(System.Int32,System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.SingleException"/> class.
</summary>
<param name="count">The numbers of items in the collection.</param>
<param name="expected">The object expected to be in the collection.</param>
</member>
<member name="M:Xunit.Sdk.SingleException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.Executor">
<summary>
Internal class used for version-resilient test runners. DO NOT CALL DIRECTLY.
Version-resilient runners should link against xunit.runner.utility.dll and use
ExecutorWrapper instead.
</summary>
</member>
<member name="M:Xunit.Sdk.Executor.#ctor(System.String)">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.InitializeLifetimeService">
<summary/>
</member>
<member name="T:Xunit.Sdk.Executor.AssemblyTestCount">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.AssemblyTestCount.#ctor(Xunit.Sdk.Executor,System.Object)">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.AssemblyTestCount.InitializeLifetimeService">
<summary/>
</member>
<member name="T:Xunit.Sdk.Executor.EnumerateTests">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.EnumerateTests.#ctor(Xunit.Sdk.Executor,System.Object)">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.EnumerateTests.InitializeLifetimeService">
<summary/>
</member>
<member name="T:Xunit.Sdk.Executor.RunAssembly">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.RunAssembly.#ctor(Xunit.Sdk.Executor,System.Object)">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.RunAssembly.InitializeLifetimeService">
<summary/>
</member>
<member name="T:Xunit.Sdk.Executor.RunClass">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.RunClass.#ctor(Xunit.Sdk.Executor,System.String,System.Object)">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.RunClass.InitializeLifetimeService">
<summary/>
</member>
<member name="T:Xunit.Sdk.Executor.RunTest">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.RunTest.#ctor(Xunit.Sdk.Executor,System.String,System.String,System.Object)">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.RunTest.InitializeLifetimeService">
<summary/>
</member>
<member name="T:Xunit.Sdk.Executor.RunTests">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.RunTests.#ctor(Xunit.Sdk.Executor,System.String,System.Collections.Generic.List{System.String},System.Object)">
<summary/>
</member>
<member name="M:Xunit.Sdk.Executor.RunTests.InitializeLifetimeService">
<summary/>
</member>
<member name="T:Xunit.Sdk.IsAssignableFromException">
<summary>
Exception thrown when the value is unexpectedly not of the given type or a derived type.
</summary>
</member>
<member name="M:Xunit.Sdk.IsAssignableFromException.#ctor(System.Type,System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.IsTypeException"/> class.
</summary>
<param name="expected">The expected type</param>
<param name="actual">The actual object value</param>
</member>
<member name="M:Xunit.Sdk.IsAssignableFromException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Record">
<summary>
Allows the user to record actions for a test.
</summary>
</member>
<member name="M:Xunit.Record.Exception(Xunit.Assert.ThrowsDelegate)">
<summary>
Records any exception which is thrown by the given code.
</summary>
<param name="code">The code which may thrown an exception.</param>
<returns>Returns the exception that was thrown by the code; null, otherwise.</returns>
</member>
<member name="M:Xunit.Record.Exception(Xunit.Assert.ThrowsDelegateWithReturn)">
<summary>
Records any exception which is thrown by the given code that has
a return value. Generally used for testing property accessors.
</summary>
<param name="code">The code which may thrown an exception.</param>
<returns>Returns the exception that was thrown by the code; null, otherwise.</returns>
</member>
<member name="T:Xunit.Sdk.AfterTestException">
<summary>
Exception that is thrown when one or more exceptions are thrown from
the After method of a <see cref="T:Xunit.BeforeAfterTestAttribute"/>.
</summary>
</member>
<member name="M:Xunit.Sdk.AfterTestException.#ctor(System.Collections.Generic.IEnumerable{System.Exception})">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.AfterTestException"/> class.
</summary>
<param name="exceptions">The exceptions.</param>
</member>
<member name="M:Xunit.Sdk.AfterTestException.#ctor(System.Exception[])">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.AfterTestException"/> class.
</summary>
<param name="exceptions">The exceptions.</param>
</member>
<member name="M:Xunit.Sdk.AfterTestException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.AfterTestException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.AfterTestException.AfterExceptions">
<summary>
Gets the list of exceptions thrown in the After method.
</summary>
</member>
<member name="P:Xunit.Sdk.AfterTestException.Message">
<summary>
Gets a message that describes the current exception.
</summary>
</member>
<member name="P:Xunit.Sdk.AfterTestException.StackTrace">
<summary>
Gets a string representation of the frames on the call stack at the time the current exception was thrown.
</summary>
</member>
<member name="T:Xunit.Sdk.BeforeAfterCommand">
<summary>
Implementation of <see cref="T:Xunit.Sdk.ITestCommand"/> which executes the
<see cref="T:Xunit.BeforeAfterTestAttribute"/> instances attached to a test method.
</summary>
</member>
<member name="M:Xunit.Sdk.BeforeAfterCommand.#ctor(Xunit.Sdk.ITestCommand,System.Reflection.MethodInfo)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.BeforeAfterCommand"/> class.
</summary>
<param name="innerCommand">The inner command.</param>
<param name="testMethod">The method.</param>
</member>
<member name="M:Xunit.Sdk.BeforeAfterCommand.Execute(System.Object)">
<summary>
Executes the test method.
</summary>
<param name="testClass">The instance of the test class</param>
<returns>Returns information about the test run</returns>
</member>
<member name="T:Xunit.Sdk.ExecutorCallback">
<summary>
This class supports the xUnit.net infrastructure and is not intended to be used
directly from your code.
</summary>
</member>
<member name="M:Xunit.Sdk.ExecutorCallback.Wrap(System.Object)">
<summary>
This API supports the xUnit.net infrastructure and is not intended to be used
directly from your code.
</summary>
</member>
<member name="M:Xunit.Sdk.ExecutorCallback.Notify(System.String)">
<summary>
This API supports the xUnit.net infrastructure and is not intended to be used
directly from your code.
</summary>
</member>
<member name="M:Xunit.Sdk.ExecutorCallback.ShouldContinue">
<summary>
This API supports the xUnit.net infrastructure and is not intended to be used
directly from your code.
</summary>
</member>
<member name="T:Xunit.Sdk.Guard">
<summary>
Guard class, used for guard clauses and argument validation
</summary>
</member>
<member name="M:Xunit.Sdk.Guard.ArgumentNotNull(System.String,System.Object)">
<summary/>
</member>
<member name="M:Xunit.Sdk.Guard.ArgumentNotNullOrEmpty(System.String,System.Collections.IEnumerable)">
<summary/>
</member>
<member name="M:Xunit.Sdk.Guard.ArgumentValid(System.String,System.String,System.Boolean)">
<summary/>
</member>
<member name="T:Xunit.Sdk.TestResult">
<summary>
Base class which contains XML manipulation helper methods
</summary>
</member>
<member name="T:Xunit.Sdk.ITestResult">
<summary>
Interface that represents a single test result.
</summary>
</member>
<member name="M:Xunit.Sdk.ITestResult.ToXml(System.Xml.XmlNode)">
<summary>
Converts the test result into XML that is consumed by the test runners.
</summary>
<param name="parentNode">The parent node.</param>
<returns>The newly created XML node.</returns>
</member>
<member name="P:Xunit.Sdk.ITestResult.ExecutionTime">
<summary>
The amount of time spent in execution
</summary>
</member>
<member name="M:Xunit.Sdk.TestResult.AddTime(System.Xml.XmlNode)">
<summary>
Adds the test execution time to the XML node.
</summary>
<param name="testNode">The XML node.</param>
</member>
<member name="M:Xunit.Sdk.TestResult.ToXml(System.Xml.XmlNode)">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.TestResult.ExecutionTime">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.ExceptionUtility">
<summary>
Utility methods for dealing with exceptions.
</summary>
</member>
<member name="M:Xunit.Sdk.ExceptionUtility.GetMessage(System.Exception)">
<summary>
Gets the message for the exception, including any inner exception messages.
</summary>
<param name="ex">The exception</param>
<returns>The formatted message</returns>
</member>
<member name="M:Xunit.Sdk.ExceptionUtility.GetStackTrace(System.Exception)">
<summary>
Gets the stack trace for the exception, including any inner exceptions.
</summary>
<param name="ex">The exception</param>
<returns>The formatted stack trace</returns>
</member>
<member name="M:Xunit.Sdk.ExceptionUtility.RethrowWithNoStackTraceLoss(System.Exception)">
<summary>
Rethrows an exception object without losing the existing stack trace information
</summary>
<param name="ex">The exception to re-throw.</param>
<remarks>
For more information on this technique, see
http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx
</remarks>
</member>
<member name="T:Xunit.Sdk.MultiValueDictionary`2">
<summary>
A dictionary which contains multiple unique values for each key.
</summary>
<typeparam name="TKey">The type of the key.</typeparam>
<typeparam name="TValue">The type of the value.</typeparam>
</member>
<member name="M:Xunit.Sdk.MultiValueDictionary`2.AddValue(`0,`1)">
<summary>
Adds the value for the given key. If the key does not exist in the
dictionary yet, it will add it.
</summary>
<param name="key">The key.</param>
<param name="value">The value.</param>
</member>
<member name="M:Xunit.Sdk.MultiValueDictionary`2.Clear">
<summary>
Removes all keys and values from the dictionary.
</summary>
</member>
<member name="M:Xunit.Sdk.MultiValueDictionary`2.Contains(`0,`1)">
<summary>
Determines whether the dictionary contains to specified key and value.
</summary>
<param name="key">The key.</param>
<param name="value">The value.</param>
</member>
<member name="M:Xunit.Sdk.MultiValueDictionary`2.ForEach(Xunit.Sdk.MultiValueDictionary{`0,`1}.ForEachDelegate)">
<summary>
Calls the delegate once for each key/value pair in the dictionary.
</summary>
</member>
<member name="M:Xunit.Sdk.MultiValueDictionary`2.Remove(`0)">
<summary>
Removes the given key and all of its values.
</summary>
</member>
<member name="M:Xunit.Sdk.MultiValueDictionary`2.RemoveValue(`0,`1)">
<summary>
Removes the given value from the given key. If this was the
last value for the key, then the key is removed as well.
</summary>
<param name="key">The key.</param>
<param name="value">The value.</param>
</member>
<member name="P:Xunit.Sdk.MultiValueDictionary`2.Item(`0)">
<summary>
Gets the values for the given key.
</summary>
</member>
<member name="P:Xunit.Sdk.MultiValueDictionary`2.Count">
<summary>
Gets the count of the keys in the dictionary.
</summary>
</member>
<member name="P:Xunit.Sdk.MultiValueDictionary`2.Keys">
<summary>
Gets the keys.
</summary>
</member>
<member name="T:Xunit.Sdk.MultiValueDictionary`2.ForEachDelegate">
<summary/>
</member>
<member name="T:Xunit.Sdk.XmlUtility">
<summary>
XML utility methods
</summary>
</member>
<member name="M:Xunit.Sdk.XmlUtility.AddAttribute(System.Xml.XmlNode,System.String,System.Object)">
<summary>
Adds an attribute to an XML node.
</summary>
<param name="node">The XML node.</param>
<param name="name">The attribute name.</param>
<param name="value">The attribute value.</param>
</member>
<member name="M:Xunit.Sdk.XmlUtility.AddElement(System.Xml.XmlNode,System.String)">
<summary>
Adds a child element to an XML node.
</summary>
<param name="parentNode">The parent XML node.</param>
<param name="name">The child element name.</param>
<returns>The new child XML element.</returns>
</member>
<member name="M:Xunit.Sdk.XmlUtility.SetInnerText(System.Xml.XmlNode,System.String)">
<summary>
Sets the inner text of the XML node, properly escaping it as necessary.
</summary>
<param name="element">The element whose inner text will be set.</param>
<param name="value">The inner text to be escaped and then set.</param>
</member>
<member name="T:Xunit.Sdk.TraceAssertException">
<summary>
Exception that is thrown when a call to Debug.Assert() fails.
</summary>
</member>
<member name="M:Xunit.Sdk.TraceAssertException.#ctor(System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TraceAssertException"/> class.
</summary>
<param name="assertMessage">The original assert message</param>
</member>
<member name="M:Xunit.Sdk.TraceAssertException.#ctor(System.String,System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TraceAssertException"/> class.
</summary>
<param name="assertMessage">The original assert message</param>
<param name="assertDetailedMessage">The original assert detailed message</param>
</member>
<member name="M:Xunit.Sdk.TraceAssertException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.TraceAssertException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.TraceAssertException.AssertDetailedMessage">
<summary>
Gets the original assert detailed message.
</summary>
</member>
<member name="P:Xunit.Sdk.TraceAssertException.AssertMessage">
<summary>
Gets the original assert message.
</summary>
</member>
<member name="P:Xunit.Sdk.TraceAssertException.Message">
<summary>
Gets a message that describes the current exception.
</summary>
</member>
<member name="T:Xunit.Sdk.DoesNotContainException">
<summary>
Exception thrown when a collection unexpectedly contains the expected value.
</summary>
</member>
<member name="M:Xunit.Sdk.DoesNotContainException.#ctor(System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.DoesNotContainException"/> class.
</summary>
<param name="expected">The expected object value</param>
</member>
<member name="M:Xunit.Sdk.DoesNotContainException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.DoesNotThrowException">
<summary>
Exception thrown when code unexpectedly throws an exception.
</summary>
</member>
<member name="M:Xunit.Sdk.DoesNotThrowException.#ctor(System.Exception)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.DoesNotThrowException"/> class.
</summary>
<param name="actual">Actual exception</param>
</member>
<member name="M:Xunit.Sdk.DoesNotThrowException.#ctor(System.String)">
<summary>
THIS CONSTRUCTOR IS FOR UNIT TESTING PURPOSES ONLY.
</summary>
</member>
<member name="M:Xunit.Sdk.DoesNotThrowException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.DoesNotThrowException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.DoesNotThrowException.StackTrace">
<summary>
Gets a string representation of the frames on the call stack at the time the current exception was thrown.
</summary>
<returns>A string that describes the contents of the call stack, with the most recent method call appearing first.</returns>
</member>
<member name="T:Xunit.Sdk.EmptyException">
<summary>
Exception thrown when a collection is unexpectedly not empty.
</summary>
</member>
<member name="M:Xunit.Sdk.EmptyException.#ctor">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.EmptyException"/> class.
</summary>
</member>
<member name="M:Xunit.Sdk.EmptyException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.EqualException">
<summary>
Exception thrown when two values are unexpectedly not equal.
</summary>
</member>
<member name="M:Xunit.Sdk.EqualException.#ctor(System.Object,System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.EqualException"/> class.
</summary>
<param name="expected">The expected object value</param>
<param name="actual">The actual object value</param>
</member>
<member name="M:Xunit.Sdk.EqualException.#ctor(System.Object,System.Object,System.Boolean)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.EqualException"/> class.
</summary>
<param name="expected">The expected object value</param>
<param name="actual">The actual object value</param>
<param name="skipPositionCheck">Set to true to skip the check for difference position</param>
</member>
<member name="M:Xunit.Sdk.EqualException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.FalseException">
<summary>
Exception thrown when a value is unexpectedly true.
</summary>
</member>
<member name="M:Xunit.Sdk.FalseException.#ctor(System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.FalseException"/> class.
</summary>
<param name="userMessage">The user message to be display, or null for the default message</param>
</member>
<member name="M:Xunit.Sdk.FalseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.InRangeException">
<summary>
Exception thrown when a value is unexpectedly not in the given range.
</summary>
</member>
<member name="M:Xunit.Sdk.InRangeException.#ctor(System.Object,System.Object,System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.InRangeException"/> class.
</summary>
<param name="actual">The actual object value</param>
<param name="low">The low value of the range</param>
<param name="high">The high value of the range</param>
</member>
<member name="M:Xunit.Sdk.InRangeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.InRangeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.InRangeException.Actual">
<summary>
Gets the actual object value
</summary>
</member>
<member name="P:Xunit.Sdk.InRangeException.High">
<summary>
Gets the high value of the range
</summary>
</member>
<member name="P:Xunit.Sdk.InRangeException.Low">
<summary>
Gets the low value of the range
</summary>
</member>
<member name="P:Xunit.Sdk.InRangeException.Message">
<summary>
Gets a message that describes the current exception.
</summary>
<returns>The error message that explains the reason for the exception, or an empty string("").</returns>
</member>
<member name="T:Xunit.Sdk.IsNotTypeException">
<summary>
Exception thrown when the value is unexpectedly of the exact given type.
</summary>
</member>
<member name="M:Xunit.Sdk.IsNotTypeException.#ctor(System.Type,System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.IsNotTypeException"/> class.
</summary>
<param name="expected">The expected type</param>
<param name="actual">The actual object value</param>
</member>
<member name="M:Xunit.Sdk.IsNotTypeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.IsTypeException">
<summary>
Exception thrown when the value is unexpectedly not of the exact given type.
</summary>
</member>
<member name="M:Xunit.Sdk.IsTypeException.#ctor(System.Type,System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.IsTypeException"/> class.
</summary>
<param name="expected">The expected type</param>
<param name="actual">The actual object value</param>
</member>
<member name="M:Xunit.Sdk.IsTypeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.IUseFixture`1">
<summary>
Used to decorate xUnit.net test classes that utilize fixture classes.
An instance of the fixture data is initialized just before the first
test in the class is run, and if it implements IDisposable, is disposed
after the last test in the class is run.
</summary>
<typeparam name="T">The type of the fixture</typeparam>
</member>
<member name="M:Xunit.IUseFixture`1.SetFixture(`0)">
<summary>
Called on the test class just before each test method is run,
passing the fixture data so that it can be used for the test.
All test runs share the same instance of fixture data.
</summary>
<param name="data">The fixture data</param>
</member>
<member name="T:Xunit.Sdk.NotInRangeException">
<summary>
Exception thrown when a value is unexpectedly in the given range.
</summary>
</member>
<member name="M:Xunit.Sdk.NotInRangeException.#ctor(System.Object,System.Object,System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.NotInRangeException"/> class.
</summary>
<param name="actual">The actual object value</param>
<param name="low">The low value of the range</param>
<param name="high">The high value of the range</param>
</member>
<member name="M:Xunit.Sdk.NotInRangeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.NotInRangeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.NotInRangeException.Actual">
<summary>
Gets the actual object value
</summary>
</member>
<member name="P:Xunit.Sdk.NotInRangeException.High">
<summary>
Gets the high value of the range
</summary>
</member>
<member name="P:Xunit.Sdk.NotInRangeException.Low">
<summary>
Gets the low value of the range
</summary>
</member>
<member name="P:Xunit.Sdk.NotInRangeException.Message">
<summary>
Gets a message that describes the current exception.
</summary>
<returns>The error message that explains the reason for the exception, or an empty string("").</returns>
</member>
<member name="T:Xunit.BeforeAfterTestAttribute">
<summary>
Base attribute which indicates a test method interception (allows code to be run before and
after the test is run).
</summary>
</member>
<member name="M:Xunit.BeforeAfterTestAttribute.After(System.Reflection.MethodInfo)">
<summary>
This method is called after the test method is executed.
</summary>
<param name="methodUnderTest">The method under test</param>
</member>
<member name="M:Xunit.BeforeAfterTestAttribute.Before(System.Reflection.MethodInfo)">
<summary>
This method is called before the test method is executed.
</summary>
<param name="methodUnderTest">The method under test</param>
</member>
<member name="P:Xunit.BeforeAfterTestAttribute.TypeId">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.NotEmptyException">
<summary>
Exception thrown when a collection is unexpectedly empty.
</summary>
</member>
<member name="M:Xunit.Sdk.NotEmptyException.#ctor">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.NotEmptyException"/> class.
</summary>
</member>
<member name="M:Xunit.Sdk.NotEmptyException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.NotEqualException">
<summary>
Exception thrown when two values are unexpectedly equal.
</summary>
</member>
<member name="M:Xunit.Sdk.NotEqualException.#ctor">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.NotEqualException"/> class.
</summary>
</member>
<member name="M:Xunit.Sdk.NotEqualException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.NotNullException">
<summary>
Exception thrown when an object is unexpectedly null.
</summary>
</member>
<member name="M:Xunit.Sdk.NotNullException.#ctor">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.NotNullException"/> class.
</summary>
</member>
<member name="M:Xunit.Sdk.NotNullException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.NotSameException">
<summary>
Exception thrown when two values are unexpected the same instance.
</summary>
</member>
<member name="M:Xunit.Sdk.NotSameException.#ctor">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.NotSameException"/> class.
</summary>
</member>
<member name="M:Xunit.Sdk.NotSameException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.NullException">
<summary>
Exception thrown when an object reference is unexpectedly not null.
</summary>
</member>
<member name="M:Xunit.Sdk.NullException.#ctor(System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.NullException"/> class.
</summary>
<param name="actual"></param>
</member>
<member name="M:Xunit.Sdk.NullException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.LifetimeCommand">
<summary>
Command that automatically creates the instance of the test class
and disposes it (if it implements <see cref="T:System.IDisposable"/>).
</summary>
</member>
<member name="M:Xunit.Sdk.LifetimeCommand.#ctor(Xunit.Sdk.ITestCommand,Xunit.Sdk.IMethodInfo)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.LifetimeCommand"/> object.
</summary>
<param name="innerCommand">The command that is bring wrapped</param>
<param name="method">The method under test</param>
</member>
<member name="M:Xunit.Sdk.LifetimeCommand.Execute(System.Object)">
<summary>
Executes the test method. Creates a new instance of the class
under tests and passes it to the inner command. Also catches
any exceptions and converts them into <see cref="T:Xunit.Sdk.FailedResult"/>s.
</summary>
<param name="testClass">The instance of the test class</param>
<returns>Returns information about the test run</returns>
</member>
<member name="T:Xunit.Sdk.FixtureCommand">
<summary>
Command used to wrap a <see cref="T:Xunit.Sdk.ITestCommand"/> which has associated
fixture data.
</summary>
</member>
<member name="M:Xunit.Sdk.FixtureCommand.#ctor(Xunit.Sdk.ITestCommand,System.Collections.Generic.Dictionary{System.Reflection.MethodInfo,System.Object})">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.FixtureCommand"/> class.
</summary>
<param name="innerCommand">The inner command</param>
<param name="fixtures">The fixtures to be set on the test class</param>
</member>
<member name="M:Xunit.Sdk.FixtureCommand.Execute(System.Object)">
<summary>
Sets the fixtures on the test class by calling SetFixture, then
calls the inner command.
</summary>
<param name="testClass">The instance of the test class</param>
<returns>Returns information about the test run</returns>
</member>
<member name="T:Xunit.Sdk.TestTimer">
<summary>
A timer class used to figure out how long tests take to run. On most .NET implementations
this will use the <see cref="T:System.Diagnostics.Stopwatch"/> class because it's a high
resolution timer; however, on Silverlight/CoreCLR, it will use <see cref="T:System.DateTime"/>
(which will provide lower resolution results).
</summary>
</member>
<member name="M:Xunit.Sdk.TestTimer.#ctor">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TestTimer"/> class.
</summary>
</member>
<member name="M:Xunit.Sdk.TestTimer.Start">
<summary>
Starts timing.
</summary>
</member>
<member name="M:Xunit.Sdk.TestTimer.Stop">
<summary>
Stops timing.
</summary>
</member>
<member name="P:Xunit.Sdk.TestTimer.ElapsedMilliseconds">
<summary>
Gets how long the timer ran, in milliseconds. In order for this to be valid,
both <see cref="M:Xunit.Sdk.TestTimer.Start"/> and <see cref="M:Xunit.Sdk.TestTimer.Stop"/> must have been called.
</summary>
</member>
<member name="T:Xunit.TraitAttribute">
<summary>
Attribute used to decorate a test method with arbitrary name/value pairs ("traits").
</summary>
</member>
<member name="M:Xunit.TraitAttribute.#ctor(System.String,System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.TraitAttribute"/> class.
</summary>
<param name="name">The trait name</param>
<param name="value">The trait value</param>
</member>
<member name="P:Xunit.TraitAttribute.Name">
<summary>
Gets the trait name.
</summary>
</member>
<member name="P:Xunit.TraitAttribute.TypeId">
<inheritdoc/>
</member>
<member name="P:Xunit.TraitAttribute.Value">
<summary>
Gets the trait value.
</summary>
</member>
<member name="T:Xunit.Sdk.TestClassCommandRunner">
<summary>
Runner that executes an <see cref="T:Xunit.Sdk.ITestClassCommand"/> synchronously.
</summary>
</member>
<member name="M:Xunit.Sdk.TestClassCommandRunner.Execute(Xunit.Sdk.ITestClassCommand,System.Collections.Generic.List{Xunit.Sdk.IMethodInfo},System.Predicate{Xunit.Sdk.ITestCommand},System.Predicate{Xunit.Sdk.ITestResult})">
<summary>
Execute the <see cref="T:Xunit.Sdk.ITestClassCommand"/>.
</summary>
<param name="testClassCommand">The test class command to execute</param>
<param name="methods">The methods to execute; if null or empty, all methods will be executed</param>
<param name="startCallback">The start run callback</param>
<param name="resultCallback">The end run result callback</param>
<returns>A <see cref="T:Xunit.Sdk.ClassResult"/> with the results of the test run</returns>
</member>
<member name="T:Xunit.Sdk.TestClassCommandFactory">
<summary>
Factory for <see cref="T:Xunit.Sdk.ITestClassCommand"/> objects, based on the type under test.
</summary>
</member>
<member name="M:Xunit.Sdk.TestClassCommandFactory.Make(System.Type)">
<summary>
Creates the test class command, which implements <see cref="T:Xunit.Sdk.ITestClassCommand"/>, for a given type.
</summary>
<param name="type">The type under test</param>
<returns>The test class command, if the class is a test class; null, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.TestClassCommandFactory.Make(Xunit.Sdk.ITypeInfo)">
<summary>
Creates the test class command, which implements <see cref="T:Xunit.Sdk.ITestClassCommand"/>, for a given type.
</summary>
<param name="typeInfo">The type under test</param>
<returns>The test class command, if the class is a test class; null, otherwise</returns>
</member>
<member name="T:Xunit.Sdk.TestClassCommand">
<summary>
Represents an xUnit.net test class
</summary>
</member>
<member name="T:Xunit.Sdk.ITestClassCommand">
<summary>
Interface which describes the ability to executes all the tests in a test class.
</summary>
</member>
<member name="M:Xunit.Sdk.ITestClassCommand.ChooseNextTest(System.Collections.Generic.ICollection{Xunit.Sdk.IMethodInfo})">
<summary>
Allows the test class command to choose the next test to be run from the list of
tests that have not yet been run, thereby allowing it to choose the run order.
</summary>
<param name="testsLeftToRun">The tests remaining to be run</param>
<returns>The index of the test that should be run</returns>
</member>
<member name="M:Xunit.Sdk.ITestClassCommand.ClassFinish">
<summary>
Execute actions to be run after all the test methods of this test class are run.
</summary>
<returns>Returns the <see cref="T:System.Exception"/> thrown during execution, if any; null, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.ITestClassCommand.ClassStart">
<summary>
Execute actions to be run before any of the test methods of this test class are run.
</summary>
<returns>Returns the <see cref="T:System.Exception"/> thrown during execution, if any; null, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.ITestClassCommand.EnumerateTestCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Enumerates the test commands for a given test method in this test class.
</summary>
<param name="testMethod">The method under test</param>
<returns>The test commands for the given test method</returns>
</member>
<member name="M:Xunit.Sdk.ITestClassCommand.EnumerateTestMethods">
<summary>
Enumerates the methods which are test methods in this test class.
</summary>
<returns>The test methods</returns>
</member>
<member name="M:Xunit.Sdk.ITestClassCommand.IsTestMethod(Xunit.Sdk.IMethodInfo)">
<summary>
Determines if a given <see cref="T:Xunit.Sdk.IMethodInfo"/> refers to a test method.
</summary>
<param name="testMethod">The test method to validate</param>
<returns>True if the method is a test method; false, otherwise</returns>
</member>
<member name="P:Xunit.Sdk.ITestClassCommand.ObjectUnderTest">
<summary>
Gets the object instance that is under test. May return null if you wish
the test framework to create a new object instance for each test method.
</summary>
</member>
<member name="P:Xunit.Sdk.ITestClassCommand.TypeUnderTest">
<summary>
Gets or sets the type that is being tested
</summary>
</member>
<member name="M:Xunit.Sdk.TestClassCommand.#ctor">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TestClassCommand"/> class.
</summary>
</member>
<member name="M:Xunit.Sdk.TestClassCommand.#ctor(System.Type)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TestClassCommand"/> class.
</summary>
<param name="typeUnderTest">The type under test</param>
</member>
<member name="M:Xunit.Sdk.TestClassCommand.#ctor(Xunit.Sdk.ITypeInfo)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TestClassCommand"/> class.
</summary>
<param name="typeUnderTest">The type under test</param>
</member>
<member name="M:Xunit.Sdk.TestClassCommand.ChooseNextTest(System.Collections.Generic.ICollection{Xunit.Sdk.IMethodInfo})">
<summary>
Chooses the next test to run, randomly, using the <see cref="P:Xunit.Sdk.TestClassCommand.Randomizer"/>.
</summary>
<param name="testsLeftToRun">The tests remaining to be run</param>
<returns>The index of the test that should be run</returns>
</member>
<member name="M:Xunit.Sdk.TestClassCommand.ClassFinish">
<summary>
Execute actions to be run after all the test methods of this test class are run.
</summary>
<returns>Returns the <see cref="T:System.Exception"/> thrown during execution, if any; null, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.TestClassCommand.ClassStart">
<summary>
Execute actions to be run before any of the test methods of this test class are run.
</summary>
<returns>Returns the <see cref="T:System.Exception"/> thrown during execution, if any; null, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.TestClassCommand.EnumerateTestCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Enumerates the test commands for a given test method in this test class.
</summary>
<param name="testMethod">The method under test</param>
<returns>The test commands for the given test method</returns>
</member>
<member name="M:Xunit.Sdk.TestClassCommand.EnumerateTestMethods">
<summary>
Enumerates the methods which are test methods in this test class.
</summary>
<returns>The test methods</returns>
</member>
<member name="M:Xunit.Sdk.TestClassCommand.IsTestMethod(Xunit.Sdk.IMethodInfo)">
<summary>
Determines if a given <see cref="T:Xunit.Sdk.IMethodInfo"/> refers to a test method.
</summary>
<param name="testMethod">The test method to validate</param>
<returns>True if the method is a test method; false, otherwise</returns>
</member>
<member name="P:Xunit.Sdk.TestClassCommand.ObjectUnderTest">
<summary>
Gets the object instance that is under test. May return null if you wish
the test framework to create a new object instance for each test method.
</summary>
</member>
<member name="P:Xunit.Sdk.TestClassCommand.Randomizer">
<summary>
Gets or sets the randomizer used to determine the order in which tests are run.
</summary>
</member>
<member name="P:Xunit.Sdk.TestClassCommand.TypeUnderTest">
<summary>
Sets the type that is being tested
</summary>
</member>
<member name="T:Xunit.Sdk.SkipCommand">
<summary>
Implementation of <see cref="T:Xunit.Sdk.ITestCommand"/> that represents a skipped test.
</summary>
</member>
<member name="M:Xunit.Sdk.SkipCommand.#ctor(Xunit.Sdk.IMethodInfo,System.String,System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.SkipCommand"/> class.
</summary>
<param name="testMethod">The method that is being skipped</param>
<param name="displayName">The display name for the test. If null, the fully qualified
type name is used.</param>
<param name="reason">The reason the test was skipped.</param>
</member>
<member name="M:Xunit.Sdk.SkipCommand.Execute(System.Object)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.SkipCommand.ToStartXml">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.SkipCommand.Reason">
<summary>
Gets the skip reason.
</summary>
</member>
<member name="P:Xunit.Sdk.SkipCommand.ShouldCreateInstance">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.TestCommandFactory">
<summary>
Factory for creating <see cref="T:Xunit.Sdk.ITestCommand"/> objects.
</summary>
</member>
<member name="M:Xunit.Sdk.TestCommandFactory.Make(Xunit.Sdk.ITestClassCommand,Xunit.Sdk.IMethodInfo)">
<summary>
Make instances of <see cref="T:Xunit.Sdk.ITestCommand"/> objects for the given class and method.
</summary>
<param name="classCommand">The class command</param>
<param name="method">The method under test</param>
<returns>The set of <see cref="T:Xunit.Sdk.ITestCommand"/> objects</returns>
</member>
<member name="T:Xunit.Sdk.TimedCommand">
<summary>
A command wrapper which times the running of a command.
</summary>
</member>
<member name="M:Xunit.Sdk.TimedCommand.#ctor(Xunit.Sdk.ITestCommand)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TimedCommand"/> class.
</summary>
<param name="innerCommand">The command that will be timed.</param>
</member>
<member name="M:Xunit.Sdk.TimedCommand.Execute(System.Object)">
<summary>
Executes the inner test method, gathering the amount of time it takes to run.
</summary>
<returns>Returns information about the test run</returns>
</member>
<member name="T:Xunit.Sdk.TimeoutCommand">
<summary>
Wraps a command which should fail if it runs longer than the given timeout value.
</summary>
</member>
<member name="M:Xunit.Sdk.TimeoutCommand.#ctor(Xunit.Sdk.ITestCommand,System.Int32,Xunit.Sdk.IMethodInfo)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TimeoutCommand"/> class.
</summary>
<param name="innerCommand">The command to be run</param>
<param name="timeout">The timout, in milliseconds</param>
<param name="testMethod">The method under test</param>
</member>
<member name="M:Xunit.Sdk.TimeoutCommand.Execute(System.Object)">
<summary>
Executes the test method, failing if it takes too long.
</summary>
<returns>Returns information about the test run</returns>
</member>
<member name="P:Xunit.Sdk.TimeoutCommand.Timeout">
<inheritdoc/>
</member>
<member name="T:Xunit.RunWithAttribute">
<summary>
Attributes used to decorate a test fixture that is run with an alternate test runner.
The test runner must implement the <see cref="T:Xunit.Sdk.ITestClassCommand"/> interface.
</summary>
</member>
<member name="M:Xunit.RunWithAttribute.#ctor(System.Type)">
<summary>
Creates a new instance of the <see cref="T:Xunit.RunWithAttribute"/> class.
</summary>
<param name="testClassCommand">The class which implements ITestClassCommand and acts as the runner
for the test fixture.</param>
</member>
<member name="P:Xunit.RunWithAttribute.TestClassCommand">
<summary>
Gets the test class command.
</summary>
</member>
<member name="T:Xunit.Sdk.SameException">
<summary>
Exception thrown when two object references are unexpectedly not the same instance.
</summary>
</member>
<member name="M:Xunit.Sdk.SameException.#ctor(System.Object,System.Object)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.SameException"/> class.
</summary>
<param name="expected">The expected object reference</param>
<param name="actual">The actual object reference</param>
</member>
<member name="M:Xunit.Sdk.SameException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.AssemblyResult">
<summary>
Contains the test results from an assembly.
</summary>
</member>
<member name="T:Xunit.Sdk.CompositeResult">
<summary>
Contains multiple test results, representing them as a composite test result.
</summary>
</member>
<member name="M:Xunit.Sdk.CompositeResult.Add(Xunit.Sdk.ITestResult)">
<summary>
Adds a test result to the composite test result list.
</summary>
<param name="testResult"></param>
</member>
<member name="P:Xunit.Sdk.CompositeResult.Results">
<summary>
Gets the test results.
</summary>
</member>
<member name="M:Xunit.Sdk.AssemblyResult.#ctor(System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.AssemblyResult"/> class.
</summary>
<param name="assemblyFilename">The filename of the assembly</param>
</member>
<member name="M:Xunit.Sdk.AssemblyResult.#ctor(System.String,System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.AssemblyResult"/> class.
</summary>
<param name="assemblyFilename">The filename of the assembly</param>
<param name="configFilename">The configuration filename</param>
</member>
<member name="M:Xunit.Sdk.AssemblyResult.ToXml(System.Xml.XmlNode)">
<summary>
Converts the test result into XML that is consumed by the test runners.
</summary>
<param name="parentNode">The parent node.</param>
<returns>The newly created XML node.</returns>
</member>
<member name="P:Xunit.Sdk.AssemblyResult.ConfigFilename">
<summary>
Gets the fully qualified filename of the configuration file.
</summary>
</member>
<member name="P:Xunit.Sdk.AssemblyResult.Directory">
<summary>
Gets the directory where the assembly resides.
</summary>
</member>
<member name="P:Xunit.Sdk.AssemblyResult.FailCount">
<summary>
Gets the number of failed results.
</summary>
</member>
<member name="P:Xunit.Sdk.AssemblyResult.Filename">
<summary>
Gets the fully qualified filename of the assembly.
</summary>
</member>
<member name="P:Xunit.Sdk.AssemblyResult.PassCount">
<summary>
Gets the number of passed results.
</summary>
</member>
<member name="P:Xunit.Sdk.AssemblyResult.SkipCount">
<summary>
Gets the number of skipped results.
</summary>
</member>
<member name="T:Xunit.Sdk.ClassResult">
<summary>
Contains the test results from a test class.
</summary>
</member>
<member name="M:Xunit.Sdk.ClassResult.#ctor(System.Type)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.ClassResult"/> class.
</summary>
<param name="type">The type under test</param>
</member>
<member name="M:Xunit.Sdk.ClassResult.#ctor(System.String,System.String,System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.ClassResult"/> class.
</summary>
<param name="typeName">The simple name of the type under test</param>
<param name="typeFullName">The fully qualified name of the type under test</param>
<param name="typeNamespace">The namespace of the type under test</param>
</member>
<member name="M:Xunit.Sdk.ClassResult.SetException(System.Exception)">
<summary>
Sets the exception thrown by the test fixture.
</summary>
<param name="ex">The thrown exception</param>
</member>
<member name="M:Xunit.Sdk.ClassResult.ToXml(System.Xml.XmlNode)">
<summary>
Converts the test result into XML that is consumed by the test runners.
</summary>
<param name="parentNode">The parent node.</param>
<returns>The newly created XML node.</returns>
</member>
<member name="P:Xunit.Sdk.ClassResult.ExceptionType">
<summary>
Gets the fully qualified test fixture exception type, when an exception has occurred.
</summary>
</member>
<member name="P:Xunit.Sdk.ClassResult.FailCount">
<summary>
Gets the number of tests which failed.
</summary>
</member>
<member name="P:Xunit.Sdk.ClassResult.FullyQualifiedName">
<summary>
Gets the fully qualified name of the type under test.
</summary>
</member>
<member name="P:Xunit.Sdk.ClassResult.Message">
<summary>
Gets the test fixture exception message, when an exception has occurred.
</summary>
</member>
<member name="P:Xunit.Sdk.ClassResult.Name">
<summary>
Gets the simple name of the type under test.
</summary>
</member>
<member name="P:Xunit.Sdk.ClassResult.Namespace">
<summary>
Gets the namespace of the type under test.
</summary>
</member>
<member name="P:Xunit.Sdk.ClassResult.PassCount">
<summary>
Gets the number of tests which passed.
</summary>
</member>
<member name="P:Xunit.Sdk.ClassResult.SkipCount">
<summary>
Gets the number of tests which were skipped.
</summary>
</member>
<member name="P:Xunit.Sdk.ClassResult.StackTrace">
<summary>
Gets the test fixture exception stack trace, when an exception has occurred.
</summary>
</member>
<member name="T:Xunit.Sdk.FailedResult">
<summary>
Represents a failed test result.
</summary>
</member>
<member name="T:Xunit.Sdk.MethodResult">
<summary>
Represents the results from running a test method
</summary>
</member>
<member name="M:Xunit.Sdk.MethodResult.#ctor(Xunit.Sdk.IMethodInfo,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.MethodResult"/> class. The traits for
the test method are discovered using reflection.
</summary>
<param name="method">The method under test.</param>
<param name="displayName">The display name for the test. If null, the fully qualified
type name is used.</param>
</member>
<member name="M:Xunit.Sdk.MethodResult.#ctor(System.String,System.String,System.String,Xunit.Sdk.MultiValueDictionary{System.String,System.String})">
<summary>
Initializes a new instance of the <see cref="T:Xunit.Sdk.MethodResult"/> class.
</summary>
<param name="methodName">The name of the method under test.</param>
<param name="typeName">The type of the method under test.</param>
<param name="displayName">The display name for the test. If null, the fully qualified
type name is used.</param>
<param name="traits">The traits.</param>
</member>
<member name="M:Xunit.Sdk.MethodResult.ToXml(System.Xml.XmlNode)">
<summary>
Converts the test result into XML that is consumed by the test runners.
</summary>
<param name="parentNode">The parent node.</param>
<returns>The newly created XML node.</returns>
</member>
<member name="P:Xunit.Sdk.MethodResult.DisplayName">
<summary>
Gets or sets the display name of the method under test. This is the value that's shown
during failures and in the resulting output XML.
</summary>
</member>
<member name="P:Xunit.Sdk.MethodResult.MethodName">
<summary>
Gets the name of the method under test.
</summary>
</member>
<member name="P:Xunit.Sdk.MethodResult.Output">
<summary>
Gets or sets the standard output/standard error from the test that was captured
while the test was running.
</summary>
</member>
<member name="P:Xunit.Sdk.MethodResult.Traits">
<summary>
Gets the traits attached to the test method.
</summary>
</member>
<member name="P:Xunit.Sdk.MethodResult.TypeName">
<summary>
Gets the name of the type under test.
</summary>
</member>
<member name="M:Xunit.Sdk.FailedResult.#ctor(Xunit.Sdk.IMethodInfo,System.Exception,System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.FailedResult"/> class.
</summary>
<param name="method">The method under test</param>
<param name="exception">The exception throw by the test</param>
<param name="displayName">The display name for the test. If null, the fully qualified
type name is used.</param>
</member>
<member name="M:Xunit.Sdk.FailedResult.#ctor(System.String,System.String,System.String,Xunit.Sdk.MultiValueDictionary{System.String,System.String},System.String,System.String,System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.FailedResult"/> class.
</summary>
<param name="methodName">The name of the method under test</param>
<param name="typeName">The name of the type under test</param>
<param name="displayName">The display name of the test</param>
<param name="traits">The custom properties attached to the test method</param>
<param name="exceptionType">The full type name of the exception throw</param>
<param name="message">The exception message</param>
<param name="stackTrace">The exception stack trace</param>
</member>
<member name="M:Xunit.Sdk.FailedResult.ToXml(System.Xml.XmlNode)">
<summary>
Converts the test result into XML that is consumed by the test runners.
</summary>
<param name="parentNode">The parent node.</param>
<returns>The newly created XML node.</returns>
</member>
<member name="P:Xunit.Sdk.FailedResult.ExceptionType">
<summary>
Gets the exception type thrown by the test method.
</summary>
</member>
<member name="P:Xunit.Sdk.FailedResult.Message">
<summary>
Gets the exception message thrown by the test method.
</summary>
</member>
<member name="P:Xunit.Sdk.FailedResult.StackTrace">
<summary>
Gets the stack trace of the exception thrown by the test method.
</summary>
</member>
<member name="T:Xunit.Sdk.PassedResult">
<summary>
Represents a passing test result.
</summary>
</member>
<member name="M:Xunit.Sdk.PassedResult.#ctor(Xunit.Sdk.IMethodInfo,System.String)">
<summary>
Create a new instance of the <see cref="T:Xunit.Sdk.PassedResult"/> class.
</summary>
<param name="method">The method under test</param>
<param name="displayName">The display name for the test. If null, the fully qualified
type name is used.</param>
</member>
<member name="M:Xunit.Sdk.PassedResult.#ctor(System.String,System.String,System.String,Xunit.Sdk.MultiValueDictionary{System.String,System.String})">
<summary>
Create a new instance of the <see cref="T:Xunit.Sdk.PassedResult"/> class.
</summary>
<param name="methodName">The name of the method under test</param>
<param name="typeName">The name of the type under test</param>
<param name="displayName">The display name for the test. If null, the fully qualified
type name is used.</param>
<param name="traits">The custom properties attached to the test method</param>
</member>
<member name="M:Xunit.Sdk.PassedResult.ToXml(System.Xml.XmlNode)">
<summary>
Converts the test result into XML that is consumed by the test runners.
</summary>
<param name="parentNode">The parent node.</param>
<returns>The newly created XML node.</returns>
</member>
<member name="T:Xunit.Sdk.SkipResult">
<summary>
Represents a skipped test result.
</summary>
</member>
<member name="M:Xunit.Sdk.SkipResult.#ctor(Xunit.Sdk.IMethodInfo,System.String,System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.SkipResult"/> class. Uses reflection to discover
the skip reason.
</summary>
<param name="method">The method under test</param>
<param name="displayName">The display name for the test. If null, the fully qualified
type name is used.</param>
<param name="reason">The reason the test was skipped.</param>
</member>
<member name="M:Xunit.Sdk.SkipResult.#ctor(System.String,System.String,System.String,Xunit.Sdk.MultiValueDictionary{System.String,System.String},System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.SkipResult"/> class.
</summary>
<param name="methodName">The name of the method under test</param>
<param name="typeName">The name of the type under test</param>
<param name="displayName">The display name for the test. If null, the fully qualified
type name is used.</param>
<param name="traits">The traits attached to the method under test</param>
<param name="reason">The skip reason</param>
</member>
<member name="M:Xunit.Sdk.SkipResult.ToXml(System.Xml.XmlNode)">
<summary>
Converts the test result into XML that is consumed by the test runners.
</summary>
<param name="parentNode">The parent node.</param>
<returns>The newly created XML node.</returns>
</member>
<member name="P:Xunit.Sdk.SkipResult.Reason">
<summary>
Gets the skip reason.
</summary>
</member>
<member name="T:Xunit.Sdk.IAttributeInfo">
<summary>
Represents information about an attribute.
</summary>
</member>
<member name="M:Xunit.Sdk.IAttributeInfo.GetInstance``1">
<summary>
Gets the instance of the attribute, if available.
</summary>
<typeparam name="T">The type of the attribute</typeparam>
<returns>The instance of the attribute, if available.</returns>
</member>
<member name="M:Xunit.Sdk.IAttributeInfo.GetPropertyValue``1(System.String)">
<summary>
Gets an initialized property value of the attribute.
</summary>
<typeparam name="TValue">The type of the property</typeparam>
<param name="propertyName">The name of the property</param>
<returns>The property value</returns>
</member>
<member name="T:Xunit.Sdk.IMethodInfo">
<summary>
Represents information about a method.
</summary>
</member>
<member name="M:Xunit.Sdk.IMethodInfo.CreateInstance">
<summary>
Creates an instance of the type where this test method was found. If using
reflection, this should be the ReflectedType.
</summary>
<returns>A new instance of the type.</returns>
</member>
<member name="M:Xunit.Sdk.IMethodInfo.GetCustomAttributes(System.Type)">
<summary>
Gets all the custom attributes for the method that are of the given type.
</summary>
<param name="attributeType">The type of the attribute</param>
<returns>The matching attributes that decorate the method</returns>
</member>
<member name="M:Xunit.Sdk.IMethodInfo.HasAttribute(System.Type)">
<summary>
Determines if the method has at least one instance of the given attribute type.
</summary>
<param name="attributeType">The type of the attribute</param>
<returns>True if the method has at least one instance of the given attribute type; false, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.IMethodInfo.Invoke(System.Object,System.Object[])">
<summary>
Invokes the test on the given class, with the given parameters.
</summary>
<param name="testClass">The instance of the test class (may be null if
the test method is static).</param>
<param name="parameters">The parameters to be passed to the test method.</param>
</member>
<member name="P:Xunit.Sdk.IMethodInfo.Class">
<summary>
Gets a value which represents the class that this method was
reflected from (i.e., equivalent to MethodInfo.ReflectedType)
</summary>
</member>
<member name="P:Xunit.Sdk.IMethodInfo.IsAbstract">
<summary>
Gets a value indicating whether the method is abstract.
</summary>
</member>
<member name="P:Xunit.Sdk.IMethodInfo.IsStatic">
<summary>
Gets a value indicating whether the method is static.
</summary>
</member>
<member name="P:Xunit.Sdk.IMethodInfo.MethodInfo">
<summary>
Gets the underlying <see cref="P:Xunit.Sdk.IMethodInfo.MethodInfo"/> for the method, if available.
</summary>
</member>
<member name="P:Xunit.Sdk.IMethodInfo.Name">
<summary>
Gets the name of the method.
</summary>
</member>
<member name="P:Xunit.Sdk.IMethodInfo.ReturnType">
<summary>
Gets the fully qualified type name of the return type.
</summary>
</member>
<member name="P:Xunit.Sdk.IMethodInfo.TypeName">
<summary>
Gets the fully qualified type name of the type that this method belongs to. If
using reflection, this should be the ReflectedType.
</summary>
</member>
<member name="T:Xunit.Sdk.ITypeInfo">
<summary>
Represents information about a type.
</summary>
</member>
<member name="M:Xunit.Sdk.ITypeInfo.GetCustomAttributes(System.Type)">
<summary>
Gets all the custom attributes for the type that are of the given attribute type.
</summary>
<param name="attributeType">The type of the attribute</param>
<returns>The matching attributes that decorate the type</returns>
</member>
<member name="M:Xunit.Sdk.ITypeInfo.GetMethod(System.String)">
<summary>
Gets a test method by name.
</summary>
<param name="methodName">The name of the method</param>
<returns>The method, if it exists; null, otherwise.</returns>
</member>
<member name="M:Xunit.Sdk.ITypeInfo.GetMethods">
<summary>
Gets all the methods
</summary>
<returns></returns>
</member>
<member name="M:Xunit.Sdk.ITypeInfo.HasAttribute(System.Type)">
<summary>
Determines if the type has at least one instance of the given attribute type.
</summary>
<param name="attributeType">The type of the attribute</param>
<returns>True if the type has at least one instance of the given attribute type; false, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.ITypeInfo.HasInterface(System.Type)">
<summary>
Determines if the type implements the given interface.
</summary>
<param name="interfaceType">The type of the interface</param>
<returns>True if the type implements the given interface; false, otherwise</returns>
</member>
<member name="P:Xunit.Sdk.ITypeInfo.IsAbstract">
<summary>
Gets a value indicating whether the type is abstract.
</summary>
</member>
<member name="P:Xunit.Sdk.ITypeInfo.IsSealed">
<summary>
Gets a value indicating whether the type is sealed.
</summary>
</member>
<member name="P:Xunit.Sdk.ITypeInfo.Type">
<summary>
Gets the underlying <see cref="P:Xunit.Sdk.ITypeInfo.Type"/> object, if available.
</summary>
</member>
<member name="T:Xunit.Sdk.MethodUtility">
<summary>
Utility class which inspects methods for test information
</summary>
</member>
<member name="M:Xunit.Sdk.MethodUtility.GetDisplayName(Xunit.Sdk.IMethodInfo)">
<summary>
Gets the display name.
</summary>
<param name="method">The method to be inspected</param>
<returns>The display name</returns>
</member>
<member name="M:Xunit.Sdk.MethodUtility.GetSkipReason(Xunit.Sdk.IMethodInfo)">
<summary>
Gets the skip reason from a test method.
</summary>
<param name="method">The method to be inspected</param>
<returns>The skip reason</returns>
</member>
<member name="M:Xunit.Sdk.MethodUtility.GetTestCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Gets the test commands for a test method.
</summary>
<param name="method">The method to be inspected</param>
<returns>The <see cref="T:Xunit.Sdk.ITestCommand"/> objects for the test method</returns>
</member>
<member name="M:Xunit.Sdk.MethodUtility.GetTimeoutParameter(Xunit.Sdk.IMethodInfo)">
<summary>
Gets the timeout value for a test method.
</summary>
<param name="method">The method to be inspected</param>
<returns>The timeout, in milliseconds</returns>
</member>
<member name="M:Xunit.Sdk.MethodUtility.GetTraits(Xunit.Sdk.IMethodInfo)">
<summary>
Gets the traits on a test method.
</summary>
<param name="method">The method to be inspected</param>
<returns>A dictionary of the traits</returns>
</member>
<member name="M:Xunit.Sdk.MethodUtility.HasTimeout(Xunit.Sdk.IMethodInfo)">
<summary>
Determines whether a test method has a timeout.
</summary>
<param name="method">The method to be inspected</param>
<returns>True if the method has a timeout; false, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.MethodUtility.HasTraits(Xunit.Sdk.IMethodInfo)">
<summary>
Determines whether a test method has traits.
</summary>
<param name="method">The method to be inspected</param>
<returns>True if the method has traits; false, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.MethodUtility.IsSkip(Xunit.Sdk.IMethodInfo)">
<summary>
Determines whether a test method should be skipped.
</summary>
<param name="method">The method to be inspected</param>
<returns>True if the method should be skipped; false, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.MethodUtility.IsTest(Xunit.Sdk.IMethodInfo)">
<summary>
Determines whether a method is a test method. A test method must be decorated
with the <see cref="T:Xunit.FactAttribute"/> (or derived class) and must not be abstract.
</summary>
<param name="method">The method to be inspected</param>
<returns>True if the method is a test method; false, otherwise</returns>
</member>
<member name="T:Xunit.Sdk.Reflector">
<summary>
Wrapper to implement <see cref="T:Xunit.Sdk.IMethodInfo"/> and <see cref="T:Xunit.Sdk.ITypeInfo"/> using reflection.
</summary>
</member>
<member name="M:Xunit.Sdk.Reflector.Wrap(System.Attribute)">
<summary>
Converts an <see cref="T:System.Attribute"/> into an <see cref="T:Xunit.Sdk.IAttributeInfo"/> using reflection.
</summary>
<param name="attribute"></param>
<returns></returns>
</member>
<member name="M:Xunit.Sdk.Reflector.Wrap(System.Reflection.MethodInfo)">
<summary>
Converts a <see cref="T:System.Reflection.MethodInfo"/> into an <see cref="T:Xunit.Sdk.IMethodInfo"/> using reflection.
</summary>
<param name="method">The method to wrap</param>
<returns>The wrapper</returns>
</member>
<member name="M:Xunit.Sdk.Reflector.Wrap(System.Type)">
<summary>
Converts a <see cref="T:System.Type"/> into an <see cref="T:Xunit.Sdk.ITypeInfo"/> using reflection.
</summary>
<param name="type">The type to wrap</param>
<returns>The wrapper</returns>
</member>
<member name="T:Xunit.Sdk.TypeUtility">
<summary>
Utility class which inspects types for test information
</summary>
</member>
<member name="M:Xunit.Sdk.TypeUtility.ContainsTestMethods(Xunit.Sdk.ITypeInfo)">
<summary>
Determines if a type contains any test methods
</summary>
<param name="type">The type to be inspected</param>
<returns>True if the class contains any test methods; false, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.TypeUtility.GetRunWith(Xunit.Sdk.ITypeInfo)">
<summary>
Retrieves the type to run the test class with from the <see cref="T:Xunit.RunWithAttribute"/>, if present.
</summary>
<param name="type">The type to be inspected</param>
<returns>The type of the test class runner, if present; null, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.TypeUtility.GetTestMethods(Xunit.Sdk.ITypeInfo)">
<summary>
Retrieves a list of the test methods from the test class.
</summary>
<param name="type">The type to be inspected</param>
<returns>The test methods</returns>
</member>
<member name="M:Xunit.Sdk.TypeUtility.HasRunWith(Xunit.Sdk.ITypeInfo)">
<summary>
Determines if the test class has a <see cref="T:Xunit.RunWithAttribute"/> applied to it.
</summary>
<param name="type">The type to be inspected</param>
<returns>True if the test class has a run with attribute; false, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.TypeUtility.ImplementsITestClassCommand(Xunit.Sdk.ITypeInfo)">
<summary>
Determines if the type implements <see cref="T:Xunit.Sdk.ITestClassCommand"/>.
</summary>
<param name="type">The type to be inspected</param>
<returns>True if the type implements <see cref="T:Xunit.Sdk.ITestClassCommand"/>; false, otherwise</returns>
</member>
<member name="M:Xunit.Sdk.TypeUtility.IsAbstract(Xunit.Sdk.ITypeInfo)">
<summary>
Determines whether the specified type is abstract.
</summary>
<param name="type">The type.</param>
<returns>
<c>true</c> if the specified type is abstract; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Xunit.Sdk.TypeUtility.IsStatic(Xunit.Sdk.ITypeInfo)">
<summary>
Determines whether the specified type is static.
</summary>
<param name="type">The type.</param>
<returns>
<c>true</c> if the specified type is static; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Xunit.Sdk.TypeUtility.IsTestClass(Xunit.Sdk.ITypeInfo)">
<summary>
Determines if a class is a test class.
</summary>
<param name="type">The type to be inspected</param>
<returns>True if the type is a test class; false, otherwise</returns>
</member>
<member name="T:Xunit.FactAttribute">
<summary>
Attribute that is applied to a method to indicate that it is a fact that should be run
by the test runner. It can also be extended to support a customized definition of a
test method.
</summary>
</member>
<member name="M:Xunit.FactAttribute.CreateTestCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Creates instances of <see cref="T:Xunit.Sdk.ITestCommand"/> which represent individual intended
invocations of the test method.
</summary>
<param name="method">The method under test</param>
<returns>An enumerator through the desired test method invocations</returns>
</member>
<member name="M:Xunit.FactAttribute.EnumerateTestCommands(Xunit.Sdk.IMethodInfo)">
<summary>
Enumerates the test commands represented by this test method. Derived classes should
override this method to return instances of <see cref="T:Xunit.Sdk.ITestCommand"/>, one per execution
of a test method.
</summary>
<param name="method">The test method</param>
<returns>The test commands which will execute the test runs for the given method</returns>
</member>
<member name="P:Xunit.FactAttribute.DisplayName">
<summary>
Gets the name of the test to be used when the test is skipped. Defaults to
null, which will cause the fully qualified test name to be used.
</summary>
</member>
<member name="P:Xunit.FactAttribute.Name">
<summary>
Obsolete. Please use the <see cref="P:Xunit.FactAttribute.DisplayName"/> property instead.
</summary>
</member>
<member name="P:Xunit.FactAttribute.Skip">
<summary>
Marks the test so that it will not be run, and gets or sets the skip reason
</summary>
</member>
<member name="P:Xunit.FactAttribute.Timeout">
<summary>
Marks the test as failing if it does not finish running within the given time
period, in milliseconds; set to 0 or less to indicate the method has no timeout
</summary>
</member>
<member name="T:Xunit.Sdk.ThrowsException">
<summary>
Exception thrown when code unexpectedly fails to throw an exception.
</summary>
</member>
<member name="M:Xunit.Sdk.ThrowsException.#ctor(System.Type)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.ThrowsException"/> class. Call this constructor
when no exception was thrown.
</summary>
<param name="expectedType">The type of the exception that was expected</param>
</member>
<member name="M:Xunit.Sdk.ThrowsException.#ctor(System.Type,System.Exception)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.ThrowsException"/> class. Call this constructor
when an exception of the wrong type was thrown.
</summary>
<param name="expectedType">The type of the exception that was expected</param>
<param name="actual">The actual exception that was thrown</param>
</member>
<member name="M:Xunit.Sdk.ThrowsException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="M:Xunit.Sdk.ThrowsException.#ctor(System.Type,System.String,System.String,System.String)">
<summary>
THIS CONSTRUCTOR IS FOR UNIT TESTING PURPOSES ONLY.
</summary>
</member>
<member name="M:Xunit.Sdk.ThrowsException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="P:Xunit.Sdk.ThrowsException.StackTrace">
<summary>
Gets a string representation of the frames on the call stack at the time the current exception was thrown.
</summary>
<returns>A string that describes the contents of the call stack, with the most recent method call appearing first.</returns>
</member>
<member name="T:Xunit.Sdk.TimeoutException">
<summary>
Exception thrown when a test method exceeds the given timeout value
</summary>
</member>
<member name="M:Xunit.Sdk.TimeoutException.#ctor(System.Int64)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TimeoutException"/> class.
</summary>
<param name="timeout">The timeout value, in milliseconds</param>
</member>
<member name="M:Xunit.Sdk.TimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:Xunit.Sdk.TrueException">
<summary>
Exception thrown when a value is unexpectedly false.
</summary>
</member>
<member name="M:Xunit.Sdk.TrueException.#ctor(System.String)">
<summary>
Creates a new instance of the <see cref="T:Xunit.Sdk.TrueException"/> class.
</summary>
<param name="userMessage">The user message to be displayed, or null for the default message</param>
</member>
<member name="M:Xunit.Sdk.TrueException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
</members>
</doc>
Log in or click on link to see number of positives.
- log4net.dll (ce6ee4fdc783) - ## / 66
- nuget.exe (61704f7dbe23) - ## / 54
- Autofac.dll (bc7aee31320d) - ## / 72
- FakeItEasy.AutoMocker.dll (57a757e7bdcc) - ## / 56
- FakeItEasy.dll (0ec21f9d75b4) - ## / 56
- FubuCore.dll (bdcc12bb519f) - ## / 56
- PowerArgs.dll (c1162c6b510f) - ## / 56
- Xbehave.dll (8edf33efd93f) - ## / 56
- xunit.dll (a0477fbfcb70) - ## / 69
- xunit.extensions.dll (ab0521e225c3) - ## / 57
- Ionic.Zip.dll (37c70e73717f) - ## / 67
- FluentAssertions.Core.dll (0acf587e15d0) - ## / 53
- FluentAssertions.dll (e24b095db83f) - ## / 54
- FubuCsProjFile.dll (541afb3b2f73) - ## / 57
- ProjectNameSameAsSolution.zip (7a2590dff32d) - ## / 56
- SolutionInDirectoryProject.zip (987cb73143b1) - ## / 57
- crane.0.2.0.14.nupkg (abcc6985ff73) - ## / 57
- Crane.Core.dll (29e9067f5feb) - ## / 57
- Crane.Core.Tests.dll (5d41de9b6b52) - ## / 57
- crane.exe (f924af9cf125) - ## / 57
- Crane.Integration.Tests.dll (b1cea0131edf) - ## / 57
- Crane.Tests.Common.dll (21c651502b46) - ## / 57
In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).
Chocolatey Pro provides runtime protection from possible malware.
Add to Builder | Version | Downloads | Last Updated | Status |
---|---|---|---|---|
crane 0.2.0.15 | 1263 | Monday, June 29, 2015 | Approved | |
crane 0.2.0.14 | 345 | Tuesday, January 13, 2015 | Approved | |
crane 0.2.0.13 | 292 | Tuesday, January 13, 2015 | Approved | |
crane 0.0.0.10 | 409 | Friday, December 12, 2014 | Approved | |
crane 0.0.0.9 | 253 | Friday, December 12, 2014 | Approved |
Copyright ©2015 Edward Wilde & Kevin Holditch.
This package has no dependencies.
Ground Rules:
- This discussion is only about crane and the crane package. If you have feedback for Chocolatey, please contact the Google Group.
- This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
- The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
- Tell us what you love about the package or crane, or tell us what needs improvement.
- Share your experiences with the package, or extra configuration or gotchas that you've found.
- If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.