Método IWMDMProgress::Begin (mswmdm.h)

Artigo
03/05/2024

O método Begin indica que uma operação está começando. Uma estimativa da duração da operação é fornecida quando possível.

Sintaxe

HRESULT Begin(
  [in] DWORD dwEstimatedTicks
);

Parâmetros

[in] dwEstimatedTicks

DWORD especificando o número estimado de tiques necessários para a conclusão da operação.

Retornar valor

O aplicativo deve retornar um dos seguintes valores HRESULT .

Código de retorno	Descrição
S_OK	A operação deve continuar.
WMDM_E_USER_CANCELLED	Os Gerenciador de Dispositivos do Windows Media devem cancelar a operação atual sem esperar que ela seja concluída. Se o aplicativo estiver usando o modo de bloco, o Gerenciador de Dispositivos do Windows Media retornará esse erro ao aplicativo.

Comentários

Essa operação é chamada por vários métodos para indicar que uma operação está começando. O número de tiques passados em dwEstimatedTicks é uma estimativa de quantos tiques são necessários para que a operação seja concluída. Durante a operação, o método Progress é chamado para indicar quantos tiques ocorreram. Os aplicativos podem usar a estimativa para configurar mecanismos de exibição que mostram o progresso.

O método IWMDMProgress3::Begin3 fornece mais informações sobre qual ação está ocorrendo.

Exemplos

O código C++ a seguir é uma implementação do método Begin .


HRESULT Begin(DWORD  dwEstimatedTicks)
{
    // TODO: Display the message: "IWMDMProgress::Begin called.: "
    // followed by the dwEstimatedTicks value.
    return S_OK;
}