Метод 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
Квалификаторы: [в]
Указатель на название организации, которое отображается в диалоговом окне выполнения. Значение можно получить из переменной _SMSTSOrgName
среды.
pszTaskSequenceName
Тип данных: BSTR
Квалификаторы: [в]
Указатель на имя выполняемой в данный момент последовательности задач. Значение можно получить из переменной _SMSTSPackageName
среды.
pszCustomTitle
Тип данных: BSTR
Квалификаторы: [в]
Указатель на текст настраиваемого сообщения, заменяющего текст заголовка по умолчанию, отображаемый в диалоговом окне ошибки. Передайте пустую строку, если не отображается пользовательское сообщение. Значение можно получить из переменной _SMSTSCustomProgressDialogMessage
среды.
pszErrorMessage
Тип данных: BSTR
Квалификаторы: [в]
Указатель на текст настраиваемого сообщения, отображаемого в диалоговом окне ошибки. Передайте пустую строку, если не отображается пользовательское сообщение. Текст по умолчанию включает текст из pszTaskSequenceName
, pszTaskSequenceStepName
и uErrorCode
. Он меняется в зависимости от заданных значений.
uErrorCode
Тип данных: ULONG
Квалификаторы: [в]
Указатель на код возврата последнего шага, на который произошел сбой. Значение можно получить из переменной _SMSTSLastActionRetCode
среды. Если пользовательский текст для pszErrorMessage
не указан, uErrorCode
будет отображаться в формате Майкрософт системной ошибки.
uTimeoutInSeconds
Тип данных: ULONG
Квалификаторы: [в]
Указатель на значение в секундах, в течение которых диалоговое окно отображается перед закрытием. Значение можно получить из переменной SMSTSErrorDialogTimeout
среды, которая по умолчанию не настроена в последовательности задач. Если указана пустая строка для uTimeoutInSeconds
и SMSTSErrorDialogTimeout
не указана, будет использоваться значение по умолчанию 900 секунд.
bWillReboot
Тип данных: ULONG
Квалификаторы: [в]
Логическое значение. Он указывает, будет ли последовательность задач перезагружать компьютер при закрытии диалогового окна или истечении времени ожидания.
pszTaskSequenceStepName
Тип данных: BSTR
Квалификаторы: [в]
Указатель на текст для имени шага, которое будет отображаться в тексте по умолчанию pszErrorMessage
. Значение можно получить из переменной _SMSTSLastActionName
среды.
Возвращаемые значения
Код HRESULT
. Возможные значения включают, помимо прочего, следующее значение. Значения, относящиеся к этому методу, не HRESULT
возвращаются.
S_OK
Метод выполнен успешно.