SampleObjectFactories.Insert(0, func) to provide an override and
- /// SampleObjectFactories.Add(func) to provide a fallback.
-
-
-
- @Html.DisplayForModel()
-
-
diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/ApiGroup.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/ApiGroup.cshtml.pp
deleted file mode 100644
index 80d36f41..00000000
--- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/ApiGroup.cshtml.pp
+++ /dev/null
@@ -1,41 +0,0 @@
-@using System.Web.Http
-@using System.Web.Http.Controllers
-@using System.Web.Http.Description
-@using $rootnamespace$.Areas.HelpPage
-@using $rootnamespace$.Areas.HelpPage.Models
-@model IGrouping
-
- - @Html.ActionLink("Help Page Home", "Index") -
-@Model.Key.ControllerName
-@if (!String.IsNullOrEmpty(controllerDocumentation)) -{ -@controllerDocumentation
-} -| API | Description |
|---|---|
| @api.HttpMethod.Method @api.RelativePath | -
- @if (api.Documentation != null)
- {
- @api.Documentation - } - else - { -No documentation available. - } - |
-
Possible enumeration values:
- -| Name | Value | Description |
|---|---|---|
| @value.Name | -
- @value.Value - |
-
- @value.Documentation - |
-
@description.HttpMethod.Method @description.RelativePath
-
-
\ No newline at end of file
diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/ImageSample.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/ImageSample.cshtml.pp
deleted file mode 100644
index 8463b836..00000000
--- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/ImageSample.cshtml.pp
+++ /dev/null
@@ -1,4 +0,0 @@
-@using $rootnamespace$.Areas.HelpPage
-@model ImageSample
-
-@description.Documentation
- -Request Information
- -URI Parameters
- @Html.DisplayFor(m => m.UriParameters, "Parameters") - -Body Parameters
- -@Model.RequestDocumentation
- - @if (Model.RequestModelDescription != null) - { - @Html.DisplayFor(m => m.RequestModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.RequestModelDescription }) - if (Model.RequestBodyParameters != null) - { - @Html.DisplayFor(m => m.RequestBodyParameters, "Parameters") - } - } - else - { -None.
- } - - @if (Model.SampleRequests.Count > 0) - { -Request Formats
- @Html.DisplayFor(m => m.SampleRequests, "Samples") - } - -Response Information
- -Resource Description
- -@description.ResponseDescription.Documentation
- - @if (Model.ResourceDescription != null) - { - @Html.DisplayFor(m => m.ResourceDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.ResourceDescription }) - if (Model.ResourceProperties != null) - { - @Html.DisplayFor(m => m.ResourceProperties, "Parameters") - } - } - else - { -None.
- } - - @if (Model.SampleResponses.Count > 0) - { -Response Formats
- @Html.DisplayFor(m => m.SampleResponses, "Samples") - } - -Sample not available.
-} \ No newline at end of file diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/KeyValuePairModelDescription.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/KeyValuePairModelDescription.cshtml.pp deleted file mode 100644 index fa988ec7..00000000 --- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/KeyValuePairModelDescription.cshtml.pp +++ /dev/null @@ -1,4 +0,0 @@ -@using $rootnamespace$.Areas.HelpPage.ModelDescriptions -@model KeyValuePairModelDescription -Pair of @Html.DisplayFor(m => Model.KeyModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.KeyModelDescription }) [key] -and @Html.DisplayFor(m => Model.ValueModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.ValueModelDescription }) [value] \ No newline at end of file diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/ModelDescriptionLink.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/ModelDescriptionLink.cshtml.pp deleted file mode 100644 index 3874d023..00000000 --- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/ModelDescriptionLink.cshtml.pp +++ /dev/null @@ -1,26 +0,0 @@ -@using $rootnamespace$.Areas.HelpPage.ModelDescriptions -@model Type -@{ - ModelDescription modelDescription = ViewBag.modelDescription; - if (modelDescription is ComplexTypeModelDescription || modelDescription is EnumTypeModelDescription) - { - if (Model == typeof(Object)) - { - @:Object - } - else - { - @Html.ActionLink(modelDescription.Name, "ResourceModel", "Help", new { modelName = modelDescription.Name }, null) - } - } - else if (modelDescription is CollectionModelDescription) - { - var collectionDescription = modelDescription as CollectionModelDescription; - var elementDescription = collectionDescription.ElementDescription; - @:Collection of @Html.DisplayFor(m => elementDescription.ModelType, "ModelDescriptionLink", new { modelDescription = elementDescription }) - } - else - { - @Html.DisplayFor(m => modelDescription) - } -} \ No newline at end of file diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/Parameters.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/Parameters.cshtml.pp deleted file mode 100644 index 9fbd8d6e..00000000 --- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/Parameters.cshtml.pp +++ /dev/null @@ -1,48 +0,0 @@ -@using System.Collections.Generic -@using System.Collections.ObjectModel -@using System.Web.Http.Description -@using System.Threading -@using $rootnamespace$.Areas.HelpPage.ModelDescriptions -@model IList| Name | Description | Type | Additional information |
|---|---|---|---|
| @parameter.Name | -
- @parameter.Documentation - |
- - @Html.DisplayFor(m => modelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = modelDescription }) - | -
- @if (parameter.Annotations.Count > 0)
- {
- foreach (var annotation in parameter.Annotations)
- {
- @annotation.Documentation - } - } - else - { -None. - } - |
-
None.
-} - diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/Samples.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/Samples.cshtml.pp deleted file mode 100644 index 69044cfd..00000000 --- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/Samples.cshtml.pp +++ /dev/null @@ -1,30 +0,0 @@ -@using System.Net.Http.Headers -@model Dictionary
- @foreach (var mediaType in mediaTypes)
- {
-
\ No newline at end of file
diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/SimpleTypeModelDescription.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/SimpleTypeModelDescription.cshtml.pp
deleted file mode 100644
index 1484f910..00000000
--- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/SimpleTypeModelDescription.cshtml.pp
+++ /dev/null
@@ -1,3 +0,0 @@
-@using $rootnamespace$.Areas.HelpPage.ModelDescriptions
-@model SimpleTypeModelDescription
-@Model.Documentation
\ No newline at end of file
diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/TextSample.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/TextSample.cshtml.pp
deleted file mode 100644
index 0fde4820..00000000
--- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/DisplayTemplates/TextSample.cshtml.pp
+++ /dev/null
@@ -1,6 +0,0 @@
-@using $rootnamespace$.Areas.HelpPage
-@model TextSample
-
-@mediaType
-
- Sample:
- @{
- var sample = samples[mediaType];
- if (sample == null)
- {
-
- }
-Sample not available.
- } - else - { - @Html.DisplayFor(s => sample); - } - } --@Model.Text -\ No newline at end of file diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/Index.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/Index.cshtml.pp deleted file mode 100644 index 97743014..00000000 --- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/Index.cshtml.pp +++ /dev/null @@ -1,38 +0,0 @@ -@using System.Web.Http -@using System.Web.Http.Controllers -@using System.Web.Http.Description -@using System.Collections.ObjectModel -@using $rootnamespace$.Areas.HelpPage.Models -@model Collection
-
-
-
- @ViewBag.Title
-
-
-
-
- @foreach (var group in apiGroups)
- {
- @Html.DisplayFor(m => group, "ApiGroup")
- }
-
-
diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/ResourceModel.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/ResourceModel.cshtml.pp
deleted file mode 100644
index 5f374cd7..00000000
--- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Help/ResourceModel.cshtml.pp
+++ /dev/null
@@ -1,19 +0,0 @@
-@using System.Web.Http
-@using $rootnamespace$.Areas.HelpPage.ModelDescriptions
-@model ModelDescription
-
-
-
-
- Introduction
-- Provide a general description of your APIs here. -
-
-
-
-
- @Html.DisplayFor(m => Model)
-
-
diff --git a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Shared/_Layout.cshtml.pp b/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Shared/_Layout.cshtml.pp
deleted file mode 100644
index 2f342c21..00000000
--- a/packages/Microsoft.AspNet.WebApi.HelpPage.5.2.3/Content/Areas/HelpPage/Views/Shared/_Layout.cshtml.pp
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-
-
-
-
-
- - @Html.ActionLink("Help Page Home", "Index") -
-@Model.Name
-@Model.Documentation
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- HKEY_LOCAL_MACHINE -
- HKLM -
- HKEY_CURRENT_USER -
- HKCU -
- HKEY_CLASSES_ROOT -
- HKEY_USERS -
- HKEY_CURRENT_CONFIG -
- HKEY_DYN_DATA -
- HKEY_PERFORMANCE_DATA -
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- | Condition | -Foreground Color | -Background Color | -
|---|---|---|
| level == LogLevel.Fatal | -Red | -NoChange | -
| level == LogLevel.Error | -Yellow | -NoChange | -
| level == LogLevel.Warn | -Magenta | -NoChange | -
| level == LogLevel.Info | -White | -NoChange | -
| level == LogLevel.Debug | -Gray | -NoChange | -
| level == LogLevel.Trace | -DarkGray | -NoChange | -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
System.Data.SqlClient -SQL Sever Client
- System.Data.SqlServerCe.3.5 -SQL Sever Compact 3.5
- System.Data.OracleClient -Oracle Client from Microsoft (deprecated in .NET Framework 4)
- Oracle.DataAccess.Client -ODP.NET provider from Oracle
- System.Data.SQLite -System.Data.SQLite driver for SQLite
- Npgsql -Npgsql driver for PostgreSQL
- MySql.Data.MySqlClient -MySQL Connector/Net
-
-
-
sqlserver ,mssql ,microsoft ormsde - SQL Server Data Provider
- oledb - OLEDB Data Provider
- odbc - ODBC Data Provider
-
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- HKEY_LOCAL_MACHINE -
- HKLM -
- HKEY_CURRENT_USER -
- HKCU -
- HKEY_CLASSES_ROOT -
- HKEY_USERS -
- HKEY_CURRENT_CONFIG -
- HKEY_DYN_DATA -
- HKEY_PERFORMANCE_DATA -
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- | Condition | -Foreground Color | -Background Color | -
|---|---|---|
| level == LogLevel.Fatal | -Red | -NoChange | -
| level == LogLevel.Error | -Yellow | -NoChange | -
| level == LogLevel.Warn | -Magenta | -NoChange | -
| level == LogLevel.Info | -White | -NoChange | -
| level == LogLevel.Debug | -Gray | -NoChange | -
| level == LogLevel.Trace | -DarkGray | -NoChange | -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
System.Data.SqlClient -SQL Sever Client
- System.Data.SqlServerCe.3.5 -SQL Sever Compact 3.5
- System.Data.OracleClient -Oracle Client from Microsoft (deprecated in .NET Framework 4)
- Oracle.DataAccess.Client -ODP.NET provider from Oracle
- System.Data.SQLite -System.Data.SQLite driver for SQLite
- Npgsql -Npgsql driver for PostgreSQL
- MySql.Data.MySqlClient -MySQL Connector/Net
-
-
-
sqlserver ,mssql ,microsoft ormsde - SQL Server Data Provider
- oledb - OLEDB Data Provider
- odbc - ODBC Data Provider
-
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- HKEY_LOCAL_MACHINE -
- HKLM -
- HKEY_CURRENT_USER -
- HKCU -
- HKEY_CLASSES_ROOT -
- HKEY_USERS -
- HKEY_CURRENT_CONFIG -
- HKEY_DYN_DATA -
- HKEY_PERFORMANCE_DATA -
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- | Condition | -Foreground Color | -Background Color | -
|---|---|---|
| level == LogLevel.Fatal | -Red | -NoChange | -
| level == LogLevel.Error | -Yellow | -NoChange | -
| level == LogLevel.Warn | -Magenta | -NoChange | -
| level == LogLevel.Info | -White | -NoChange | -
| level == LogLevel.Debug | -Gray | -NoChange | -
| level == LogLevel.Trace | -DarkGray | -NoChange | -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
System.Data.SqlClient -SQL Sever Client
- System.Data.SqlServerCe.3.5 -SQL Sever Compact 3.5
- System.Data.OracleClient -Oracle Client from Microsoft (deprecated in .NET Framework 4)
- Oracle.DataAccess.Client -ODP.NET provider from Oracle
- System.Data.SQLite -System.Data.SQLite driver for SQLite
- Npgsql -Npgsql driver for PostgreSQL
- MySql.Data.MySqlClient -MySQL Connector/Net
-
-
-
sqlserver ,mssql ,microsoft ormsde - SQL Server Data Provider
- oledb - OLEDB Data Provider
- odbc - ODBC Data Provider
-
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- HKEY_LOCAL_MACHINE -
- HKLM -
- HKEY_CURRENT_USER -
- HKCU -
- HKEY_CLASSES_ROOT -
- HKEY_USERS -
- HKEY_CURRENT_CONFIG -
- HKEY_DYN_DATA -
- HKEY_PERFORMANCE_DATA -
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- | Condition | -Foreground Color | -Background Color | -
|---|---|---|
| level == LogLevel.Fatal | -Red | -NoChange | -
| level == LogLevel.Error | -Yellow | -NoChange | -
| level == LogLevel.Warn | -Magenta | -NoChange | -
| level == LogLevel.Info | -White | -NoChange | -
| level == LogLevel.Debug | -Gray | -NoChange | -
| level == LogLevel.Trace | -DarkGray | -NoChange | -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
System.Data.SqlClient -SQL Sever Client
- System.Data.SqlServerCe.3.5 -SQL Sever Compact 3.5
- System.Data.OracleClient -Oracle Client from Microsoft (deprecated in .NET Framework 4)
- Oracle.DataAccess.Client -ODP.NET provider from Oracle
- System.Data.SQLite -System.Data.SQLite driver for SQLite
- Npgsql -Npgsql driver for PostgreSQL
- MySql.Data.MySqlClient -MySQL Connector/Net
-
-
-
sqlserver ,mssql ,microsoft ormsde - SQL Server Data Provider
- oledb - OLEDB Data Provider
- odbc - ODBC Data Provider
-
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- HKEY_LOCAL_MACHINE -
- HKLM -
- HKEY_CURRENT_USER -
- HKCU -
- HKEY_CLASSES_ROOT -
- HKEY_USERS -
- HKEY_CURRENT_CONFIG -
- HKEY_DYN_DATA -
- HKEY_PERFORMANCE_DATA -
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- | Condition | -Foreground Color | -Background Color | -
|---|---|---|
| level == LogLevel.Fatal | -Red | -NoChange | -
| level == LogLevel.Error | -Yellow | -NoChange | -
| level == LogLevel.Warn | -Magenta | -NoChange | -
| level == LogLevel.Info | -White | -NoChange | -
| level == LogLevel.Debug | -Gray | -NoChange | -
| level == LogLevel.Trace | -DarkGray | -NoChange | -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
System.Data.SqlClient -SQL Sever Client
- System.Data.SqlServerCe.3.5 -SQL Sever Compact 3.5
- System.Data.OracleClient -Oracle Client from Microsoft (deprecated in .NET Framework 4)
- Oracle.DataAccess.Client -ODP.NET provider from Oracle
- System.Data.SQLite -System.Data.SQLite driver for SQLite
- Npgsql -Npgsql driver for PostgreSQL
- MySql.Data.MySqlClient -MySQL Connector/Net
-
-
-
sqlserver ,mssql ,microsoft ormsde - SQL Server Data Provider
- oledb - OLEDB Data Provider
- odbc - ODBC Data Provider
-
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- HKEY_LOCAL_MACHINE -
- HKLM -
- HKEY_CURRENT_USER -
- HKCU -
- HKEY_CLASSES_ROOT -
- HKEY_USERS -
- HKEY_CURRENT_CONFIG -
- HKEY_DYN_DATA -
- HKEY_PERFORMANCE_DATA -
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- | Condition | -Foreground Color | -Background Color | -
|---|---|---|
| level == LogLevel.Fatal | -Red | -NoChange | -
| level == LogLevel.Error | -Yellow | -NoChange | -
| level == LogLevel.Warn | -Magenta | -NoChange | -
| level == LogLevel.Info | -White | -NoChange | -
| level == LogLevel.Debug | -Gray | -NoChange | -
| level == LogLevel.Trace | -DarkGray | -NoChange | -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
System.Data.SqlClient -SQL Sever Client
- System.Data.SqlServerCe.3.5 -SQL Sever Compact 3.5
- System.Data.OracleClient -Oracle Client from Microsoft (deprecated in .NET Framework 4)
- Oracle.DataAccess.Client -ODP.NET provider from Oracle
- System.Data.SQLite -System.Data.SQLite driver for SQLite
- Npgsql -Npgsql driver for PostgreSQL
- MySql.Data.MySqlClient -MySQL Connector/Net
-
-
-
sqlserver ,mssql ,microsoft ormsde - SQL Server Data Provider
- oledb - OLEDB Data Provider
- odbc - ODBC Data Provider
-
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -
-- To set up the buffered mail target in the configuration file, - use the following syntax: -
-- To set up the buffered mail target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- tags. -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-
- [CanBeNull] public object Test() { return null; }
- public void UseTest() {
- var p = Test();
- var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
- }
-
- [NotNull] public object Foo() {
- return null; // Warning: Possible 'null' assignment
- }
-
- [StringFormatMethod("message")]
- public void ShowError(string message, params object[] args) { /* do something */ }
- public void Foo() {
- ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
- }
-
- public void Foo(string param) {
- if (param == null)
- throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
- }
- -
-
NotifyChanged(string)
- NotifyChanged(params string[])
- NotifyChanged{T}(Expression{Func{T}})
- NotifyChanged{T,U}(Expression{Func{T,U}})
- SetProperty{T}(ref T, T, string)
-
- internal class Foo : INotifyPropertyChanged {
- public event PropertyChangedEventHandler PropertyChanged;
- [NotifyPropertyChangedInvocator]
- protected virtual void NotifyChanged(string propertyName) { ... }
-
- private string _name;
- public string Name {
- get { return _name; }
- set { _name = value; NotifyChanged("LastName"); /* Warning */ }
- }
- }
-
- Examples of generated notifications:
- -
-
NotifyChanged("Property")
- NotifyChanged(() => Property)
- NotifyChanged((VM x) => x.Property)
- SetProperty(ref myField, value, "Property")
-
Function Definition Table syntax:
--
-
- FDT ::= FDTRow [;FDTRow]* -
- FDTRow ::= Input => Output | Output <= Input -
- Input ::= ParameterName: Value [, Input]* -
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} -
- Value ::= true | false | null | notnull | canbenull -
- Using
-
- You can use multiple
-
-
-
- [ContractAnnotation("=> halt")] - public void TerminationMethod() -
- - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method -
- - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() -
- - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) -
- - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) -
-
- [LocalizationRequiredAttribute(true)]
- internal class Foo {
- private string str = "my string"; // Warning: Localizable string
- }
-
- [CannotApplyEqualityOperator]
- class NoEquality { }
- class UsesNoEquality {
- public void Test() {
- var ca1 = new NoEquality();
- var ca2 = new NoEquality();
- if (ca1 != null) { // OK
- bool condition = ca1 == ca2; // Warning
- }
- }
- }
-
- [BaseTypeRequired(typeof(IComponent)] // Specify requirement
- internal class ComponentAttribute : Attribute { }
- [Component] // ComponentAttribute requires implementing IComponent interface
- internal class MyComponent : IComponent { }
-
- [Pure] private int Multiply(int x, int y) { return x * y; }
- public void Foo() {
- const int a = 2, b = 2;
- Multiply(a, b); // Waring: Return value of pure method is not used
- }
-
- [ActionName("Foo")]
- public ActionResult Login(string returnUrl) {
- ViewBag.ReturnUrl = Url.Action("Foo"); // OK
- return RedirectToAction("Bar"); // Error: Cannot resolve action
- }
- -
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- .
-
-
- ApplicationData - roaming application data for current user. -
- CommonApplicationData - application data for all users. -
- MyDocuments - My Documents -
- DesktopDirectory - Desktop directory -
- LocalApplicationData - non roaming application data -
- Personal - user profile directory -
- System - System directory -
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -
-
- - NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -
-- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- -
-
- tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0) -
- tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0) -
- tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0) -
- udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0) -
- udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0) -
- udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0) -
- http://host:port/pageName - HTTP using POST verb -
- https://host:port/pageName - HTTPS using POST verb -
${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- ${basedir}/${level}.log
- All - a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ... - and so on. -
- Caution: Enabling this option can considerably slow down your file
- logging in multi-process scenarios. If only one process is going to
- be writing to the file, consider setting
- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-- To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, - use the following syntax: -
-- This assumes just one target and a single rule. More configuration - options are described here. -
-- To set up the log target programmatically use code like this: -
-The example web service that works with this example is shown below
-- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -
-- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -
-
-
- ... your targets go here ...
-
- ]]>
- - To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-${longdate}|${level:uppercase=true}|${logger}|${message}
- ${longdate}|${level:uppercase=true}|${logger}|${message}
- This example causes the messages to be written to server1, - and if it fails, messages go to server2.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages not contains the string '1' to be ignored.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each log message to be repeated 3 times.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-This example causes the messages to be written to both file1.txt or file2.txt -
-- To set up the target in the configuration file, - use the following syntax: -
-- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -
-