TaskLoggingHelper.LogMessage Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Logs a message with the specified string.
Overloads
| LogMessage(String, Object[]) |
Logs a message using the specified string. Thread safe. |
| LogMessage(MessageImportance, String, Object[]) |
Logs a message of the given importance using the specified string. Thread safe. |
| LogMessage(String, String, String, String, Int32, Int32, Int32, Int32, MessageImportance, String, Object[]) |
Logs a message using the specified string and other message details. Thread safe. |
Examples
The following example shows the code for a task that creates one or more directories.
using System;
using System.IO;
using System.Security;
using System.Collections;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
namespace Microsoft.Build.Tasks
{
/*
* Class: MakeDir
*
* An MSBuild task that creates one or more directories.
*
*/
public class MakeDir : Task
{
// The Required attribute indicates the following to MSBuild:
// - if the parameter is a scalar type, and it is not supplied, fail the build immediately
// - if the parameter is an array type, and it is not supplied, pass in an empty array
// In this case the parameter is an array type, so if a project fails to pass in a value for the
// Directories parameter, the task will get invoked, but this implementation will do nothing,
// because the array will be empty.
[Required]
// Directories to create.
public ITaskItem[] Directories
{
get
{
return directories;
}
set
{
directories = value;
}
}
// The Output attribute indicates to MSBuild that the value of this property can be gathered after the
// task has returned from Execute(), if the project has an <Output> tag under this task's element for
// this property.
[Output]
// A project may need the subset of the inputs that were actually created, so make that available here.
public ITaskItem[] DirectoriesCreated
{
get
{
return directoriesCreated;
}
}
private ITaskItem[] directories;
private ITaskItem[] directoriesCreated;
/// <summary>
/// Execute is part of the Microsoft.Build.Framework.ITask interface.
/// When it's called, any input parameters have already been set on the task's properties.
/// It returns true or false to indicate success or failure.
/// </summary>
public override bool Execute()
{
ArrayList items = new ArrayList();
foreach (ITaskItem directory in Directories)
{
// ItemSpec holds the filename or path of an Item
if (directory.ItemSpec.Length > 0)
{
try
{
// Only log a message if we actually need to create the folder
if (!Directory.Exists(directory.ItemSpec))
{
Log.LogMessage(MessageImportance.Normal, "Creating directory " + directory.ItemSpec);
Directory.CreateDirectory(directory.ItemSpec);
}
// Add to the list of created directories
items.Add(directory);
}
// If a directory fails to get created, log an error, but proceed with the remaining
// directories.
catch (Exception ex)
{
if (ex is IOException
|| ex is UnauthorizedAccessException
|| ex is PathTooLongException
|| ex is DirectoryNotFoundException
|| ex is SecurityException)
{
Log.LogError("Error trying to create directory " + directory.ItemSpec + ". " + ex.Message);
}
else
{
throw;
}
}
}
}
// Populate the "DirectoriesCreated" output items.
directoriesCreated = (ITaskItem[])items.ToArray(typeof(ITaskItem));
// Log.HasLoggedErrors is true if the task logged any errors -- even if they were logged
// from a task's constructor or property setter. As long as this task is written to always log an error
// when it fails, we can reliably return HasLoggedErrors.
return !Log.HasLoggedErrors;
}
}
}
LogMessage(String, Object[])
- Source:
- TaskLoggingHelper.cs
Logs a message using the specified string. Thread safe.
public:
void LogMessage(System::String ^ message, ... cli::array <System::Object ^> ^ messageArgs);public void LogMessage (string message, params object[] messageArgs);[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]
public void LogMessage (string message, params object[] messageArgs);member this.LogMessage : string * obj[] -> unit[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]
member this.LogMessage : string * obj[] -> unitPublic Sub LogMessage (message As String, ParamArray messageArgs As Object())Parameters
- message
- String
The message string.
- messageArgs
- Object[]
Optional arguments for formatting the message string.
- Attributes
Exceptions
Thrown when message is null.
Examples
The following example shows the code for a task that creates one or more directories.
using System;
using System.IO;
using System.Security;
using System.Collections;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
namespace Microsoft.Build.Tasks
{
/*
* Class: MakeDir
*
* An MSBuild task that creates one or more directories.
*
*/
public class MakeDir : Task
{
// The Required attribute indicates the following to MSBuild:
// - if the parameter is a scalar type, and it is not supplied, fail the build immediately
// - if the parameter is an array type, and it is not supplied, pass in an empty array
// In this case the parameter is an array type, so if a project fails to pass in a value for the
// Directories parameter, the task will get invoked, but this implementation will do nothing,
// because the array will be empty.
[Required]
// Directories to create.
public ITaskItem[] Directories
{
get
{
return directories;
}
set
{
directories = value;
}
}
// The Output attribute indicates to MSBuild that the value of this property can be gathered after the
// task has returned from Execute(), if the project has an <Output> tag under this task's element for
// this property.
[Output]
// A project may need the subset of the inputs that were actually created, so make that available here.
public ITaskItem[] DirectoriesCreated
{
get
{
return directoriesCreated;
}
}
private ITaskItem[] directories;
private ITaskItem[] directoriesCreated;
/// <summary>
/// Execute is part of the Microsoft.Build.Framework.ITask interface.
/// When it's called, any input parameters have already been set on the task's properties.
/// It returns true or false to indicate success or failure.
/// </summary>
public override bool Execute()
{
ArrayList items = new ArrayList();
foreach (ITaskItem directory in Directories)
{
// ItemSpec holds the filename or path of an Item
if (directory.ItemSpec.Length > 0)
{
try
{
// Only log a message if we actually need to create the folder
if (!Directory.Exists(directory.ItemSpec))
{
Log.LogMessage(MessageImportance.Normal, "Creating directory " + directory.ItemSpec);
Directory.CreateDirectory(directory.ItemSpec);
}
// Add to the list of created directories
items.Add(directory);
}
// If a directory fails to get created, log an error, but proceed with the remaining
// directories.
catch (Exception ex)
{
if (ex is IOException
|| ex is UnauthorizedAccessException
|| ex is PathTooLongException
|| ex is DirectoryNotFoundException
|| ex is SecurityException)
{
Log.LogError("Error trying to create directory " + directory.ItemSpec + ". " + ex.Message);
}
else
{
throw;
}
}
}
}
// Populate the "DirectoriesCreated" output items.
directoriesCreated = (ITaskItem[])items.ToArray(typeof(ITaskItem));
// Log.HasLoggedErrors is true if the task logged any errors -- even if they were logged
// from a task's constructor or property setter. As long as this task is written to always log an error
// when it fails, we can reliably return HasLoggedErrors.
return !Log.HasLoggedErrors;
}
}
}
Remarks
The MessageImportance value of a message is Normal by default.
Applies to
LogMessage(MessageImportance, String, Object[])
- Source:
- TaskLoggingHelper.cs
Logs a message of the given importance using the specified string. Thread safe.
public:
void LogMessage(Microsoft::Build::Framework::MessageImportance importance, System::String ^ message, ... cli::array <System::Object ^> ^ messageArgs);public void LogMessage (Microsoft.Build.Framework.MessageImportance importance, string message, params object[] messageArgs);member this.LogMessage : Microsoft.Build.Framework.MessageImportance * string * obj[] -> unitPublic Sub LogMessage (importance As MessageImportance, message As String, ParamArray messageArgs As Object())Parameters
- importance
- MessageImportance
The importance level of the message.
- message
- String
The message string.
- messageArgs
- Object[]
Optional arguments for formatting the message string.
Exceptions
Thrown when message is null.
Remarks
Take care to order the parameters correctly or the other overload will be called inadvertently.
Applies to
LogMessage(String, String, String, String, Int32, Int32, Int32, Int32, MessageImportance, String, Object[])
- Source:
- TaskLoggingHelper.cs
Logs a message using the specified string and other message details. Thread safe.
public:
void LogMessage(System::String ^ subcategory, System::String ^ code, System::String ^ helpKeyword, System::String ^ file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, Microsoft::Build::Framework::MessageImportance importance, System::String ^ message, ... cli::array <System::Object ^> ^ messageArgs);public void LogMessage (string subcategory, string code, string helpKeyword, string file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, Microsoft.Build.Framework.MessageImportance importance, string message, params object[] messageArgs);member this.LogMessage : string * string * string * string * int * int * int * int * Microsoft.Build.Framework.MessageImportance * string * obj[] -> unitPublic Sub LogMessage (subcategory As String, code As String, helpKeyword As String, file As String, lineNumber As Integer, columnNumber As Integer, endLineNumber As Integer, endColumnNumber As Integer, importance As MessageImportance, message As String, ParamArray messageArgs As Object())Parameters
- subcategory
- String
Description of the warning type (can be null).
- code
- String
Message code (can be null)
- helpKeyword
- String
The help keyword for the host IDE (can be null).
- file
- String
The path to the file causing the message (can be null).
- lineNumber
- Int32
The line in the file causing the message (set to zero if not available).
- columnNumber
- Int32
The column in the file causing the message (set to zero if not available).
- endLineNumber
- Int32
The last line of a range of lines in the file causing the message (set to zero if not available).
- endColumnNumber
- Int32
The last column of a range of columns in the file causing the message (set to zero if not available).
- importance
- MessageImportance
Importance of the message.
- message
- String
The message string.
- messageArgs
- Object[]
Optional arguments for formatting the message string.
Exceptions
Thrown when message is null.