Метод 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
Квалификаторы: [в]
Указатель на название организации, которое отображается в диалоговом окне выполнения. Значение можно получить из переменной _SMSTSOrgName
среды.
pszTaskSequenceName
Тип данных: BSTR
Квалификаторы: [в]
Указатель на имя выполняемой в данный момент последовательности задач. Значение можно получить из переменной _SMSTSPackageName
среды.
pszCustomTitle
Тип данных: BSTR
Квалификаторы: [в]
Указатель на текст настраиваемого сообщения, заменяющего текст заголовка по умолчанию, отображаемый в диалоговом окне хода выполнения. Передайте пустую строку, если не отображается пользовательское сообщение. Значение можно получить из переменной _SMSTSCustomProgressDialogMessage
среды.
pszCurrentAction
Тип данных: BSTR
Квалификаторы: [в]
Указатель на имя текущего шага последовательности задач. Значение можно получить из переменной _SMSTSCurrentActionName
среды.
uStep
Тип данных: ULONG
Квалификаторы: [в]
Текущий номер шага последовательности задач. Значение можно получить из переменной SMSTSNextInstructionPointer
среды.
uMaxStep
Тип данных: ULONG
Квалификаторы: [в]
Общее количество шагов в последовательности задач. Значение можно получить из переменной _SMSTSInstructionTableSize
среды.
pszActionExecInfo
Тип данных: BSTR
Квалификаторы: [в]
Указатель на определяемые пользователем сведения о ходе выполнения, которые будут отображаться в диалоговом окне хода выполнения.
uActionExecStep
Тип данных: ULONG
Квалификаторы: [в]
Числовой шаг в пределах общего количества числовых шагов, на которых в настоящее время работает действие.
Используйте этот параметр, чтобы определить процент завершенного действия. Дополнительные сведения см. в разделе Примечания.
uActionExecMaxStep
Тип данных: ULONG
Квалификаторы: [в]
Общее количество числовых шагов, которые выполняет действие.
Используйте этот параметр, чтобы определить процент завершенного действия. Дополнительные сведения см. в разделе Примечания.
Возвращаемые значения
Код HRESULT
. Возможные значения включают, помимо прочего, следующее значение. Значения, относящиеся к этому методу, не HRESULT
возвращаются.
S_OK
Метод выполнен успешно.
Замечания
Единственная необходимая информация для этого метода — для pszActionExecInfo
параметров , uActionExecStep
и uActionExecMaxStep
. Другие параметры можно получить из переменных среды, на которые ссылается ссылка.
Вызов должен ShowActionProgress
указывать процент завершения действия с помощью uActionExecStep
параметров и uActionExecMaxStep
. Например, если uActionExecStep
указывает значение 2 и uActionExecMaxStep
значение 10, процент завершения действия составляет 20 процентов.