-
-
- 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 -
-
+
- CommonApplicationData - application data for all users. +
- ApplicationData - roaming application data for current user. +
- LocalApplicationData - non roaming application data for current user +
- UserProfile - Profile folder for current user +
- DesktopDirectory - Desktop-directory for current user +
- MyDocuments - My Documents-directory for current user +
- System - System directory +
+ -
+ -
+ -
+ -
+ -
+ -
+
+ [Target("MyFirst")]
+ public sealed class MyFirstTarget : AsyncTaskTarget
+ {
+ public MyFirstTarget()
+ {
+ this.Host = "localhost";
+ }
+
+ [RequiredParameter]
+ public Layout Host { get; set; }
+
+ protected override Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken token)
+ {
+ string logMessage = this.RenderLogEvent(this.Layout, logEvent);
+ string hostName = this.RenderLogEvent(this.Host, logEvent);
+ return SendTheMessageToRemoteHost(hostName, logMessage);
+ }
+
+ private async Task SendTheMessageToRemoteHost(string hostName, string message)
+ {
+ // To be implemented
+ }
+ }
+
@@ -21840,7 +21607,7 @@
- To set up the target in the configuration file, + 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: +
++ To set up the log target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
- To set up the target in the configuration file, + 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}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
-
-
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, + 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}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ - To set up the target in the configuration file, + 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}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
- To set up the target in the configuration file, + 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}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ KeepFileOpen = false gives the best compability, but slow performance and lead to file-locking issues with other applications.
- 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, + 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 buffered mail target in the configuration file, + To set up the buffered mail target in the configuration file, use the following syntax:
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message}
- - To set up the target in the configuration file, + 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}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
- To set up the target in the configuration file, + 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, + 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 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 + 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}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
-
-
- 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) +
- tcp://host:port - TCP (auto select IPv4/IPv6) +
- tcp4://host:port - force TCP/IPv4 +
- tcp6://host:port - force TCP/IPv6 +
- udp://host:port - UDP (auto select IPv4/IPv6) +
- udp4://host:port - force UDP/IPv4 +
- udp6://host:port - force UDP/IPv6
- http://host:port/pageName - HTTP using POST verb
- https://host:port/pageName - HTTPS using POST verb
+ - When connection-list is full and
+ - When message is too big and
+
- To set up the target in the configuration file, + 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}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
- To set up the target in the configuration file, + 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: -
-
+ [Target("MyFirst")]
+ public sealed class MyFirstTarget : TargetWithContext
+ {
+ public MyFirstTarget()
+ {
+ this.Host = "localhost";
+ }
+
+ [RequiredParameter]
+ public Layout Host { get; set; }
+
+ protected override void Write(LogEventInfo logEvent)
+ {
+ string logMessage = this.RenderLogEvent(this.Layout, logEvent);
+ string hostName = this.RenderLogEvent(this.Host, logEvent);
+ return SendTheMessageToRemoteHost(hostName, logMessage);
+ }
+
+ private void SendTheMessageToRemoteHost(string hostName, string message)
+ {
+ // To be implemented
+ }
+ }
+ ${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ - To set up the target in the configuration file, + 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}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
${longdate}|${level:uppercase=true}|${logger}|${message}
+ The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
- To set up the target in the configuration file, + 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:
- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing + Asynchronous target wrapper allows the logger code to execute more quickly, by queuing 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. @@ -27018,13 +26327,12 @@
- To set up the target in the configuration 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: + To set up the log target programmatically use code like this:
- To set up the target in the configuration 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: + To set up the log target programmatically use code like this:
${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, + 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 log target programmatically use code like this:
This example causes the messages not contains the string '1' to be ignored.
- To set up the target in the configuration 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: + To set up the log target programmatically use code like this:
- To set up the target in the configuration 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: + To set up the log target programmatically use code like this:
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, + 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 log target programmatically use code like this:
This example causes each log message to be repeated 3 times.
- To set up the target in the configuration 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: + To set up the log target programmatically use code like this:
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, + 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 log target programmatically use code like this:
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, + 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 log target programmatically use code like this:
This example causes the messages to be written to both file1.txt or file2.txt
- To set up the target in the configuration 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: + To set up the log target programmatically use code like this:
+ [CanBeNull] object Test() => null;
+
+ void UseTest() {
+ var p = Test();
+ var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
+ }
+
+ [NotNull] object Foo() {
+ return null; // Warning: Possible 'null' assignment
+ }
+
+ public void Foo([ItemNotNull]List<string> books)
+ {
+ foreach (var book in books) {
+ if (book != null) // Warning: Expression is always true
+ Console.WriteLine(book.ToUpper());
+ }
+ }
+
+ public void Foo([ItemCanBeNull]List<string> books)
+ {
+ foreach (var book in books)
+ {
+ // Warning: Possible 'System.NullReferenceException'
+ Console.WriteLine(book.ToUpper());
+ }
+ }
+
+ [StringFormatMethod("message")]
+ void ShowError(string message, params object[] args) { /* do something */ }
+
+ void Foo() {
+ ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
+ }
+
+ void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ }
+
+ void Foo() {
+ LogInfo("User created: {username}"); // Warning: Non-existing argument in format string
+ }
+
+ namespace TestNamespace
+ {
+ public class Constants
+ {
+ public static int INT_CONST = 1;
+ public const string STRING_CONST = "1";
+ }
+
+ public class Class1
+ {
+ [ValueProvider("TestNamespace.Constants")] public int myField;
+ public void Foo([ValueProvider("TestNamespace.Constants")] string str) { }
+
+ public void Test()
+ {
+ Foo(/*try completion here*/);//
+ myField = /*try completion here*/
+ }
+ }
+ }
+
+ void Foo([ValueRange(0, 100)] int value) {
+ if (value == -1) { // Warning: Expression is always 'false'
+ ...
+ }
+ }
+
+ void Foo([NonNegativeValue] int value) {
+ if (value == -1) { // Warning: Expression is always 'false'
+ ...
+ }
+ }
+
+ 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)
+
+ public class Foo : INotifyPropertyChanged {
+ public event PropertyChangedEventHandler PropertyChanged;
+
+ [NotifyPropertyChangedInvocator]
+ protected virtual void NotifyChanged(string propertyName) { ... }
+
+ 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
+ Value
+ You can use multiple
+
-
+
+ [ContractAnnotation("=> halt")] + public void TerminationMethod() +
+ + [ContractAnnotation("null <= param:null")] // reverse condition syntax + public string GetName(string surname) +
+ + [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("=> true, result: notnull; => false, result: null")] + public bool TryParse(string s, out Person result) +
+
+ [LocalizationRequiredAttribute(true)]
+ class Foo {
+ string str = "my string"; // Warning: Localizable string
+ }
+
+ [CannotApplyEqualityOperator]
+ class NoEquality { }
+
+ class UsesNoEquality {
+ void Test() {
+ var ca1 = new NoEquality();
+ var ca2 = new NoEquality();
+ if (ca1 != null) { // OK
+ bool condition = ca1 == ca2; // Warning
+ }
+ }
+ }
+
+ [BaseTypeRequired(typeof(IComponent)] // Specify requirement
+ class ComponentAttribute : Attribute { }
+
+ [Component] // ComponentAttribute requires implementing IComponent interface
+ class MyComponent : IComponent { }
+ + You can use
+ [UsedImplicitly]
+ public class TypeConverter {}
+
+ public class SummaryData
+ {
+ [UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)]
+ public SummaryData() {}
+ }
+
+ [UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)]
+ public interface IService {}
+
+ [Pure] int Multiply(int x, int y) => x * y;
+
+ void M() {
+ Multiply(123, 42); // Warning: Return value of pure method is not used
+ }
+ + Similarly to
[MustUseReturnValue("Use the return value to...")].
+
+ class Foo {
+ [ProvidesContext] IBarService _barService = ...;
+
+ void ProcessNode(INode node) {
+ DoSomething(node, node.GetGlobalServices().Bar);
+ // ^ Warning: use value of '_barService' field
+ }
+ }
+
+ [SourceTemplate]
+ public static void forEach<T>(this IEnumerable<T> xs) {
+ foreach (var x in xs) {
+ //$ $END$
+ }
+ }
+
+
+ [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")]
+ public static void forEach<T>(this IEnumerable<T> collection) {
+ foreach (var item in collection) {
+ //$ $END$
+ }
+ }
+
+ Applying the attribute on a template method parameter:
+
+ [SourceTemplate]
+ public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) {
+ /*$ var $x$Id = "$newguid$" + x.ToString();
+ x.DoSomething($x$Id); */
+ }
+
+
+ public class MyStringCollection : List<string>
+ {
+ [CollectionAccess(CollectionAccessType.Read)]
+ public string GetFirstString()
+ {
+ return this.ElementAt(0);
+ }
+ }
+ class Test
+ {
+ public void Foo()
+ {
+ // Warning: Contents of the collection is never updated
+ var col = new MyStringCollection();
+ string x = col.GetFirstString();
+ }
+ }
+
+ static void ThrowIfNull<T>([NoEnumeration] T v, string n) where T : class
+ {
+ // custom check for null but no enumeration
+ }
+
+ void Foo(IEnumerable<string> values)
+ {
+ ThrowIfNull(values, nameof(values));
+ var x = values.ToList(); // No warnings about multiple enumeration
+ }
+
+ void Foo([LanguageInjection(InjectedLanguage.CSS, Prefix = "body{", Suffix = "}")] string cssProps)
+ {
+ // cssProps should only contains a list of CSS properties
+ }
+