ホーム › System.SystemInformation › GetSystemTimeAdjustmentPrecise

GetSystemTimeAdjustmentPrecise

関数

システム時刻の高精度な周期的調整値と分解能を取得する。

DLLapi-ms-win-core-sysinfo-l1-2-4.dll呼出規約winapiSetLastErrorあり対応OSWindows 10 以降

シグネチャ

// api-ms-win-core-sysinfo-l1-2-4.dll
#include <windows.h>

BOOL GetSystemTimeAdjustmentPrecise(
    ULONGLONG* lpTimeAdjustment,
    ULONGLONG* lpTimeIncrement,
    BOOL* lpTimeAdjustmentDisabled
);

パラメーター

名前	型	方向	説明
lpTimeAdjustment	ULONGLONG*	out	調整後のクロック更新頻度を返します。
lpTimeIncrement	ULONGLONG*	out	クロック更新頻度を返します。
lpTimeAdjustmentDisabled	BOOL*	out	時刻調整が有効かどうかを示すインジケーターを返します。値が TRUE の場合、定期的な調整が無効であることを示します。この場合、システムは独自の内部メカニズムを使用して時刻クロックの同期を維持しようとすることがあります。これにより、時刻が定期的に「正しい時刻」へジャンプする場合があります。値が FALSE の場合、時刻を逐次調整するために定期的なプログラム制御の時刻調整が使用されており、システムが独自に時刻へ干渉したり同期を試みたりしないことを示します。

名前

型

方向

説明

lpTimeAdjustment

ULONGLONG*

out

調整後のクロック更新頻度を返します。

lpTimeIncrement

ULONGLONG*

out

クロック更新頻度を返します。

lpTimeAdjustmentDisabled

BOOL*

out

時刻調整が有効かどうかを示すインジケーターを返します。

値が TRUE の場合、定期的な調整が無効であることを示します。この場合、システムは独自の内部メカニズムを使用して時刻クロックの同期を維持しようとすることがあります。これにより、時刻が定期的に「正しい時刻」へジャンプする場合があります。

値が FALSE の場合、時刻を逐次調整するために定期的なプログラム制御の時刻調整が使用されており、システムが独自に時刻へ干渉したり同期を試みたりしないことを示します。

戻り値の型: BOOL

公式ドキュメント

システムが時刻クロックに対して定期的なプログラム制御の時刻調整を適用しているかどうかを判定し、そのような調整がある場合はその値と周期を取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数は、プログラム制御のクロック調整を使用して時刻を別の時刻ソースと同期させるアルゴリズムで使用されます。これを行うために、システムは調整後のクロック更新頻度を計算し、この関数によって呼び出し元がその値を取得できるようにします。

注意

システム時刻の特権を有効にし、システムクロックを調整し、クロック値を表示する方法の完全なコードサンプルについては、SetSystemTimeAdjustmentPrecise を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// api-ms-win-core-sysinfo-l1-2-4.dll
#include <windows.h>

