Méthode IProgressUI::ShowActionProgress
Dans Configuration Manager, la ShowActionProgress méthode affiche les informations de progression de l’action personnalisée dans une boîte de dialogue pendant l’exécution de l’action personnalisée.
Syntaxe
[IDL]
HRESULT ShowActionProgress(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszCurrentAction,
ULONG uStep,
ULONG uMaxStep,
BSTR pszActionExecInfo,
ULONG uActionExecStep,
ULONG uActionExecMaxStep
);
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 de progression. 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 .
pszCurrentAction
Type de donnéesBSTR
Qualificateurs : [in]
Pointeur vers le nom de l’étape de séquence de tâches actuelle. La valeur peut être obtenue à partir de la variable d’environnement _SMSTSCurrentActionName .
uStep
Type de donnéesULONG
Qualificateurs : [in]
Numéro de l’étape de séquence de tâches actuelle. La valeur peut être obtenue à partir de la variable d’environnement SMSTSNextInstructionPointer .
uMaxStep
Type de donnéesULONG
Qualificateurs : [in]
Nombre total d’étapes dans la séquence de tâches. La valeur peut être obtenue à partir de la variable d’environnement _SMSTSInstructionTableSize .
pszActionExecInfo
Type de donnéesBSTR
Qualificateurs : [in]
Pointeur vers des informations de progression spécifiques à l’action définies par l’utilisateur à afficher dans la boîte de dialogue progression.
uActionExecStep
Type de donnéesULONG
Qualificateurs : [in]
Étape numérique, dans le nombre total d’étapes numériques, sur laquelle l’action travaille actuellement.
Utilisez ce paramètre pour déterminer le pourcentage de l’action qui a été effectuée jusqu’à présent. Pour plus d’informations, consultez Remarques.
uActionExecMaxStep
Type de donnéesULONG
Qualificateurs : [in]
Nombre total d’étapes numériques effectuées par l’action.
Utilisez ce paramètre pour déterminer le pourcentage de l’action qui a été effectuée jusqu’à présent. Pour plus d’informations, consultez Remarques.
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.
Remarques
Les seules informations requises pour cette méthode concernent les pszActionExecInfoparamètres , uActionExecStepet uActionExecMaxStep . Les autres paramètres peuvent être obtenus à partir des variables d’environnement référencées.
Un appel à ShowActionProgress doit spécifier le pourcentage d’achèvement de l’action à l’aide des uActionExecStep paramètres et uActionExecMaxStep . Par exemple, si uActionExecStep spécifie la valeur 2 et uActionExecMaxStep la valeur 10, le pourcentage d’achèvement de l’action est de 20 %.