IProgressUI::ShowActionProgress método
No Gestor de Configuração, o ShowActionProgress
método exibe informações de progresso de ação personalizadas numa caixa de diálogo enquanto a ação personalizada está em execução.
Sintaxe
[IDL]
HRESULT ShowActionProgress(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszCurrentAction,
ULONG uStep,
ULONG uMaxStep,
BSTR pszActionExecInfo,
ULONG uActionExecStep,
ULONG uActionExecMaxStep
);
Parâmetros
pszOrgName
Tipo de dados: BSTR
Eliminatórias: [in]
Ponteiro para o nome da organização que é mostrado na caixa de diálogo de progresso. O valor pode ser recuperado a partir da _SMSTSOrgName
variável ambiental.
pszTaskSequenceName
Tipo de dados: BSTR
Eliminatórias: [in]
Ponteiro para o nome da sequência de tarefas que está atualmente em execução. O valor pode ser recuperado a partir da _SMSTSPackageName
variável ambiental.
pszCustomTitle
Tipo de dados: BSTR
Eliminatórias: [in]
Ponteiro para o texto para uma mensagem personalizada que substitua o texto do título predefinido apresentado na caixa de diálogo de progresso. Passe uma corda vazia se não houver uma mensagem personalizada para mostrar. O valor pode ser obtido a partir da _SMSTSCustomProgressDialogMessage
variável ambiental.
pszCurrentAction
Tipo de dados: BSTR
Eliminatórias: [in]
Ponteiro para o nome do atual passo da sequência de tarefas. O valor pode ser obtido a partir da _SMSTSCurrentActionName
variável ambiental.
uStep
Tipo de dados: ULONG
Eliminatórias: [in]
O número atual do passo da sequência de tarefa. O valor pode ser obtido a partir da SMSTSNextInstructionPointer
variável ambiental.
uMaxStep
Tipo de dados: ULONG
Eliminatórias: [in]
O número total de passos na sequência de tarefas. O valor pode ser obtido a partir da _SMSTSInstructionTableSize
variável ambiental.
pszActionExecInfo
Tipo de dados: BSTR
Eliminatórias: [in]
Ponteiro para informações de progresso específicas do utilizador, definidas pelo utilizador, a serem mostradas na caixa de diálogo de progresso.
uActionExecStep
Tipo de dados: ULONG
Eliminatórias: [in]
O passo numérico, dentro do número total de passos numéricos, em que a ação está atualmente a funcionar.
Utilize este parâmetro para determinar a percentagem da ação que foi concluída até agora. Para mais informações, consulte Comentários.
uActionExecMaxStep
Tipo de dados: ULONG
Eliminatórias: [in]
O número total de passos numéricos que a ação faz.
Utilize este parâmetro para determinar a percentagem da ação que foi concluída até agora. Para mais informações, consulte Comentários.
Valores de retorno
Um HRESULT
código. Os valores possíveis incluem, mas não se limitam a. Não há HRESULT
valores devolvidos que sejam específicos deste método.
S_OK
O método conseguiu.
Observações
A única informação necessária para este método é para os pszActionExecInfo
uActionExecStep
parâmetros e uActionExecMaxStep
parâmetros. Os outros parâmetros podem ser obtidos a partir das variáveis ambientais referenciadas.
Uma chamada ShowActionProgress
deve especificar a percentagem de conclusão da ação utilizando os uActionExecStep
parâmetros e uActionExecMaxStep
parâmetros. Por exemplo, se uActionExecStep
especificar o valor 2 e uActionExecMaxStep
especificar o valor 10, a percentagem de conclusão da ação é de 20 por cento.