IProgressUI::ShowActionProgress 方法
在 Configuration Manager 中ShowActionProgress
,方法在自定义操作正在运行时在对话框中显示自定义操作进度信息。
语法
[IDL]
HRESULT ShowActionProgress(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszCurrentAction,
ULONG uStep,
ULONG uMaxStep,
BSTR pszActionExecInfo,
ULONG uActionExecStep,
ULONG uActionExecMaxStep
);
参数
pszOrgName
数据类型BSTR
限定符:[in]
指向进度对话框中显示的组织名称的指针。 可以从环境变量中 _SMSTSOrgName
检索值。
pszTaskSequenceName
数据类型BSTR
限定符:[in]
指向当前正在运行的任务序列名称的指针。 可以从环境变量中 _SMSTSPackageName
检索值。
pszCustomTitle
数据类型BSTR
限定符:[in]
指向自定义邮件文本的指针,该文本替换进度对话框中显示的默认标题文本。 如果没有要显示的自定义消息,则传递空字符串。 可以从环境变量获取 _SMSTSCustomProgressDialogMessage
值。
pszCurrentAction
数据类型BSTR
限定符:[in]
指向当前任务序列步骤名称的指针。 可以从环境变量获取 _SMSTSCurrentActionName
值。
uStep
数据类型ULONG
限定符:[in]
当前任务序列步骤号。 可以从环境变量获取 SMSTSNextInstructionPointer
值。
uMaxStep
数据类型ULONG
限定符:[in]
任务序列中的步骤总数。 可以从环境变量获取 _SMSTSInstructionTableSize
值。
pszActionExecInfo
数据类型BSTR
限定符:[in]
指向要显示在进度对话框中的用户定义、特定于操作的进度信息的指针。
uActionExecStep
数据类型ULONG
限定符:[in]
操作当前正在执行的数字步骤总数中的数字步骤。
使用此参数可以确定到目前为止已完成的操作的百分比。 有关详细信息,请参阅备注。
uActionExecMaxStep
数据类型ULONG
限定符:[in]
操作所执行的数字步骤总数。
使用此参数可以确定到目前为止已完成的操作的百分比。 有关详细信息,请参阅备注。
返回值
代码 HRESULT
。 可能的值包括但不限于以下值。 没有 HRESULT
返回特定于此方法的值。
S_OK
方法成功。
备注
此方法的唯一必需信息是 pszActionExecInfo
、 uActionExecStep
和 uActionExecMaxStep
参数。 可以从引用的环境变量获取其他参数。
对 的 ShowActionProgress
调用应使用 uActionExecStep
和 uActionExecMaxStep
参数指定操作完成百分比。 例如,如果 uActionExecStep
指定值 2 并 uActionExecMaxStep
指定值 10,则操作完成百分比为 20%。