IProgressUI::ShowActionProgress-Methode
In Configuration Manager zeigt die ShowActionProgress -Methode benutzerdefinierte Aktionsstatusinformationen in einem Dialogfeld an, während die benutzerdefinierte Aktion ausgeführt wird.
Syntax
[IDL]
HRESULT ShowActionProgress(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszCurrentAction,
ULONG uStep,
ULONG uMaxStep,
BSTR pszActionExecInfo,
ULONG uActionExecStep,
ULONG uActionExecMaxStep
);
Parameter
pszOrgName
Datentyp: BSTR
Qualifizierer: [in]
Zeiger auf den organization Namen, der im Statusdialogfeld angezeigt wird. Der Wert kann aus der Umgebungsvariablen _SMSTSOrgName abgerufen werden.
pszTaskSequenceName
Datentyp: BSTR
Qualifizierer: [in]
Zeiger auf den Namen der Tasksequenz, die derzeit ausgeführt wird. Der Wert kann aus der Umgebungsvariablen _SMSTSPackageName abgerufen werden.
pszCustomTitle
Datentyp: BSTR
Qualifizierer: [in]
Zeiger auf den Text für eine benutzerdefinierte Nachricht, die den im Statusdialogfeld angezeigten Standardtiteltext ersetzt. Übergeben Sie eine leere Zeichenfolge, wenn keine benutzerdefinierte Meldung angezeigt werden soll. Der Wert kann aus der Umgebungsvariablen _SMSTSCustomProgressDialogMessage abgerufen werden.
pszCurrentAction
Datentyp: BSTR
Qualifizierer: [in]
Zeiger auf den Namen des aktuellen Tasksequenzschritts. Der Wert kann aus der Umgebungsvariablen _SMSTSCurrentActionName abgerufen werden.
uStep
Datentyp: ULONG
Qualifizierer: [in]
Die aktuelle Tasksequenzschrittnummer. Der Wert kann aus der Umgebungsvariablen SMSTSNextInstructionPointer abgerufen werden.
uMaxStep
Datentyp: ULONG
Qualifizierer: [in]
Die Gesamtanzahl der Schritte in der Tasksequenz. Der Wert kann aus der Umgebungsvariablen _SMSTSInstructionTableSize abgerufen werden.
pszActionExecInfo
Datentyp: BSTR
Qualifizierer: [in]
Zeiger auf benutzerdefinierte, aktionsspezifische Statusinformationen, die im Statusdialogfeld angezeigt werden sollen.
uActionExecStep
Datentyp: ULONG
Qualifizierer: [in]
Der numerische Schritt innerhalb der Gesamtzahl der numerischen Schritte, an dem die Aktion derzeit arbeitet.
Verwenden Sie diesen Parameter, um den Prozentsatz der aktion zu bestimmen, die bisher abgeschlossen wurde. Weitere Informationen finden Sie unter Hinweise.
uActionExecMaxStep
Datentyp: ULONG
Qualifizierer: [in]
Die Gesamtzahl der numerischen Schritte, die die Aktion ausführt.
Verwenden Sie diesen Parameter, um den Prozentsatz der aktion zu bestimmen, die bisher abgeschlossen wurde. Weitere Informationen finden Sie unter Hinweise.
Rückgabewerte
Ein HRESULT Code. Mögliche Werte sind unter anderem der folgende Wert. Es werden keine HRESULT Werte zurückgegeben, die für diese Methode spezifisch sind.
S_OK
Die Methode war erfolgreich.
Hinweise
Die einzigen erforderlichen Informationen für diese Methode sind die pszActionExecInfoParameter , uActionExecStepund uActionExecMaxStep . Die anderen Parameter können aus den Referenzumgebungsvariablen abgerufen werden.
Ein Aufruf von ShowActionProgress sollte den prozentualen Abschluss der Aktion mithilfe der uActionExecStep Parameter und uActionExecMaxStep angeben. Wenn uActionExecStep z. B. der Wert 2 und uActionExecMaxStep der Wert 10 angegeben wird, beträgt der prozentsatzuelle Abschluss der Aktion 20 Prozent.