Método IProgressUI::ShowErrorDialog
Em Configuration Manager, o ShowErrorDialog
método exibe informações de erro personalizáveis em uma caixa de diálogo.
Sintaxe
[IDL]
HRESULT ShowErrorDialog(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszErrorMessage,
ULONG uErrorCode,
ULONG uTimeoutInSeconds,
ULONG uWillReboot,
BSTR pszTaskSequenceStepName
);
Parâmetros
pszOrgName
Tipo de dados: BSTR
Qualificadores: [in]
Ponteiro para o nome da organização que é mostrado na caixa de diálogo progresso. O valor pode ser recuperado da _SMSTSOrgName
variável de ambiente.
pszTaskSequenceName
Tipo de dados: BSTR
Qualificadores: [in]
Ponteiro para o nome da sequência de tarefas que está em execução no momento. O valor pode ser recuperado da _SMSTSPackageName
variável de ambiente.
pszCustomTitle
Tipo de dados: BSTR
Qualificadores: [in]
Ponteiro para o texto de uma mensagem personalizada que substitui o texto de título padrão exibido na caixa de diálogo de erro. Passe uma cadeia de caracteres vazia se não houver nenhuma mensagem personalizada a ser exibida. O valor pode ser obtido da _SMSTSCustomProgressDialogMessage
variável de ambiente.
pszErrorMessage
Tipo de dados: BSTR
Qualificadores: [in]
Ponteiro para o texto da mensagem personalizada exibida na caixa de diálogo de erro. Passe uma cadeia de caracteres vazia se não houver nenhuma mensagem personalizada a ser exibida. O texto padrão inclui o texto de pszTaskSequenceName
, pszTaskSequenceStepName
e uErrorCode
. Ele é alterado dependendo de quais valores são especificados.
uErrorCode
Tipo de dados: ULONG
Qualificadores: [in]
Ponteiro para o código de retorno da última etapa que falhou. O valor pode ser obtido da _SMSTSLastActionRetCode
variável de ambiente. Se nenhum texto pszErrorMessage
personalizado for especificado, uErrorCode
será exibido em Microsoft formato de código de erro do sistema.
uTimeoutInSeconds
Tipo de dados: ULONG
Qualificadores: [in]
Ponteiro para o valor do número de segundos em que a caixa de diálogo é exibida antes de fechar. O valor pode ser obtido da SMSTSErrorDialogTimeout
variável de ambiente, que não está configurada na sequência de tarefas por padrão. Se uma cadeia de caracteres vazia for especificada e uTimeoutInSeconds
SMSTSErrorDialogTimeout
não for especificada, um padrão de 900 segundos será usado.
bWillReboot
Tipo de dados: ULONG
Qualificadores: [in]
Valor booleano. Ele indica se a sequência de tarefas reiniciará o computador quando a caixa de diálogo estiver fechada ou o tempo limite expirar.
pszTaskSequenceStepName
Tipo de dados: BSTR
Qualificadores: [in]
Ponteiro para o texto para o nome do nome da etapa que será exibido no texto padrão pszErrorMessage
. O valor pode ser recuperado da _SMSTSLastActionName
variável de ambiente.
Valores de retorno
Um HRESULT
código. Os valores possíveis incluem, mas não se limitam a, o valor a seguir. Não há HRESULT
valores retornados que sejam específicos para esse método.
S_OK
O método foi bem-sucedido.