BOOL GetSystemTimeAdjustmentPrecise(
    ULONGLONG* lpTimeAdjustment,
    ULONGLONG* lpTimeIncrement,
    BOOL* lpTimeAdjustmentDisabled
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-sysinfo-l1-2-4.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetSystemTimeAdjustmentPrecise(
    out ulong lpTimeAdjustment,   // ULONGLONG* out
    out ulong lpTimeIncrement,   // ULONGLONG* out
    out bool lpTimeAdjustmentDisabled   // BOOL* out
);

<DllImport("api-ms-win-core-sysinfo-l1-2-4.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetSystemTimeAdjustmentPrecise(
    <Out> ByRef lpTimeAdjustment As ULong,   ' ULONGLONG* out
    <Out> ByRef lpTimeIncrement As ULong,   ' ULONGLONG* out
    <Out> ByRef lpTimeAdjustmentDisabled As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpTimeAdjustment : ULONGLONG* out
' lpTimeIncrement : ULONGLONG* out
' lpTimeAdjustmentDisabled : BOOL* out
Declare PtrSafe Function GetSystemTimeAdjustmentPrecise Lib "api-ms-win-core-sysinfo-l1-2-4" ( _
    ByRef lpTimeAdjustment As LongLong, _
    ByRef lpTimeIncrement As LongLong, _
    ByRef lpTimeAdjustmentDisabled As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetSystemTimeAdjustmentPrecise = ctypes.windll.LoadLibrary("api-ms-win-core-sysinfo-l1-2-4.dll").GetSystemTimeAdjustmentPrecise
GetSystemTimeAdjustmentPrecise.restype = wintypes.BOOL
GetSystemTimeAdjustmentPrecise.argtypes = [
    ctypes.POINTER(ctypes.c_ulonglong),  # lpTimeAdjustment : ULONGLONG* out
    ctypes.POINTER(ctypes.c_ulonglong),  # lpTimeIncrement : ULONGLONG* out
    ctypes.c_void_p,  # lpTimeAdjustmentDisabled : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-sysinfo-l1-2-4.dll')
GetSystemTimeAdjustmentPrecise = Fiddle::Function.new(
  lib['GetSystemTimeAdjustmentPrecise'],
  [
    Fiddle::TYPE_VOIDP,  # lpTimeAdjustment : ULONGLONG* out
    Fiddle::TYPE_VOIDP,  # lpTimeIncrement : ULONGLONG* out
    Fiddle::TYPE_VOIDP,  # lpTimeAdjustmentDisabled : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "api-ms-win-core-sysinfo-l1-2-4")]
extern "system" {
    fn GetSystemTimeAdjustmentPrecise(
        lpTimeAdjustment: *mut u64,  // ULONGLONG* out
        lpTimeIncrement: *mut u64,  // ULONGLONG* out
        lpTimeAdjustmentDisabled: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-sysinfo-l1-2-4.dll", SetLastError = true)]
public static extern bool GetSystemTimeAdjustmentPrecise(out ulong lpTimeAdjustment, out ulong lpTimeIncrement, out bool lpTimeAdjustmentDisabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-sysinfo-l1-2-4_GetSystemTimeAdjustmentPrecise' -Namespace Win32 -PassThru
# $api::GetSystemTimeAdjustmentPrecise(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)

#uselib "api-ms-win-core-sysinfo-l1-2-4.dll"
#func global GetSystemTimeAdjustmentPrecise "GetSystemTimeAdjustmentPrecise" sptr, sptr, sptr
; GetSystemTimeAdjustmentPrecise varptr(lpTimeAdjustment), varptr(lpTimeIncrement), varptr(lpTimeAdjustmentDisabled)   ; 戻り値は stat
; lpTimeAdjustment : ULONGLONG* out -> "sptr"
; lpTimeIncrement : ULONGLONG* out -> "sptr"
; lpTimeAdjustmentDisabled : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "api-ms-win-core-sysinfo-l1-2-4.dll"
#cfunc global GetSystemTimeAdjustmentPrecise "GetSystemTimeAdjustmentPrecise" var, var, var
; res = GetSystemTimeAdjustmentPrecise(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)
; lpTimeAdjustment : ULONGLONG* out -> "var"
; lpTimeIncrement : ULONGLONG* out -> "var"
; lpTimeAdjustmentDisabled : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "api-ms-win-core-sysinfo-l1-2-4.dll"
#cfunc global GetSystemTimeAdjustmentPrecise "GetSystemTimeAdjustmentPrecise" sptr, sptr, sptr
; res = GetSystemTimeAdjustmentPrecise(varptr(lpTimeAdjustment), varptr(lpTimeIncrement), varptr(lpTimeAdjustmentDisabled))
; lpTimeAdjustment : ULONGLONG* out -> "sptr"
; lpTimeIncrement : ULONGLONG* out -> "sptr"
; lpTimeAdjustmentDisabled : BOOL* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。