IProgressUI::ShowActionProgress-Methode

Im Configuration Manager zeigt die ShowActionProgress Methode Fortschrittsinformationen der benutzerdefinierten Aktion 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

Qualifikanten: [in]

Zeiger auf den Namen der organization, der im Statusdialogfeld angezeigt wird. Der Wert kann aus der _SMSTSOrgName Umgebungsvariablen abgerufen werden.

pszTaskSequenceName

Datentyp: BSTR

Qualifikanten: [in]

Zeiger auf den Namen der Tasksequenz, die derzeit ausgeführt wird. Der Wert kann aus der _SMSTSPackageName Umgebungsvariablen abgerufen werden.

pszCustomTitle

Datentyp: BSTR

Qualifikanten: [in]

Zeiger auf den Text für eine benutzerdefinierte Meldung, die den Standardtiteltext ersetzt, der im Fortschrittsdialogfeld angezeigt wird. Übergeben Sie eine leere Zeichenfolge, wenn keine anzuzeigende benutzerdefinierte Nachricht vorhanden ist. Der Wert kann aus der _SMSTSCustomProgressDialogMessage Umgebungsvariablen abgerufen werden.

pszCurrentAction

Datentyp: BSTR

Qualifikanten: [in]

Zeigt auf den Namen des aktuellen Tasksequenzschritts. Der Wert kann aus der _SMSTSCurrentActionName Umgebungsvariablen abgerufen werden.

uStep

Datentyp: ULONG

Qualifikanten: [in]

Die aktuelle Tasksequenzschrittnummer. Der Wert kann aus der SMSTSNextInstructionPointer Umgebungsvariablen abgerufen werden.

uMaxStep

Datentyp: ULONG

Qualifikanten: [in]

Die Gesamtanzahl der Schritte in der Tasksequenz. Der Wert kann aus der _SMSTSInstructionTableSize Umgebungsvariablen abgerufen werden.

pszActionExecInfo

Datentyp: BSTR

Qualifikanten: [in]

Zeiger auf benutzerdefinierte, aktionsspezifische Fortschrittsinformationen, die im Fortschrittsdialogfeld angezeigt werden sollen.

uActionExecStep

Datentyp: ULONG

Qualifikanten: [in]

Der numerische Schritt innerhalb der Gesamtzahl der numerischen Schritte, auf dem die Aktion gerade ausgeführt wird.

Verwenden Sie diesen Parameter, um den Prozentsatz der Aktion zu bestimmen, der bisher abgeschlossen wurde. Weitere Informationen finden Sie unter Hinweise.

uActionExecMaxStep

Datentyp: ULONG

Qualifikanten: [in]

Die Gesamtzahl der numerischen Schritte, die die Aktion ausführt.

Verwenden Sie diesen Parameter, um den Prozentsatz der Aktion zu bestimmen, der 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 , uActionExecStep, und uActionExecMaxStep Die anderen Parameter können aus den referenzierten Umgebungsvariablen abgerufen werden.

Ein Aufruf sollte ShowActionProgress den Prozentsatz der Fertigstellung der Aktion mit den uActionExecStep Parametern and uActionExecMaxStep angeben. Wenn z. B. uActionExecStep der Wert 2 und uActionExecMaxStep der Wert 10 angegeben sind, beträgt die prozentuale Fertigstellung der Aktion 20 Prozent.

Siehe auch

  • Last updated on