attività Error
Interrompe una compilazione e registra un errore in base a un'istruzione condizionale valutata.
Parametri
Nella tabella che segue vengono descritti i parametri dell'attività Error
.
Parametro | Descrizione |
---|---|
Code |
Parametro String facoltativo.Codice errore da associare all'errore. |
File |
Parametro String facoltativo.Il nome del file che contiene l'errore. Se non viene indicato alcun nome file, verrà usato il file contenente l'attività di errore. |
HelpKeyword |
Parametro String facoltativo.Parola chiave della Guida da associare all'errore. Solo per uso interno. |
HelpLink |
Parametro String facoltativo.Collegamento a altre informazioni sull'errore. |
Text |
Parametro String facoltativo.Testo dell'errore registrato da MSBuild se il Condition parametro restituisce true . |
Osservazioni:
L'attività Error
consente ai progetti MSBuild di emettere testo di errore per logger e arrestare l'esecuzione della compilazione.
Se il parametro Condition
restituisce true
, la compilazione viene interrotta e viene registrato un errore. Se non esiste un parametro Condition
, l'errore viene registrato e l'esecuzione della compilazione viene arrestata. Per altre informazioni sulla registrazione, vedere Recupero di log di compilazione.
Oltre ai parametri elencati sopra, questa attività eredita i parametri dalla classe TaskExtension, che a sua volta eredita dalla classe Task. Per un elenco di questi parametri aggiuntivi e le rispettive descrizioni, vedere TaskExtension Base Class.
HelpKeyword
viene usato da Visual Studio per supportare la funzionalità della Guida contestuale (F1). È possibile utilizzare HelpLink
per associare una pagina della Guida online a un messaggio di errore.
Esempio
L'esempio di codice seguente verifica che siano impostate tutte le proprietà richieste. In caso contrario, il progetto genera un evento di errore e registra il valore del parametro Text
sull'attività Error
.
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<Target Name="ValidateCommandLine">
<Error
Text=" The 0 property must be set on the command line."
Condition="'$(0)' == ''" />
<Error
Text="The FREEBUILD property must be set on the command line."
Condition="'$(FREEBUILD)' == ''" />
</Target>
...
</Project>