SetSystemTimeAdjustment
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL SetSystemTimeAdjustment(
DWORD dwTimeAdjustment,
BOOL bTimeAdjustmentDisabled
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| dwTimeAdjustment | DWORD | in | この値は、実際に経過する lpTimeIncrement の期間ごとにシステム時刻へ加算される 100 ナノ秒単位の数を表します。lpTimeIncrement の値を取得するには GetSystemTimeAdjustment を呼び出します。「解説」を参照してください。 注意
現在、Windows Vista および Windows 7 のマシンでは、16 未満に設定された時刻調整は失われます。 |
| bTimeAdjustmentDisabled | BOOL | in | システムが使用する時刻調整モードです。定期的なシステム時刻調整は、無効または有効にできます。 TRUE を指定すると、定期的な時刻調整は無効になります。無効の場合、dwTimeAdjustment の値は無視され、システムは独自の内部時刻同期メカニズムを使用して時刻を調整することがあります。これらの内部時刻同期メカニズムは、システムの通常動作の過程で時刻クロックを変化させることがあり、システムが必要と判断した場合には時刻の顕著な飛びを伴うこともあります。 FALSE を指定すると、定期的な時刻調整が有効になり、時刻クロックの調整に使用されます。システムは時刻調整の仕組みに干渉せず、独自に時刻を同期しようとはしません。 |
戻り値の型: BOOL
公式ドキュメント
システムの時刻クロックに対する定期的な時刻調整を有効または無効にします。有効にした場合、この時刻調整を使用して、他の時刻情報ソースと時刻を同期させることができます。(SetSystemTimeAdjustment)
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには GetLastError を呼び出します。この関数が失敗する原因の 1 つとして、呼び出し元が SE_SYSTEMTIME_NAME 特権を保持していない場合があります。
解説(Remarks)
GetSystemTimeAdjustment 関数および SetSystemTimeAdjustment 関数は、GetSystemTime および GetLocalTime を介して報告される時刻クロックを、定期的な時刻調整によって別の時刻ソースと同期させるアルゴリズムをサポートします。
SetSystemTimeAdjustment 関数は、時刻同期の 2 つのモードをサポートします。
| モード | 動作 |
|---|---|
| 時刻調整無効 | このモードでは、bTimeAdjustmentDisabled を TRUE に設定します。このモードでは、dwTimeAdjustment の値は無視され、システムは独自の内部時刻同期メカニズムを使用して時刻を調整することがあります。これらの内部時刻同期メカニズムは、システムの通常動作の過程で時刻クロックを変化させることがあり、システムが必要と判断した場合には時刻の顕著な飛びを伴うこともあります。 |
| 時刻調整有効 |
このモードでは、bTimeAdjustmentDisabled を FALSE に設定します。実際に経過する lpTimeIncrement の期間ごとに、dwTimeAdjustment が時刻に加算されます。lpTimeIncrement が表す期間は、GetSystemTimeAdjustment を呼び出すことで取得できます。lpTimeIncrement の値はシステム起動時にシステムによって固定され、システムの動作中に変化することはなく、任意の時点におけるシステム内部のクロック割り込み分解能とは完全に独立しています。このため、lpTimeIncrement の値は、dwTimeAdjustment がシステムの時刻クロックに適用される期間を表しているにすぎません。
dwTimeAdjustment の値が lpTimeIncrement より小さい場合、時刻クロックは通常より遅い速度で進みます。dwTimeAdjustment の値が lpTimeIncrement より大きい場合、時刻クロックは通常より速い速度で進みます。時刻クロックがどの程度速くまたは遅く進むかは、dwTimeAdjustment の値が lpTimeIncrement の値をどれだけ上回るか、または下回るかによって決まります。dwTimeAdjustment が lpTimeIncrement と等しい場合、時刻クロックは通常の速度で進みます。 |
この関数を成功させるには、アプリケーションがシステム時刻特権 (SE_SYSTEMTIME_NAME 特権) を持っている必要があります。SE_SYSTEMTIME_NAME 特権は既定で無効になっています。SetSystemTimeAdjustment を呼び出す前に AdjustTokenPrivileges 関数を使用して特権を有効にし、SetSystemTimeAdjustment の呼び出し後に特権を無効にしてください。詳細については、Running with Special Privileges を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL SetSystemTimeAdjustment(
DWORD dwTimeAdjustment,
BOOL bTimeAdjustmentDisabled
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetSystemTimeAdjustment(
uint dwTimeAdjustment, // DWORD
bool bTimeAdjustmentDisabled // BOOL
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetSystemTimeAdjustment(
dwTimeAdjustment As UInteger, ' DWORD
bTimeAdjustmentDisabled As Boolean ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' dwTimeAdjustment : DWORD
' bTimeAdjustmentDisabled : BOOL
Declare PtrSafe Function SetSystemTimeAdjustment Lib "kernel32" ( _
ByVal dwTimeAdjustment As Long, _
ByVal bTimeAdjustmentDisabled As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetSystemTimeAdjustment = ctypes.windll.kernel32.SetSystemTimeAdjustment
SetSystemTimeAdjustment.restype = wintypes.BOOL
SetSystemTimeAdjustment.argtypes = [
wintypes.DWORD, # dwTimeAdjustment : DWORD
wintypes.BOOL, # bTimeAdjustmentDisabled : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetSystemTimeAdjustment = Fiddle::Function.new(
lib['SetSystemTimeAdjustment'],
[
-Fiddle::TYPE_INT, # dwTimeAdjustment : DWORD
Fiddle::TYPE_INT, # bTimeAdjustmentDisabled : BOOL
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SetSystemTimeAdjustment(
dwTimeAdjustment: u32, // DWORD
bTimeAdjustmentDisabled: i32 // BOOL
) -> 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 SetSystemTimeAdjustment(uint dwTimeAdjustment, bool bTimeAdjustmentDisabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetSystemTimeAdjustment' -Namespace Win32 -PassThru
# $api::SetSystemTimeAdjustment(dwTimeAdjustment, bTimeAdjustmentDisabled)#uselib "KERNEL32.dll"
#func global SetSystemTimeAdjustment "SetSystemTimeAdjustment" sptr, sptr
; SetSystemTimeAdjustment dwTimeAdjustment, bTimeAdjustmentDisabled ; 戻り値は stat
; dwTimeAdjustment : DWORD -> "sptr"
; bTimeAdjustmentDisabled : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SetSystemTimeAdjustment "SetSystemTimeAdjustment" int, int
; res = SetSystemTimeAdjustment(dwTimeAdjustment, bTimeAdjustmentDisabled)
; dwTimeAdjustment : DWORD -> "int"
; bTimeAdjustmentDisabled : BOOL -> "int"; BOOL SetSystemTimeAdjustment(DWORD dwTimeAdjustment, BOOL bTimeAdjustmentDisabled)
#uselib "KERNEL32.dll"
#cfunc global SetSystemTimeAdjustment "SetSystemTimeAdjustment" int, int
; res = SetSystemTimeAdjustment(dwTimeAdjustment, bTimeAdjustmentDisabled)
; dwTimeAdjustment : DWORD -> "int"
; bTimeAdjustmentDisabled : BOOL -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetSystemTimeAdjustment = kernel32.NewProc("SetSystemTimeAdjustment")
)
// dwTimeAdjustment (DWORD), bTimeAdjustmentDisabled (BOOL)
r1, _, err := procSetSystemTimeAdjustment.Call(
uintptr(dwTimeAdjustment),
uintptr(bTimeAdjustmentDisabled),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetSystemTimeAdjustment(
dwTimeAdjustment: DWORD; // DWORD
bTimeAdjustmentDisabled: BOOL // BOOL
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetSystemTimeAdjustment';result := DllCall("KERNEL32\SetSystemTimeAdjustment"
, "UInt", dwTimeAdjustment ; DWORD
, "Int", bTimeAdjustmentDisabled ; BOOL
, "Int") ; return: BOOL●SetSystemTimeAdjustment(dwTimeAdjustment, bTimeAdjustmentDisabled) = DLL("KERNEL32.dll", "bool SetSystemTimeAdjustment(dword, bool)")
# 呼び出し: SetSystemTimeAdjustment(dwTimeAdjustment, bTimeAdjustmentDisabled)
# dwTimeAdjustment : DWORD -> "dword"
# bTimeAdjustmentDisabled : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SetSystemTimeAdjustment(
dwTimeAdjustment: u32, // DWORD
bTimeAdjustmentDisabled: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;proc SetSystemTimeAdjustment(
dwTimeAdjustment: uint32, # DWORD
bTimeAdjustmentDisabled: int32 # BOOL
): int32 {.importc: "SetSystemTimeAdjustment", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int SetSystemTimeAdjustment(
uint dwTimeAdjustment, // DWORD
int bTimeAdjustmentDisabled // BOOL
);ccall((:SetSystemTimeAdjustment, "KERNEL32.dll"), stdcall, Int32,
(UInt32, Int32),
dwTimeAdjustment, bTimeAdjustmentDisabled)
# dwTimeAdjustment : DWORD -> UInt32
# bTimeAdjustmentDisabled : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetSystemTimeAdjustment(
uint32_t dwTimeAdjustment,
int32_t bTimeAdjustmentDisabled);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetSystemTimeAdjustment(dwTimeAdjustment, bTimeAdjustmentDisabled)
-- dwTimeAdjustment : DWORD
-- bTimeAdjustmentDisabled : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetSystemTimeAdjustment = lib.func('__stdcall', 'SetSystemTimeAdjustment', 'int32_t', ['uint32_t', 'int32_t']);
// SetSystemTimeAdjustment(dwTimeAdjustment, bTimeAdjustmentDisabled)
// dwTimeAdjustment : DWORD -> 'uint32_t'
// bTimeAdjustmentDisabled : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetSystemTimeAdjustment: { parameters: ["u32", "i32"], result: "i32" },
});
// lib.symbols.SetSystemTimeAdjustment(dwTimeAdjustment, bTimeAdjustmentDisabled)
// dwTimeAdjustment : DWORD -> "u32"
// bTimeAdjustmentDisabled : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetSystemTimeAdjustment(
uint32_t dwTimeAdjustment,
int32_t bTimeAdjustmentDisabled);
C, "KERNEL32.dll");
// $ffi->SetSystemTimeAdjustment(dwTimeAdjustment, bTimeAdjustmentDisabled);
// dwTimeAdjustment : DWORD
// bTimeAdjustmentDisabled : BOOL
// 構造体/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 SetSystemTimeAdjustment(
int dwTimeAdjustment, // DWORD
boolean bTimeAdjustmentDisabled // BOOL
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SetSystemTimeAdjustment = SetSystemTimeAdjustment(
dwTimeAdjustment : UInt32, # DWORD
bTimeAdjustmentDisabled : Int32 # BOOL
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetSystemTimeAdjustmentNative = Int32 Function(Uint32, Int32);
typedef SetSystemTimeAdjustmentDart = int Function(int, int);
final SetSystemTimeAdjustment = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetSystemTimeAdjustmentNative, SetSystemTimeAdjustmentDart>('SetSystemTimeAdjustment');
// dwTimeAdjustment : DWORD -> Uint32
// bTimeAdjustmentDisabled : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetSystemTimeAdjustment(
dwTimeAdjustment: DWORD; // DWORD
bTimeAdjustmentDisabled: BOOL // BOOL
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetSystemTimeAdjustment';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetSystemTimeAdjustment"
c_SetSystemTimeAdjustment :: Word32 -> CInt -> IO CInt
-- dwTimeAdjustment : DWORD -> Word32
-- bTimeAdjustmentDisabled : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setsystemtimeadjustment =
foreign "SetSystemTimeAdjustment"
(uint32_t @-> int32_t @-> returning int32_t)
(* dwTimeAdjustment : DWORD -> uint32_t *)
(* bTimeAdjustmentDisabled : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("SetSystemTimeAdjustment" set-system-time-adjustment :convention :stdcall) :int32
(dw-time-adjustment :uint32) ; DWORD
(b-time-adjustment-disabled :int32)) ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetSystemTimeAdjustment = Win32::API::More->new('KERNEL32',
'BOOL SetSystemTimeAdjustment(DWORD dwTimeAdjustment, BOOL bTimeAdjustmentDisabled)');
# my $ret = $SetSystemTimeAdjustment->Call($dwTimeAdjustment, $bTimeAdjustmentDisabled);
# dwTimeAdjustment : DWORD -> DWORD
# bTimeAdjustmentDisabled : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f AdjustTokenPrivileges — アクセストークン内の特権を有効化または無効化する。
- f GetLocalTime — 現在のローカル日時を取得する。
- f GetSystemTime — 現在の協定世界時を取得する。
- f GetSystemTimeAdjustment — システム時刻の周期的調整値と分解能を取得する。