Metoda IProgressUI::ShowActionProgress
V Configuration Manager ShowActionProgress
metoda zobrazí informace o průběhu vlastní akce v dialogovém okně, když je vlastní akce spuštěná.
Syntaxe
[IDL]
HRESULT ShowActionProgress(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszCurrentAction,
ULONG uStep,
ULONG uMaxStep,
BSTR pszActionExecInfo,
ULONG uActionExecStep,
ULONG uActionExecMaxStep
);
Parametry
pszOrgName
Datový typ: BSTR
Kvalifikátory: [v]
Ukazatel na název organizace, který se zobrazí v dialogovém okně průběhu. Hodnotu je možné načíst z _SMSTSOrgName
proměnné prostředí.
pszTaskSequenceName
Datový typ: BSTR
Kvalifikátory: [v]
Ukazatel na název aktuálně spuštěného pořadí úkolů. Hodnotu je možné načíst z _SMSTSPackageName
proměnné prostředí.
pszCustomTitle
Datový typ: BSTR
Kvalifikátory: [v]
Ukazatel myši na text vlastní zprávy, který nahrazuje výchozí text nadpisu zobrazený v dialogovém okně průběhu. Pokud neexistuje žádná vlastní zpráva, která by se zobrazila, předejte prázdný řetězec. Hodnotu lze získat z _SMSTSCustomProgressDialogMessage
proměnné prostředí.
pszCurrentAction
Datový typ: BSTR
Kvalifikátory: [v]
Ukazatel myši na název aktuálního kroku pořadí úkolů. Hodnotu lze získat z _SMSTSCurrentActionName
proměnné prostředí.
uStep
Datový typ: ULONG
Kvalifikátory: [v]
Číslo aktuálního kroku pořadí úkolů. Hodnotu lze získat z SMSTSNextInstructionPointer
proměnné prostředí.
uMaxStep
Datový typ: ULONG
Kvalifikátory: [v]
Celkový počet kroků v pořadí úkolů. Hodnotu lze získat z _SMSTSInstructionTableSize
proměnné prostředí.
pszActionExecInfo
Datový typ: BSTR
Kvalifikátory: [v]
Ukazatel na uživatelem definované informace o průběhu akcí, které se mají zobrazit v dialogovém okně průběhu.
uActionExecStep
Datový typ: ULONG
Kvalifikátory: [v]
Číselný krok v rámci celkového počtu číselných kroků, na kterých akce právě pracuje.
Pomocí tohoto parametru můžete určit procento dosud dokončené akce. Další informace najdete v tématu Poznámky.
uActionExecMaxStep
Datový typ: ULONG
Kvalifikátory: [v]
Celkový počet číselných kroků, které akce provede.
Pomocí tohoto parametru můžete určit procento dosud dokončené akce. Další informace najdete v tématu Poznámky.
Návratové hodnoty
Kód HRESULT
. Mezi možné hodnoty patří mimo jiné následující hodnota. Nejsou vráceny žádné HRESULT
hodnoty, které jsou specifické pro tuto metodu.
S_OK
Metoda byla úspěšná.
Poznámky
Jediné požadované informace pro tuto metodu pszActionExecInfo
jsou pro parametry , uActionExecStep
a uActionExecMaxStep
. Další parametry lze získat z odkazovaných proměnných prostředí.
Volání ShowActionProgress
by mělo určovat procento dokončení akce pomocí uActionExecStep
parametrů a uActionExecMaxStep
. Pokud uActionExecStep
například určuje hodnotu 2 a uActionExecMaxStep
určuje hodnotu 10, procento dokončení akce je 20 procent.