Error 工作

  • 發行項

停止組建，並根據評估的條件陳述式來記錄錯誤。

參數

下表說明 Error 工作的參數。

參數 描述
Code 選擇性的 String 參數。

與錯誤相關聯的錯誤碼。
File 選擇性的 String 參數。

包含錯誤的檔案名稱。 如果沒有提供檔案名稱，將會使用包含 Error 工作的檔案。
HelpKeyword 選擇性的 String 參數。

要與錯誤相關聯的 Help 關鍵字。 僅限內部使用。
HelpLink 選擇性的 String 參數。

有關錯誤詳細資訊的連結。
Text 選擇性的 String 參數。

MSBuild 在 Condition 參數評估為 true 時所記錄的錯誤文字。

備註

Error 工作可讓 MSBuild 專案將錯誤文字發送到記錄器，並停止組建執行。

如果 Condition 參數評估為 true，即會停止組建，並記錄錯誤。 如果 Condition 參數不存在，則會記錄錯誤，並停止組建執行。 如需記錄的詳細資訊，請參閱取得建置記錄檔。

除了上述所列的參數，此項工作還會繼承 TaskExtension 類別中的參數，而該類別本身又繼承 Task 類別。 如需這些其他參數的清單及其描述，請參閱 TaskExtension 基底類別。

Visual Studio 會使用 HelpKeyword 來支援內容相關說明功能 (F1)。 您可以使用 HelpLink 將線上說明頁面與錯誤訊息產生關聯。

範例

下列程式碼範例會確認已設定所有必要的屬性。 若未設定，專案就會引發錯誤事件，並記錄 Error 工作的 Text 參數值。

<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>

另請參閱