GetDurationFormat

関数

指定ロケールに従い期間を文字列へ整形する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT GetDurationFormat(
    DWORD Locale,
    DWORD dwFlags,
    const SYSTEMTIME* lpDuration,   // optional
    ULONGLONG ullDuration,
    LPCWSTR lpFormat,   // optional
    LPWSTR lpDurationStr,   // optional
    INT cchDuration
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	この関数が期間を書式設定する対象のロケールを指定するロケール識別子。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT Windows Vista 以降: 次のカスタムロケール識別子もサポートされています。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED
dwFlags	DWORD	in	関数のオプションを指定するフラグ。lpFormat が NULL に設定されていない場合、このパラメーターは 0 に設定する必要があります。lpFormat が NULL に設定されている場合、アプリケーションは LOCALE_NOUSEROVERRIDE を指定して、指定されたロケールのシステム既定の期間書式を使用して文字列を書式設定できます。注意 LOCALE_NOUSEROVERRIDE はユーザー設定を無効にするため、その使用は強く推奨されません。
lpDuration	SYSTEMTIME*	inoptional	書式設定する時間の長さ(期間)の情報を含む SYSTEMTIME 構造体へのポインター。このポインターが NULL の場合、関数はこのパラメーターを無視し、ullDuration を使用します。
ullDuration	ULONGLONG	in	期間に含まれる 100 ナノ秒間隔の数を表す 64 ビット符号なし整数。lpDuration と ullDuration の両方が存在する場合は、lpDuration が優先されます。lpDuration が NULL に設定され、ullDuration が 0 に設定されている場合、期間は 0 になります。
lpFormat	LPCWSTR	inoptional	書式文字列へのポインター。詳細については、GetDurationFormatEx の lpFormat パラメーターを参照してください。
lpDurationStr	LPWSTR	outoptional	関数が期間文字列を取得するバッファーへのポインター。あるいは、cchDuration が 0 に設定されている場合、このパラメーターに NULL を指定できます。この場合、関数は期間文字列バッファーに必要なサイズを返します。
cchDuration	INT	in	lpDurationStr で示されるバッファーのサイズ(文字数)。あるいは、アプリケーションはこのパラメーターを 0 に設定できます。この場合、関数は lpDurationStr に NULL を取得し、期間文字列バッファーに必要なサイズを返します。

戻り値の型: INT

公式ドキュメント

識別子で指定されたロケールに対して、時間の長さ(期間)を時刻文字列として書式設定します。

戻り値

成功した場合、lpDurationStr で示されるバッファーに取得された文字数を返します。lpDurationStr が NULL に設定され、cchDuration が 0 に設定されている場合、関数は終端の null 文字を含む、期間文字列バッファーに必要なサイズを返します。たとえば、10 文字がバッファーに書き込まれる場合、関数は終端の null 文字を含めて 11 を返します。

関数が成功しなかった場合は 0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができます。これは次のエラーコードのいずれかを返す可能性があります。

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分な大きさでなかったか、誤って NULL に設定されていました。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

「解説」については、GetDurationFormatEx を参照してください。

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

各言語での呼び出し定義

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

INT GetDurationFormat(
    DWORD Locale,
    DWORD dwFlags,
    const SYSTEMTIME* lpDuration,   // optional
    ULONGLONG ullDuration,
    LPCWSTR lpFormat,   // optional
    LPWSTR lpDurationStr,   // optional
    INT cchDuration
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetDurationFormat(
    uint Locale,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr lpDuration,   // SYSTEMTIME* optional
    ulong ullDuration,   // ULONGLONG
    [MarshalAs(UnmanagedType.LPWStr)] string lpFormat,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDurationStr,   // LPWSTR optional, out
    int cchDuration   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDurationFormat(
    Locale As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    lpDuration As IntPtr,   ' SYSTEMTIME* optional
    ullDuration As ULong,   ' ULONGLONG
    <MarshalAs(UnmanagedType.LPWStr)> lpFormat As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpDurationStr As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchDuration As Integer   ' INT
) As Integer
End Function

' Locale : DWORD
' dwFlags : DWORD
' lpDuration : SYSTEMTIME* optional
' ullDuration : ULONGLONG
' lpFormat : LPCWSTR optional
' lpDurationStr : LPWSTR optional, out
' cchDuration : INT
Declare PtrSafe Function GetDurationFormat Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwFlags As Long, _
    ByVal lpDuration As LongPtr, _
    ByVal ullDuration As LongLong, _
    ByVal lpFormat As LongPtr, _
    ByVal lpDurationStr As LongPtr, _
    ByVal cchDuration As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDurationFormat = ctypes.windll.kernel32.GetDurationFormat
GetDurationFormat.restype = ctypes.c_int
GetDurationFormat.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # lpDuration : SYSTEMTIME* optional
    ctypes.c_ulonglong,  # ullDuration : ULONGLONG
    wintypes.LPCWSTR,  # lpFormat : LPCWSTR optional
    wintypes.LPWSTR,  # lpDurationStr : LPWSTR optional, out
    ctypes.c_int,  # cchDuration : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetDurationFormat = Fiddle::Function.new(
  lib['GetDurationFormat'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpDuration : SYSTEMTIME* optional
    -Fiddle::TYPE_LONG_LONG,  # ullDuration : ULONGLONG
    Fiddle::TYPE_VOIDP,  # lpFormat : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpDurationStr : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchDuration : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetDurationFormat(
        Locale: u32,  // DWORD
        dwFlags: u32,  // DWORD
        lpDuration: *const SYSTEMTIME,  // SYSTEMTIME* optional
        ullDuration: u64,  // ULONGLONG
        lpFormat: *const u16,  // LPCWSTR optional
        lpDurationStr: *mut u16,  // LPWSTR optional, out
        cchDuration: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int GetDurationFormat(uint Locale, uint dwFlags, IntPtr lpDuration, ulong ullDuration, [MarshalAs(UnmanagedType.LPWStr)] string lpFormat, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDurationStr, int cchDuration);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDurationFormat' -Namespace Win32 -PassThru
# $api::GetDurationFormat(Locale, dwFlags, lpDuration, ullDuration, lpFormat, lpDurationStr, cchDuration)

#uselib "KERNEL32.dll"
#func global GetDurationFormat "GetDurationFormat" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetDurationFormat Locale, dwFlags, varptr(lpDuration), ullDuration, lpFormat, varptr(lpDurationStr), cchDuration   ; 戻り値は stat
; Locale : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpDuration : SYSTEMTIME* optional -> "sptr"
; ullDuration : ULONGLONG -> "sptr"
; lpFormat : LPCWSTR optional -> "sptr"
; lpDurationStr : LPWSTR optional, out -> "sptr"
; cchDuration : INT -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetDurationFormat "GetDurationFormat" int, int, var, int64, wstr, var, int
; res = GetDurationFormat(Locale, dwFlags, lpDuration, ullDuration, lpFormat, lpDurationStr, cchDuration)
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpDuration : SYSTEMTIME* optional -> "var"
; ullDuration : ULONGLONG -> "int64"
; lpFormat : LPCWSTR optional -> "wstr"
; lpDurationStr : LPWSTR optional, out -> "var"
; cchDuration : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "KERNEL32.dll"
#cfunc global GetDurationFormat "GetDurationFormat" int, int, sptr, int64, wstr, sptr, int
; res = GetDurationFormat(Locale, dwFlags, varptr(lpDuration), ullDuration, lpFormat, varptr(lpDurationStr), cchDuration)
; Locale : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpDuration : SYSTEMTIME* optional -> "sptr"
; ullDuration : ULONGLONG -> "int64"
; lpFormat : LPCWSTR optional -> "wstr"
; lpDurationStr : LPWSTR optional, out -> "sptr"
; cchDuration : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。