Win32 API 日本語リファレンス
ホームSystem.SystemInformation › GetSystemTimeAdjustment

GetSystemTimeAdjustment

関数
システム時刻の周期的調整値と分解能を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL GetSystemTimeAdjustment(
    DWORD* lpTimeAdjustment,
    DWORD* lpTimeIncrement,
    BOOL* lpTimeAdjustmentDisabled
);

パラメーター

名前方向説明
lpTimeAdjustmentDWORD*outシステムがカウントする実際に経過した期間ごとに時刻クロックへ加算される lpTimeIncrement の 100 ナノ秒単位の数を、関数が設定する変数へのポインターです。この値は lpTimeAdjustmentDisabledFALSE の場合にのみ意味を持ちます。
lpTimeIncrementDWORD*outシステムが時刻クロックに lpTimeAdjustment を加算する間隔(100 ナノ秒単位)を、関数が設定する変数へのポインターです。この値は lpTimeAdjustmentDisabledFALSE の場合にのみ意味を持ちます。
lpTimeAdjustmentDisabledBOOL*out

定期的な時刻調整が有効かどうかを示すために、関数が設定する変数へのポインターです。

TRUE は定期的な時刻調整が無効であり、システムの時刻クロックが通常の速度で進むことを示します。このモードでは、システムは独自の内部時刻同期メカニズムを使用して時刻を調整する場合があります。これらの内部時刻同期メカニズムにより、システムの通常動作中に時刻クロックが変更されることがあり、システムが必要と判断した場合には時刻の顕著な飛びを含むことがあります。

FALSE は定期的な時刻調整が時刻クロックの調整に使用されていることを示します。実際に経過する lpTimeIncrement の期間ごとに、lpTimeAdjustment が時刻に加算されます。 lpTimeAdjustment の値が lpTimeIncrement より小さい場合、システムの時刻クロックは通常より遅い速度で進みます。lpTimeAdjustment の値が lpTimeIncrement より大きい場合、時刻クロックは通常より速い速度で進みます。lpTimeAdjustmentlpTimeIncrement と等しい場合、時刻クロックは通常の速度で進みます。 lpTimeAdjustment の値は SetSystemTimeAdjustment を呼び出すことで設定できます。lpTimeIncrement の値はシステム起動時に固定され、システム動作中に変化しません。このモードでは、システムは時刻調整の仕組みに干渉せず、他の手法によって独自に時刻を同期しようとはしません。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

GetSystemTimeAdjustment 関数と SetSystemTimeAdjustment 関数は、定期的な時刻調整を使用して、GetSystemTime および GetLocalTime によって報告される時刻クロックを別の時刻ソースと同期させたいアルゴリズムをサポートするために使用できます。

