IProgressUI::ShowActionProgress-metoden

I Configuration Manager ShowActionProgress visar metoden förloppsinformation för anpassade åtgärder i en dialogruta medan den anpassade åtgärden körs.

Syntax

[IDL]
HRESULT ShowActionProgress(
     BSTR pszOrgName,
     BSTR pszTaskSequenceName,
     BSTR pszCustomTitle,
     BSTR pszCurrentAction,
     ULONG uStep,
     ULONG uMaxStep,
     BSTR pszActionExecInfo,
     ULONG uActionExecStep,
     ULONG uActionExecMaxStep
);

Parametrar

pszOrgName

Datatyp: BSTR

Kvalificerare: [i]

Pekare till organisationsnamnet som visas i förloppsdialogrutan. Värdet kan hämtas från miljövariabeln _SMSTSOrgName .

pszTaskSequenceName

Datatyp: BSTR

Kvalificerare: [i]

Pekare till namnet på den aktivitetssekvens som körs. Värdet kan hämtas från miljövariabeln _SMSTSPackageName .

pszCustomTitle

Datatyp: BSTR

Kvalificerare: [i]

Pekare på texten för ett anpassat meddelande som ersätter standardrubriktexten som visas i förloppsdialogrutan. Skicka en tom sträng om det inte finns något anpassat meddelande att visa. Värdet kan erhållas från miljövariabeln _SMSTSCustomProgressDialogMessage .

pszCurrentAction

Datatyp: BSTR

Kvalificerare: [i]

Pekare till namnet på det aktuella aktivitetssekvenssteget. Värdet kan erhållas från miljövariabeln _SMSTSCurrentActionName .

uStep

Datatyp: ULONG

Kvalificerare: [i]

Numret på det aktuella aktivitetssekvenssteget. Värdet kan erhållas från miljövariabeln SMSTSNextInstructionPointer .

uMaxStep

Datatyp: ULONG

Kvalificerare: [i]

Det totala antalet steg i aktivitetssekvensen. Värdet kan erhållas från miljövariabeln _SMSTSInstructionTableSize .

pszActionExecInfo

Datatyp: BSTR

Kvalificerare: [i]

Pekare till användardefinierad, åtgärdsspecifik förloppsinformation som ska visas i förloppsdialogrutan.

uActionExecStep

Datatyp: ULONG

Kvalificerare: [i]

Det numeriska steg, inom det totala antalet numeriska steg, som åtgärden arbetar med.

Använd den här parametern för att bestämma procentandelen av åtgärden som har slutförts hittills. Mer information finns under Anmärkningar.

uActionExecMaxStep

Datatyp: ULONG

Kvalificerare: [i]

Det totala antalet numeriska steg som åtgärden utför.

Använd den här parametern för att bestämma procentandelen av åtgärden som har slutförts hittills. Mer information finns under Anmärkningar.

Returvärden

En HRESULT kod. Möjliga värden inkluderar, men är inte begränsade till, följande värde. Det returneras inga HRESULT värden som är specifika för den här metoden.

S_OK Metoden lyckades.

Anmärkningar

Den enda information som krävs för den här metoden är för parametrarna pszActionExecInfo, uActionExecStepoch uActionExecMaxStep . De andra parametrarna kan härledas från de refererade miljövariablerna.

Ett anrop till ShowActionProgress ska ange hur många procent åtgärden har slutförts med hjälp av parametrarna uActionExecStep och uActionExecMaxStep . Om uActionExecStep till exempel anger värdet 2 och uActionExecMaxStep anger värdet 10 är slutförandet av åtgärden 20 procent.

Se även