该类定义了表示Revit文档中失败消息的对象。该对象通常由Revit API中的许多操作返回,以指示该操作是否成功完成,以及失败的原因。
该类提供了以下构造函数来创建新的FailureMessage对象:
FailureMessage(FailureDefinitionId, FailureSeverity, string)
:使用指定的FailureDefinitionId,FailureSeverity和消息字符串创建新的FailureMessage对象。Description
:获取或设置该对象的描述。FailureDefinitionId
:获取该对象的FailureDefinitionId。Severity
:获取该对象的FailureSeverity。ToString()
:返回该对象的字符串表示形式。以下示例演示如何创建并将FailureMessage对象添加到FaiureMessages集合中:
// 使用FailureDefinitionId、FailureSeverity和消息创建新的FailureMessage对象
FailureMessage failureMessage = new FailureMessage(FailureDefinitionId, FailureSeverity.Warning, "这是警告消息!");
// 将FailureMessage对象添加到集合中
FailureMesaageAccessor fma = new FailureMesaageAccessor();
fma.AddFailureMessage(document, failureMessage);
当Revit API操作无法完成时,FailureMessage对象可用于指示失败的原因。开发人员应该了解FailureSeverity属性的值,并根据要执行的任务来处理错误。例如,如果FailureSeverity是Error,则可能需要撤销该操作并提示用户更正错误。