IProgressUI::ShowErrorDialog 方法
在 Configuration Manager 中ShowErrorDialog
,方法在对话框中显示可自定义的错误信息。
语法
[IDL]
HRESULT ShowErrorDialog(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszErrorMessage,
ULONG uErrorCode,
ULONG uTimeoutInSeconds,
ULONG uWillReboot,
BSTR pszTaskSequenceStepName
);
参数
pszOrgName
数据类型BSTR
限定符:[in]
指向进度对话框中显示的组织名称的指针。 可以从环境变量中 _SMSTSOrgName
检索值。
pszTaskSequenceName
数据类型BSTR
限定符:[in]
指向当前正在运行的任务序列名称的指针。 可以从环境变量中 _SMSTSPackageName
检索值。
pszCustomTitle
数据类型BSTR
限定符:[in]
指向自定义消息文本的指针,该文本替换错误对话框中显示的默认标题文本。 如果没有要显示的自定义消息,则传递空字符串。 可以从环境变量获取 _SMSTSCustomProgressDialogMessage
值。
pszErrorMessage
数据类型BSTR
限定符:[in]
指向错误对话框中显示的自定义消息文本的指针。 如果没有要显示的自定义消息,则传递空字符串。 默认文本包括 、 pszTaskSequenceStepName
和 uErrorCode
中的pszTaskSequenceName
文本。 它根据指定的值而更改。
uErrorCode
数据类型ULONG
限定符:[in]
指向最后一个失败步骤的返回代码的指针。 可以从环境变量获取 _SMSTSLastActionRetCode
值。 如果未指定 的pszErrorMessage
自定义文本,uErrorCode
将以Microsoft系统错误代码格式显示。
uTimeoutInSeconds
数据类型ULONG
限定符:[in]
指向关闭前显示对话框的秒数的值的指针。 可以从环境变量中获取 SMSTSErrorDialogTimeout
值,该变量默认未在任务序列中配置。 如果为 uTimeoutInSeconds
指定了空字符串,但 SMSTSErrorDialogTimeout
未指定,则将使用默认值 900 秒。
bWillReboot
数据类型ULONG
限定符:[in]
Boolean 值。 它指示任务序列在对话框关闭或超时过期时是重新启动计算机。
pszTaskSequenceStepName
数据类型BSTR
限定符:[in]
指向将在默认 pszErrorMessage
文本中显示的步骤名称文本的指针。 可以从环境变量中 _SMSTSLastActionName
检索值。
返回值
代码 HRESULT
。 可能的值包括但不限于以下值。 没有 HRESULT
返回特定于此方法的值。
S_OK
方法成功。