Méthode IProgressUI::ShowErrorDialog
Dans Configuration Manager, la ShowErrorDialog
méthode affiche des informations d’erreur personnalisables dans une boîte de dialogue.
Syntaxe
[IDL]
HRESULT ShowErrorDialog(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszErrorMessage,
ULONG uErrorCode,
ULONG uTimeoutInSeconds,
ULONG uWillReboot,
BSTR pszTaskSequenceStepName
);
Paramètres
pszOrgName
Type de donnéesBSTR
Qualificateurs : [in]
Pointeur vers le nom de l’organisation affiché dans la boîte de dialogue de progression. La valeur peut être récupérée à partir de la variable d’environnement _SMSTSOrgName
.
pszTaskSequenceName
Type de donnéesBSTR
Qualificateurs : [in]
Pointeur vers le nom de la séquence de tâches en cours d’exécution. La valeur peut être récupérée à partir de la variable d’environnement _SMSTSPackageName
.
pszCustomTitle
Type de donnéesBSTR
Qualificateurs : [in]
Pointeur vers le texte d’un message personnalisé qui remplace le texte de titre par défaut affiché dans la boîte de dialogue d’erreur. Passez une chaîne vide s’il n’y a pas de message personnalisé à afficher. La valeur peut être obtenue à partir de la variable d’environnement _SMSTSCustomProgressDialogMessage
.
pszErrorMessage
Type de donnéesBSTR
Qualificateurs : [in]
Pointeur vers le texte du message personnalisé affiché dans la boîte de dialogue d’erreur. Passez une chaîne vide s’il n’y a pas de message personnalisé à afficher. Le texte par défaut inclut le texte de pszTaskSequenceName
, pszTaskSequenceStepName
et uErrorCode
. Il change en fonction des valeurs spécifiées.
uErrorCode
Type de donnéesULONG
Qualificateurs : [in]
Pointeur vers le code de retour de la dernière étape qui a échoué. La valeur peut être obtenue à partir de la variable d’environnement _SMSTSLastActionRetCode
. Si aucun texte personnalisé pour pszErrorMessage
n’est spécifié, uErrorCode
s’affiche dans Microsoft format de code d’erreur système.
uTimeoutInSeconds
Type de donnéesULONG
Qualificateurs : [in]
Pointeur vers la valeur du nombre de secondes pendant lesquelles la boîte de dialogue est affichée avant la fermeture. La valeur peut être obtenue à partir de la SMSTSErrorDialogTimeout
variable d’environnement, qui n’est pas configurée dans la séquence de tâches par défaut. Si une chaîne vide est spécifiée pour uTimeoutInSeconds
et SMSTSErrorDialogTimeout
n’est pas spécifiée, une valeur par défaut de 900 secondes est utilisée.
bWillReboot
Type de donnéesULONG
Qualificateurs : [in]
Valeur booléenne Il indique si la séquence de tâches redémarre l’ordinateur lorsque la boîte de dialogue est fermée ou que le délai d’expiration expire.
pszTaskSequenceStepName
Type de donnéesBSTR
Qualificateurs : [in]
Pointeur vers le texte pour le nom de l’étape qui sera affiché dans le texte par défaut pszErrorMessage
. La valeur peut être récupérée à partir de la variable d’environnement _SMSTSLastActionName
.
Valeurs de retour
Code HRESULT
. Les valeurs possibles incluent, sans s’y limiter, la valeur suivante. Aucune valeur retournée n’est HRESULT
spécifique à cette méthode.
S_OK
La méthode a réussi.