TimeProvCommand-Funktion (timeprov.h)

Artikel
08/26/2023

Eine Rückruffunktion, die vom Zeitanbieter-Manager aufgerufen wird, um Befehle an den Zeitanbieter zu senden.

Syntax

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

Parameter

[in] hTimeProv

Ein Handle für den Zeitanbieter. Die TimeProvOpen-Funktion empfängt dieses Handle.

[in] eCmd

Der zu sendende Befehl. Dieser Parameter kann einen der folgenden Werte annehmen.

Get-Help	Bedeutung
TPC_GetSamples	Der Zeitanbieter sollte die gesammelten Zeitproben zurückgeben. Wenn keine Daten verfügbar sind, sollte der Anbieter keine Beispiele zurückgeben. Ausführliche Informationen finden Sie unter Hinweise. Der pvArgs-Parameter ist ein Zeiger auf eine TpcGetSamplesArgs-Struktur . Der Zeitanbieter-Manager stellt den Puffer für die Beispiele bereit. Wenn der pvArgs-Puffer zu klein ist, sollte der Anbieter so viele Beispiele wie möglich bereitstellen und ERROR_INSUFFICIENT_BUFFER zurückgeben. Alle anderen Fehlercodes, die vom Anbieter zurückgegeben werden, werden ignoriert.
TPC_NetTopoChange	Die Netzwerktopologie wurde geändert. Netzwerkanbieter müssen die Netzwerkeinstellungen neu ermitteln und überprüfen, ob sie ihre Quellen erreichen können. Der parameter pvArgs gibt an, ob die Änderung vom Benutzer (NTC_UserRequested) oder vom System (NTC_Default) angefordert wurde.
TPC_Query	Für die zukünftige Verwendung reserviert.
TPC_PollIntervalChanged	Das Abrufintervall hat sich geändert. Der Zeitanbieter sollte die GetTimeSysInfo-Funktion aufrufen, um den neuen Wert abzurufen. Der parameter pvArgs wird nicht verwendet. Alle vom Anbieter zurückgegebenen Fehler werden ignoriert.
TPC_Shutdown	Das System wird heruntergefahren. Der Zeitanbieter sollte innerhalb von fünf Sekunden beendet werden. Der parameter pvArgs wird nicht verwendet.
TPC_TimeJumped	Die Systemuhr wurde abrupt angepasst, sodass der Zeitanbieter alle gespeicherten Zeitstempel verwerfen sollte. Der parameter pvArgs gibt an, ob der Zeitsprung vom Benutzer (TJF_UserRequested) oder vom System (TJF_Default) angefordert wurde.
TPC_UpdateConfig	Der Zeitanbieter sollte überprüfen, ob sich seine anwendungsspezifischen Konfigurationsdaten geändert haben, die in der Registrierung gespeichert sind. Der parameter pvArgs wird nicht verwendet. Alle vom Anbieter zurückgegebenen Fehler werden ignoriert.

[in] pvArgs

Ein Zeiger auf einen Puffer, der Befehlsinformationen angibt. Das Format dieser Daten hängt vom Wert von eCmd ab.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert S_OK. Andernfalls ist der Rückgabewert einer der in WinError.h definierten Fehlercodes.

Hinweise

Der Zeitanbieter sollte nie länger als eine halbe Sekunde dauern, um von diesem Aufruf zurückzukehren.

Bei der Verarbeitung des TPC_GetSamples-Befehls sollte der Anbieter für jede Quelle, die er überwacht, ein Beispiel zurückgeben. Daher sollte ein Hardwareanbieter ein Beispiel zurückgeben, während ein Netzwerkanbieter wie NTP mehrere Beispiele zurückgeben kann. Der Anbieter sollte nicht mehrere Stichproben aus einer einzigen Quelle zurückgeben. Es sollte das beste Beispiel aus dem Cache der Beispiele für die Quelle zurückgeben. Der Anbieter kann dasselbe Beispiel bei nachfolgenden Aufrufen zurückgeben, sofern sich die Daten nicht geändert haben.

Beispiele

Ein Beispiel finden Sie unter Beispielzeitanbieter.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	timeprov.h

Weitere Informationen

GetTimeSysInfoFunc

TimeProvOpen

TpcGetSamplesArgs

Freigeben über