Método IProgressUI::ShowActionProgress
Em Configuration Manager, o ShowActionProgress
método exibe informações de progresso de ação personalizadas em uma 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
Qualificadores: [in]
Ponteiro para o nome da organização que é mostrado na caixa de diálogo progresso. O valor pode ser recuperado da _SMSTSOrgName
variável de ambiente.
pszTaskSequenceName
Tipo de dados: BSTR
Qualificadores: [in]
Ponteiro para o nome da sequência de tarefas que está em execução no momento. O valor pode ser recuperado da _SMSTSPackageName
variável de ambiente.
pszCustomTitle
Tipo de dados: BSTR
Qualificadores: [in]
Ponteiro para o texto de uma mensagem personalizada que substitui o texto de título padrão exibido na caixa de diálogo progresso. Passe uma cadeia de caracteres vazia se não houver nenhuma mensagem personalizada a ser exibida. O valor pode ser obtido da _SMSTSCustomProgressDialogMessage
variável de ambiente.
pszCurrentAction
Tipo de dados: BSTR
Qualificadores: [in]
Ponteiro para o nome da etapa atual da sequência de tarefas. O valor pode ser obtido da _SMSTSCurrentActionName
variável de ambiente.
uStep
Tipo de dados: ULONG
Qualificadores: [in]
O número da etapa da sequência de tarefas atual. O valor pode ser obtido da SMSTSNextInstructionPointer
variável de ambiente.
uMaxStep
Tipo de dados: ULONG
Qualificadores: [in]
O número total de etapas na sequência de tarefas. O valor pode ser obtido da _SMSTSInstructionTableSize
variável de ambiente.
pszActionExecInfo
Tipo de dados: BSTR
Qualificadores: [in]
Ponteiro para informações de progresso definidas pelo usuário e específicas da ação a serem mostradas na caixa de diálogo de progresso.
uActionExecStep
Tipo de dados: ULONG
Qualificadores: [in]
A etapa numérica, dentro do número total de etapas numéricas, em que a ação está funcionando no momento.
Use esse parâmetro para determinar o percentual da ação que foi concluída até agora. Para obter mais informações, consulte Comentários.
uActionExecMaxStep
Tipo de dados: ULONG
Qualificadores: [in]
O número total de etapas numéricas que a ação faz.
Use esse parâmetro para determinar o percentual da ação que foi concluída até agora. Para obter mais informações, consulte Comentários.
Valores de retorno
Um HRESULT
código. Os valores possíveis incluem, mas não se limitam a, o valor a seguir. Não há HRESULT
valores retornados que sejam específicos para esse método.
S_OK
O método foi bem-sucedido.
Comentários
As únicas informações necessárias para esse método são para os pszActionExecInfo
parâmetros , uActionExecStep
e uActionExecMaxStep
. Os outros parâmetros podem ser obtidos das variáveis de ambiente referenciadas.
Uma chamada para ShowActionProgress
especificar o percentual de conclusão da ação usando os uActionExecStep
parâmetros e uActionExecMaxStep
. Por exemplo, se uActionExecStep
especificar o valor 2 e uActionExecMaxStep
especificar o valor 10, o percentual de conclusão da ação será de 20%.