Compartilhar via

Função TimeProvCommand (timeprov.h)

  • Artigo

Uma função de retorno de chamada que é chamada pelo gerenciador de provedores de tempo para enviar comandos para o provedor de tempo.

Sintaxe

HRESULT TimeProvCommand(
  [in] TimeProvHandle hTimeProv,
  [in] TimeProvCmd    eCmd,
  [in] TimeProvArgs   pvArgs
);

Parâmetros

[in] hTimeProv

Um identificador para o provedor de tempo. A função TimeProvOpen recebe esse identificador.

[in] eCmd

O comando a ser enviado. Esse parâmetro pode usar um dos valores a seguir.

Comando Significado
TPC_GetSamples
 O provedor de tempo deve retornar as amostras de tempo coletadas. Se não houver dados disponíveis, o provedor não deverá retornar amostras. Para obter mais detalhes, confira Comentários.

O parâmetro pvArgs é um ponteiro para uma estrutura TpcGetSamplesArgs . O gerenciador de provedores de tempo fornece o buffer para os exemplos. Se o buffer pvArgs for muito pequeno, o provedor deverá fornecer o máximo de amostras possível e retornar ERROR_INSUFFICIENT_BUFFER. Quaisquer outros códigos de erro retornados pelo provedor são ignorados.
TPC_NetTopoChange
 A topologia de rede foi alterada. Os provedores de rede devem redefinir as configurações de rede e verificar se podem acessar suas fontes.

O parâmetro pvArgs indica se a alteração foi solicitada pelo usuário (NTC_UserRequested) ou pelo sistema (NTC_Default).
TPC_Query
 Reservado para uso futuro.
TPC_PollIntervalChanged
 O intervalo de sondagem foi alterado. O provedor de tempo deve chamar a função GetTimeSysInfo para recuperar o novo valor.

O parâmetro pvArgs não é usado. Qualquer erro retornado pelo provedor é ignorado.
TPC_Shutdown
 O sistema está sendo desligado. O provedor de tempo deve sair dentro de cinco segundos.

O parâmetro pvArgs não é usado.
TPC_TimeJumped
 O relógio do sistema foi ajustado abruptamente, portanto, o provedor de tempo deve descartar quaisquer carimbos de data/hora salvos.

O parâmetro pvArgs indica se o salto no tempo foi solicitado pelo usuário (TJF_UserRequested) ou pelo sistema (TJF_Default).
TPC_UpdateConfig
 O provedor de tempo deve verificar se os dados de configuração específicos do aplicativo armazenados no registro foram alterados.

O parâmetro pvArgs não é usado. Qualquer erro retornado pelo provedor é ignorado.

[in] pvArgs

Um ponteiro para um buffer que especifica informações de comando. O formato desses dados depende do valor de eCmd.

Retornar valor

Se a função for bem-sucedida, o valor retornado será S_OK. Caso contrário, o valor retornado será um dos códigos de erro definidos em WinError.h.

Comentários

O provedor de tempo nunca deve levar mais de meio segundo para retornar dessa chamada.

Ao processar o comando TPC_GetSamples, o provedor deve retornar um exemplo para cada fonte que está monitorando. Portanto, um provedor de hardware deve retornar uma amostra, enquanto um provedor de rede como o NTP pode retornar vários exemplos. O provedor não deve retornar vários exemplos de uma única fonte; ele deve retornar a melhor amostra de seu cache de exemplos para a origem. O provedor pode retornar o mesmo exemplo em chamadas subsequentes, desde que os dados não sejam alterados.

Exemplos

Para obter um exemplo, consulte Provedor de Tempo de Exemplo.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho timeprov.h

Confira também

GetTimeSysInfoFunc

TimeProvOpen

TpcGetSamplesArgs