Méthode IProgressUI ::ShowActionProgress

Dans le Configuration Manager, la méthode affiche des informations sur la progression d’une ShowActionProgress 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

Qualificatifs : [dans]

Pointeur sur le nom de l’organisation qui s’affiche 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

Qualificatifs : [dans]

Pointeur sur 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

Qualificatifs : [dans]

Pointeur sur le texte d’un message personnalisé qui remplace le texte de titre par défaut affiché dans la boîte de dialogue de progression. Transmettez une chaîne vide s’il n’y a aucun message personnalisé à afficher. La valeur peut être obtenue à partir de la variable d’environnement _SMSTSCustomProgressDialogMessage .

pszCurrentAction

Type de donnéesBSTR

Qualificatifs : [dans]

Pointeur sur le nom de l’étape de séquence de tâches en cours. La valeur peut être obtenue à partir de la variable d’environnement _SMSTSCurrentActionName .

uStep

Type de donnéesULONG

Qualificatifs : [dans]

Le numéro d’étape de séquence de tâches actuel. La valeur peut être obtenue à partir de la variable d’environnement SMSTSNextInstructionPointer .

uMaxStep

Type de donnéesULONG

Qualificatifs : [dans]

Nombre total d’étapes de la séquence de tâches. La valeur peut être obtenue à partir de la variable d’environnement _SMSTSInstructionTableSize .

pszActionExecInfo

Type de donnéesBSTR

Qualificatifs : [dans]

Pointeur vers des informations de progression définies par l’utilisateur et spécifiques à l’action à afficher dans la boîte de dialogue de progression.

uActionExecStep

Type de donnéesULONG

Qualificatifs : [dans]

L’étape numérique, dans le nombre total d’étapes numériques, sur laquelle l’action fonctionne 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, voir Remarques.

uActionExecMaxStep

Type de donnéesULONG

Qualificatifs : [dans]

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, voir Remarques.

Valeurs de retour

Un HRESULT code. Les valeurs possibles incluent, sans toutefois s’y limiter, la valeur suivante. Aucune valeur spécifique à cette méthode n’est HRESULT renvoyée.

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 doit ShowActionProgress spécifier le pourcentage d’achèvement de l’action à l’aide des uActionExecStep paramètres et uActionExecMaxStep . Par exemple, si uActionExecStep vous spécifiez la valeur 2 et uActionExecMaxStep la valeur 10, le pourcentage d’achèvement de l’action est de 20 %.

Voir aussi

  • Last updated on