GetSystemTimeAdjustment 関数を使用すると、呼び出し元は定期的な時刻調整が有効かどうかを判定でき、有効な場合は各調整量と調整間の時間を取得できます。SetSystemTimeAdjustment 関数を使用すると、呼び出し元は定期的な時刻調整を有効または無効にし、調整する増分の値を設定できます。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL GetSystemTimeAdjustment(
    DWORD* lpTimeAdjustment,
    DWORD* lpTimeIncrement,
    BOOL* lpTimeAdjustmentDisabled
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetSystemTimeAdjustment(
    out uint lpTimeAdjustment,   // DWORD* out
    out uint lpTimeIncrement,   // DWORD* out
    out bool lpTimeAdjustmentDisabled   // BOOL* out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetSystemTimeAdjustment(
    <Out> ByRef lpTimeAdjustment As UInteger,   ' DWORD* out
    <Out> ByRef lpTimeIncrement As UInteger,   ' DWORD* out
    <Out> ByRef lpTimeAdjustmentDisabled As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpTimeAdjustment : DWORD* out
' lpTimeIncrement : DWORD* out
' lpTimeAdjustmentDisabled : BOOL* out
Declare PtrSafe Function GetSystemTimeAdjustment Lib "kernel32" ( _
    ByRef lpTimeAdjustment As Long, _
    ByRef lpTimeIncrement As Long, _
    ByRef lpTimeAdjustmentDisabled As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetSystemTimeAdjustment = ctypes.windll.kernel32.GetSystemTimeAdjustment
GetSystemTimeAdjustment.restype = wintypes.BOOL
GetSystemTimeAdjustment.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpTimeAdjustment : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # lpTimeIncrement : DWORD* 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('KERNEL32.dll')
GetSystemTimeAdjustment = Fiddle::Function.new(
  lib['GetSystemTimeAdjustment'],
  [
    Fiddle::TYPE_VOIDP,  # lpTimeAdjustment : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpTimeIncrement : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpTimeAdjustmentDisabled : BOOL* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetSystemTimeAdjustment(
        lpTimeAdjustment: *mut u32,  // DWORD* out
        lpTimeIncrement: *mut u32,  // DWORD* out
        lpTimeAdjustmentDisabled: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetSystemTimeAdjustment(out uint lpTimeAdjustment, out uint lpTimeIncrement, out bool lpTimeAdjustmentDisabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetSystemTimeAdjustment' -Namespace Win32 -PassThru
# $api::GetSystemTimeAdjustment(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)
#uselib "KERNEL32.dll"
#func global GetSystemTimeAdjustment "GetSystemTimeAdjustment" sptr, sptr, sptr
; GetSystemTimeAdjustment varptr(lpTimeAdjustment), varptr(lpTimeIncrement), varptr(lpTimeAdjustmentDisabled)   ; 戻り値は stat
; lpTimeAdjustment : DWORD* out -> "sptr"
; lpTimeIncrement : DWORD* out -> "sptr"
; lpTimeAdjustmentDisabled : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetSystemTimeAdjustment "GetSystemTimeAdjustment" var, var, var
; res = GetSystemTimeAdjustment(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)
; lpTimeAdjustment : DWORD* out -> "var"
; lpTimeIncrement : DWORD* out -> "var"
; lpTimeAdjustmentDisabled : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetSystemTimeAdjustment(DWORD* lpTimeAdjustment, DWORD* lpTimeIncrement, BOOL* lpTimeAdjustmentDisabled)
#uselib "KERNEL32.dll"
#cfunc global GetSystemTimeAdjustment "GetSystemTimeAdjustment" var, var, var
; res = GetSystemTimeAdjustment(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)
; lpTimeAdjustment : DWORD* out -> "var"
; lpTimeIncrement : DWORD* out -> "var"
; lpTimeAdjustmentDisabled : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetSystemTimeAdjustment = kernel32.NewProc("GetSystemTimeAdjustment")
)

// lpTimeAdjustment (DWORD* out), lpTimeIncrement (DWORD* out), lpTimeAdjustmentDisabled (BOOL* out)
r1, _, err := procGetSystemTimeAdjustment.Call(
	uintptr(lpTimeAdjustment),
	uintptr(lpTimeIncrement),
	uintptr(lpTimeAdjustmentDisabled),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetSystemTimeAdjustment(
  lpTimeAdjustment: Pointer;   // DWORD* out
  lpTimeIncrement: Pointer;   // DWORD* out
  lpTimeAdjustmentDisabled: Pointer   // BOOL* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetSystemTimeAdjustment';
result := DllCall("KERNEL32\GetSystemTimeAdjustment"
    , "Ptr", lpTimeAdjustment   ; DWORD* out
    , "Ptr", lpTimeIncrement   ; DWORD* out
    , "Ptr", lpTimeAdjustmentDisabled   ; BOOL* out
    , "Int")   ; return: BOOL
●GetSystemTimeAdjustment(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled) = DLL("KERNEL32.dll", "bool GetSystemTimeAdjustment(void*, void*, void*)")
# 呼び出し: GetSystemTimeAdjustment(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)
# lpTimeAdjustment : DWORD* out -> "void*"
# lpTimeIncrement : DWORD* out -> "void*"
# lpTimeAdjustmentDisabled : BOOL* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetSystemTimeAdjustment(
    lpTimeAdjustment: [*c]u32, // DWORD* out
    lpTimeIncrement: [*c]u32, // DWORD* out
    lpTimeAdjustmentDisabled: [*c]i32 // BOOL* out
) callconv(std.os.windows.WINAPI) i32;
proc GetSystemTimeAdjustment(
    lpTimeAdjustment: ptr uint32,  # DWORD* out
    lpTimeIncrement: ptr uint32,  # DWORD* out
    lpTimeAdjustmentDisabled: ptr int32  # BOOL* out
): int32 {.importc: "GetSystemTimeAdjustment", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetSystemTimeAdjustment(
    uint* lpTimeAdjustment,   // DWORD* out
    uint* lpTimeIncrement,   // DWORD* out
    int* lpTimeAdjustmentDisabled   // BOOL* out
);
ccall((:GetSystemTimeAdjustment, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{UInt32}, Ptr{UInt32}, Ptr{Int32}),
      lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)
# lpTimeAdjustment : DWORD* out -> Ptr{UInt32}
# lpTimeIncrement : DWORD* out -> Ptr{UInt32}
# lpTimeAdjustmentDisabled : BOOL* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetSystemTimeAdjustment(
    uint32_t* lpTimeAdjustment,
    uint32_t* lpTimeIncrement,
    int32_t* lpTimeAdjustmentDisabled);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetSystemTimeAdjustment(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)
-- lpTimeAdjustment : DWORD* out
-- lpTimeIncrement : DWORD* out
-- lpTimeAdjustmentDisabled : BOOL* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetSystemTimeAdjustment = lib.func('__stdcall', 'GetSystemTimeAdjustment', 'int32_t', ['uint32_t *', 'uint32_t *', 'int32_t *']);
// GetSystemTimeAdjustment(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)
// lpTimeAdjustment : DWORD* out -> 'uint32_t *'
// lpTimeIncrement : DWORD* out -> 'uint32_t *'
// lpTimeAdjustmentDisabled : BOOL* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetSystemTimeAdjustment: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetSystemTimeAdjustment(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled)
// lpTimeAdjustment : DWORD* out -> "pointer"
// lpTimeIncrement : DWORD* out -> "pointer"
// lpTimeAdjustmentDisabled : BOOL* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetSystemTimeAdjustment(
    uint32_t* lpTimeAdjustment,
    uint32_t* lpTimeIncrement,
    int32_t* lpTimeAdjustmentDisabled);
C, "KERNEL32.dll");
// $ffi->GetSystemTimeAdjustment(lpTimeAdjustment, lpTimeIncrement, lpTimeAdjustmentDisabled);
// lpTimeAdjustment : DWORD* out
// lpTimeIncrement : DWORD* out
// lpTimeAdjustmentDisabled : BOOL* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean GetSystemTimeAdjustment(
        IntByReference lpTimeAdjustment,   // DWORD* out
        IntByReference lpTimeIncrement,   // DWORD* out
        IntByReference lpTimeAdjustmentDisabled   // BOOL* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetSystemTimeAdjustment = GetSystemTimeAdjustment(
    lpTimeAdjustment : UInt32*,   # DWORD* out
    lpTimeIncrement : UInt32*,   # DWORD* out
    lpTimeAdjustmentDisabled : Int32*   # BOOL* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetSystemTimeAdjustmentNative = Int32 Function(Pointer<Uint32>, Pointer<Uint32>, Pointer<Int32>);
typedef GetSystemTimeAdjustmentDart = int Function(Pointer<Uint32>, Pointer<Uint32>, Pointer<Int32>);
final GetSystemTimeAdjustment = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetSystemTimeAdjustmentNative, GetSystemTimeAdjustmentDart>('GetSystemTimeAdjustment');
// lpTimeAdjustment : DWORD* out -> Pointer<Uint32>
// lpTimeIncrement : DWORD* out -> Pointer<Uint32>
// lpTimeAdjustmentDisabled : BOOL* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetSystemTimeAdjustment(
  lpTimeAdjustment: Pointer;   // DWORD* out
  lpTimeIncrement: Pointer;   // DWORD* out
  lpTimeAdjustmentDisabled: Pointer   // BOOL* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetSystemTimeAdjustment';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetSystemTimeAdjustment"
  c_GetSystemTimeAdjustment :: Ptr Word32 -> Ptr Word32 -> Ptr CInt -> IO CInt
-- lpTimeAdjustment : DWORD* out -> Ptr Word32
-- lpTimeIncrement : DWORD* out -> Ptr Word32
-- lpTimeAdjustmentDisabled : BOOL* out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getsystemtimeadjustment =
  foreign "GetSystemTimeAdjustment"
    ((ptr uint32_t) @-> (ptr uint32_t) @-> (ptr int32_t) @-> returning int32_t)
(* lpTimeAdjustment : DWORD* out -> (ptr uint32_t) *)
(* lpTimeIncrement : DWORD* out -> (ptr uint32_t) *)
(* lpTimeAdjustmentDisabled : BOOL* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetSystemTimeAdjustment" get-system-time-adjustment :convention :stdcall) :int32
  (lp-time-adjustment :pointer)   ; DWORD* out
  (lp-time-increment :pointer)   ; DWORD* out
  (lp-time-adjustment-disabled :pointer))   ; BOOL* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetSystemTimeAdjustment = Win32::API::More->new('KERNEL32',
    'BOOL GetSystemTimeAdjustment(LPVOID lpTimeAdjustment, LPVOID lpTimeIncrement, LPVOID lpTimeAdjustmentDisabled)');
# my $ret = $GetSystemTimeAdjustment->Call($lpTimeAdjustment, $lpTimeIncrement, $lpTimeAdjustmentDisabled);
# lpTimeAdjustment : DWORD* out -> LPVOID
# lpTimeIncrement : DWORD* out -> LPVOID
# lpTimeAdjustmentDisabled : BOOL* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目