|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.Diagnostics.CodeAnalysis;
#nullable disable
namespace Microsoft.Build.Framework
{
/// <summary>
/// Arguments for critical message events. These always have High importance.
/// </summary>
// WARNING: marking a type [Serializable] without implementing
// ISerializable imposes a serialization contract -- it is a
// promise to never change the type's fields i.e. the type is
// immutable; adding new fields in the next version of the type
// without following certain special FX guidelines, can break both
// forward and backward compatibility
[Serializable]
public class CriticalBuildMessageEventArgs : BuildMessageEventArgs
{
/// <summary>
/// This constructor allows all event data to be initialized
/// </summary>
/// <param name="subcategory">event subcategory</param>
/// <param name="code">event code</param>
/// <param name="file">file associated with the event</param>
/// <param name="lineNumber">line number (0 if not applicable)</param>
/// <param name="columnNumber">column number (0 if not applicable)</param>
/// <param name="endLineNumber">end line number (0 if not applicable)</param>
/// <param name="endColumnNumber">end column number (0 if not applicable)</param>
/// <param name="message">text message</param>
/// <param name="helpKeyword">help keyword </param>
/// <param name="senderName">name of event sender</param>
public CriticalBuildMessageEventArgs(
string subcategory,
string code,
string file,
int lineNumber,
int columnNumber,
int endLineNumber,
int endColumnNumber,
string message,
string helpKeyword,
string senderName)
: this(subcategory, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName, DateTime.UtcNow)
{
// do nothing
}
/// <summary>
/// This constructor allows timestamp to be set
/// </summary>
/// <param name="subcategory">event subcategory</param>
/// <param name="code">event code</param>
/// <param name="file">file associated with the event</param>
/// <param name="lineNumber">line number (0 if not applicable)</param>
/// <param name="columnNumber">column number (0 if not applicable)</param>
/// <param name="endLineNumber">end line number (0 if not applicable)</param>
/// <param name="endColumnNumber">end column number (0 if not applicable)</param>
/// <param name="message">text message</param>
/// <param name="helpKeyword">help keyword </param>
/// <param name="senderName">name of event sender</param>
/// <param name="eventTimestamp">custom timestamp for the event</param>
public CriticalBuildMessageEventArgs(
string subcategory,
string code,
string file,
int lineNumber,
int columnNumber,
int endLineNumber,
int endColumnNumber,
string message,
string helpKeyword,
string senderName,
DateTime eventTimestamp)
: this(subcategory, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName, eventTimestamp, null)
{
// do nothing
}
/// <summary>
/// This constructor allows timestamp to be set
/// </summary>
/// <param name="subcategory">event subcategory</param>
/// <param name="code">event code</param>
/// <param name="file">file associated with the event</param>
/// <param name="lineNumber">line number (0 if not applicable)</param>
/// <param name="columnNumber">column number (0 if not applicable)</param>
/// <param name="endLineNumber">end line number (0 if not applicable)</param>
/// <param name="endColumnNumber">end column number (0 if not applicable)</param>
/// <param name="message">text message</param>
/// <param name="helpKeyword">help keyword </param>
/// <param name="senderName">name of event sender</param>
/// <param name="eventTimestamp">custom timestamp for the event</param>
/// <param name="messageArgs">message arguments</param>
public CriticalBuildMessageEventArgs(
string subcategory,
string code,
string file,
int lineNumber,
int columnNumber,
int endLineNumber,
int endColumnNumber,
[StringSyntax(StringSyntaxAttribute.CompositeFormat)] string message,
string helpKeyword,
string senderName,
DateTime eventTimestamp,
params object[] messageArgs)
//// Force importance to High.
: base(subcategory, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName, MessageImportance.High, eventTimestamp, messageArgs)
{
// do nothing
}
/// <summary>
/// Default constructor
/// </summary>
protected CriticalBuildMessageEventArgs()
: base()
{
// do nothing
}
}
}
|