Share via


TextTransformation.Error Method

Creates a new error to store information about errors that occur during the text template transformation process.

Namespace:  Microsoft.VisualStudio.TextTemplating
Assembly:  Microsoft.VisualStudio.TextTemplating.11.0 (in Microsoft.VisualStudio.TextTemplating.11.0.dll)

Syntax

'Declaration
Public Sub Error ( _
    message As String _
)
public void Error(
    string message
)
public:
void Error(
    String^ message
)
member Error : 
        message:string -> unit
public function Error(
    message : String
)

Parameters

  • message
    Type: String

    A message that describes the error.

Remarks

Adds the error to the collection of Errors for the text template transformation process. Sets the line number of the error to -1, and the column number of the error to -1 by default.

Examples

The following code example demonstrates calling the Error method from a text template. Paste this code into any text template file and run the text template transformation to see the results. The error will appear in the Error List.

<#
    string firstName = null;

    if(string.IsNullOrEmpty(firstName))
    {
        //raise an error, this will appear in the error list
        Error("I have no name.");
    }
#> 
<#
    Dim firstName as string = ""

    If string.IsNullOrEmpty(firstName) Then

        'raise an error, this will appear in the error list
        Me.Error("I have no name.")
    End If
#>

.NET Framework Security

See Also

Reference

TextTransformation Class

Microsoft.VisualStudio.TextTemplating Namespace

Errors

Other Resources

How to: Generate Errors and Warnings from Text Templates