Methode IProgressUI::ShowActionProgress
In Configuration Manager geeft de methode informatie over de ShowActionProgress
voortgang van de aangepaste actie weer in een dialoogvenster terwijl de aangepaste actie wordt uitgevoerd.
Syntaxis
[IDL]
HRESULT ShowActionProgress(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszCurrentAction,
ULONG uStep,
ULONG uMaxStep,
BSTR pszActionExecInfo,
ULONG uActionExecStep,
ULONG uActionExecMaxStep
);
Parameters
pszOrgName
Gegevenstype: BSTR
Kwalificatie: [in]
Wijs de naam van de organisatie aan die wordt weergegeven in het voortgangsdialoogvenster. De waarde kan worden opgehaald uit de omgevingsvariabele _SMSTSOrgName
.
pszTaskSequenceName
Gegevenstype: BSTR
Kwalificatie: [in]
Aanwijzer naar de naam van de takenreeks die momenteel wordt uitgevoerd. De waarde kan worden opgehaald uit de omgevingsvariabele _SMSTSPackageName
.
pszCustomTitle
Gegevenstype: BSTR
Kwalificatie: [in]
Wijs de tekst voor een aangepast bericht aan die de standaardtiteltekst vervangt die in het voortgangsdialoogvenster wordt weergegeven. Geef een lege tekenreeks door als er geen aangepast bericht wordt weergegeven. De waarde kan worden verkregen uit de omgevingsvariabele _SMSTSCustomProgressDialogMessage
.
pszCurrentAction
Gegevenstype: BSTR
Kwalificatie: [in]
Aanwijzer naar de naam van de huidige takenreeksstap. De waarde kan worden verkregen uit de omgevingsvariabele _SMSTSCurrentActionName
.
uStep
Gegevenstype: ULONG
Kwalificatie: [in]
Het huidige takenreeksstapnummer. De waarde kan worden verkregen uit de omgevingsvariabele SMSTSNextInstructionPointer
.
uMaxStep
Gegevenstype: ULONG
Kwalificatie: [in]
Het totale aantal stappen in de takenreeks. De waarde kan worden verkregen uit de omgevingsvariabele _SMSTSInstructionTableSize
.
pszActionExecInfo
Gegevenstype: BSTR
Kwalificatie: [in]
Aanwijzer naar door de gebruiker gedefinieerde, actiespecifieke voortgangsgegevens die moeten worden weergegeven in het voortgangsdialoogvenster.
uActionExecStep
Gegevenstype: ULONG
Kwalificatie: [in]
De numerieke stap, binnen het totale aantal numerieke stappen waarop de actie momenteel werkt.
Gebruik deze parameter om het percentage van de actie te bepalen dat tot nu toe is voltooid. Zie Opmerkingen voor meer informatie.
uActionExecMaxStep
Gegevenstype: ULONG
Kwalificatie: [in]
Het totale aantal numerieke stappen dat de actie uitvoert.
Gebruik deze parameter om het percentage van de actie te bepalen dat tot nu toe is voltooid. Zie Opmerkingen voor meer informatie.
Waarden retourneren
Een HRESULT
code. Mogelijke waarden omvatten, maar zijn niet beperkt tot, de volgende waarde. Er worden geen HRESULT
waarden geretourneerd die specifiek zijn voor deze methode.
S_OK
De methode is geslaagd.
Opmerkingen
De enige vereiste informatie voor deze methode is voor de pszActionExecInfo
parameters , uActionExecStep
en uActionExecMaxStep
. De andere parameters kunnen worden verkregen uit de omgevingsvariabelen waarnaar wordt verwezen.
Een aanroep naar ShowActionProgress
moet het voltooiingspercentage van de actie opgeven met behulp van de uActionExecStep
parameters en uActionExecMaxStep
. Als uActionExecStep
bijvoorbeeld de waarde 2 en uActionExecMaxStep
de waarde 10 opgeeft, is het voltooiingspercentage van de actie 20 procent.