IProgressUI::ShowActionProgress — Metoda

  • Artykuł

W Configuration Manager ShowActionProgress metoda wyświetla informacje o postępie akcji niestandardowej w oknie dialogowym, gdy akcja niestandardowa jest uruchomiona.

Składni

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

Parametry

pszOrgName

Typ danych: BSTR

Kwalifikatory: [w]

Wskaźnik do nazwy organizacji, która jest wyświetlana w oknie dialogowym postępu. Wartość można pobrać ze zmiennej środowiskowej _SMSTSOrgName .

pszTaskSequenceName

Typ danych: BSTR

Kwalifikatory: [w]

Wskaźnik do nazwy sekwencji zadań, która jest obecnie uruchomiona. Wartość można pobrać ze zmiennej środowiskowej _SMSTSPackageName .

pszCustomTitle

Typ danych: BSTR

Kwalifikatory: [w]

Wskaźnik do tekstu niestandardowego komunikatu, który zastępuje domyślny tekst tytułu wyświetlany w oknie dialogowym postępu. Przekaż pusty ciąg, jeśli nie ma niestandardowego komunikatu do wyświetlenia. Wartość można uzyskać ze zmiennej środowiskowej _SMSTSCustomProgressDialogMessage .

pszCurrentAction

Typ danych: BSTR

Kwalifikatory: [w]

Wskaźnik do nazwy bieżącego kroku sekwencji zadań. Wartość można uzyskać ze zmiennej środowiskowej _SMSTSCurrentActionName .

uStep

Typ danych: ULONG

Kwalifikatory: [w]

Numer kroku bieżącej sekwencji zadań. Wartość można uzyskać ze zmiennej środowiskowej SMSTSNextInstructionPointer .

uMaxStep

Typ danych: ULONG

Kwalifikatory: [w]

Całkowita liczba kroków w sekwencji zadań. Wartość można uzyskać ze zmiennej środowiskowej _SMSTSInstructionTableSize .

pszActionExecInfo

Typ danych: BSTR

Kwalifikatory: [w]

Wskaźnik do zdefiniowanych przez użytkownika informacji o postępie specyficznych dla akcji, które mają być wyświetlane w oknie dialogowym postępu.

uActionExecStep

Typ danych: ULONG

Kwalifikatory: [w]

Krok liczbowy w ramach łącznej liczby kroków liczbowych, na których akcja obecnie działa.

Użyj tego parametru, aby określić procent akcji, która została ukończona do tej pory. Aby uzyskać więcej informacji, zobacz Uwagi.

uActionExecMaxStep

Typ danych: ULONG

Kwalifikatory: [w]

Całkowita liczba kroków liczbowych wykonywanych przez akcję.

Użyj tego parametru, aby określić procent akcji, która została ukończona do tej pory. Aby uzyskać więcej informacji, zobacz Uwagi.

Zwracane wartości

Kod HRESULT . Możliwe wartości obejmują, ale nie są ograniczone do następującej wartości. Nie są zwracane żadne HRESULT wartości specyficzne dla tej metody.

S_OK
Metoda zakończyła się pomyślnie.

Uwagi

Jedynymi wymaganymi informacjami dla tej metody są pszActionExecInfoparametry , uActionExecStepi uActionExecMaxStep . Inne parametry można uzyskać z przywoływanych zmiennych środowiskowych.

Wywołanie ShowActionProgress polecenia powinno określać procentowe ukończenie akcji przy użyciu uActionExecStep parametrów i uActionExecMaxStep . Jeśli na przykład uActionExecStep określa wartość 2 i uActionExecMaxStep określa wartość 10, procent ukończenia akcji wynosi 20 procent.

Zobacz też