ホーム › Networking.WinHttp › WinHttpTimeToSystemTime

WinHttpTimeToSystemTime

関数

HTTP日付形式の文字列をSYSTEMTIMEに変換する。

DLLWINHTTP.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL WinHttpTimeToSystemTime(
    LPCWSTR pwszTime,
    SYSTEMTIME* pst
);

パラメーター

名前	型	方向	説明
pwszTime	LPCWSTR	in	変換する、null で終わる日時文字列へのポインター。この値は RFC2616 のセクション 3.3 で定義された形式を使用する必要があります。
pst	SYSTEMTIME*	out	変換後の時刻を受け取る SYSTEMTIME 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

WinHttpTimeToSystemTime 関数は、HTTP の日時文字列を受け取り、SYSTEMTIME 構造体に変換します。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。返されるエラーコードには次のものがあります。

エラーコード	説明
ERROR_WINHTTP_INTERNAL_ERROR	内部エラーが発生しました。

解説(Remarks)

WinHTTP を非同期モードで使用している場合(つまり WinHttpOpen で WINHTTP_FLAG_ASYNC が設定されている場合)でも、この関数は同期的に動作します。戻り値は成功または失敗を示します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

注意 Windows XP および Windows 2000 については、WinHttp スタートページの Run-Time Requirements セクションを参照してください。

例

この例では、HTTP 形式の日付を SYSTEMTIME 構造体に変換する方法を示します。

    SYSTEMTIME  sTime;
    LPCWSTR     pwszTimeStr = L"Tue, 21 Nov 2000 01:06:53 GMT";

    // Convert the HTTP string to a SYSTEMTIME structure.
    if (!WinHttpTimeToSystemTime( pwszTimeStr, &sTime))
    {
        printf( "Error %u in WinHttpTimeToSystemTime.\n", GetLastError());
    }
    else
    {
        // Print the date.
        printf( "The U.S. formatted date is (%u/%u/%u)\n", 
                sTime.wMonth, sTime.wDay, sTime.wYear);
    }

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

各言語での呼び出し定義

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

BOOL WinHttpTimeToSystemTime(
    LPCWSTR pwszTime,
    SYSTEMTIME* pst
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpTimeToSystemTime(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszTime,   // LPCWSTR
    IntPtr pst   // SYSTEMTIME* out
);

<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpTimeToSystemTime(
    <MarshalAs(UnmanagedType.LPWStr)> pwszTime As String,   ' LPCWSTR
    pst As IntPtr   ' SYSTEMTIME* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pwszTime : LPCWSTR
' pst : SYSTEMTIME* out
Declare PtrSafe Function WinHttpTimeToSystemTime Lib "winhttp" ( _
    ByVal pwszTime As LongPtr, _
    ByVal pst As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinHttpTimeToSystemTime = ctypes.windll.winhttp.WinHttpTimeToSystemTime
WinHttpTimeToSystemTime.restype = wintypes.BOOL
WinHttpTimeToSystemTime.argtypes = [
    wintypes.LPCWSTR,  # pwszTime : LPCWSTR
    ctypes.c_void_p,  # pst : SYSTEMTIME* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpTimeToSystemTime = Fiddle::Function.new(
  lib['WinHttpTimeToSystemTime'],
  [
    Fiddle::TYPE_VOIDP,  # pwszTime : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pst : SYSTEMTIME* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winhttp")]
extern "system" {
    fn WinHttpTimeToSystemTime(
        pwszTime: *const u16,  // LPCWSTR
        pst: *mut SYSTEMTIME  // SYSTEMTIME* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern bool WinHttpTimeToSystemTime([MarshalAs(UnmanagedType.LPWStr)] string pwszTime, IntPtr pst);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpTimeToSystemTime' -Namespace Win32 -PassThru
# $api::WinHttpTimeToSystemTime(pwszTime, pst)

#uselib "WINHTTP.dll"
#func global WinHttpTimeToSystemTime "WinHttpTimeToSystemTime" sptr, sptr
; WinHttpTimeToSystemTime pwszTime, varptr(pst)   ; 戻り値は stat
; pwszTime : LPCWSTR -> "sptr"
; pst : SYSTEMTIME* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINHTTP.dll"
#cfunc global WinHttpTimeToSystemTime "WinHttpTimeToSystemTime" wstr, var
; res = WinHttpTimeToSystemTime(pwszTime, pst)
; pwszTime : LPCWSTR -> "wstr"
; pst : SYSTEMTIME* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINHTTP.dll"
#cfunc global WinHttpTimeToSystemTime "WinHttpTimeToSystemTime" wstr, sptr
; res = WinHttpTimeToSystemTime(pwszTime, varptr(pst))
; pwszTime : LPCWSTR -> "wstr"
; pst : SYSTEMTIME* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。