StrFromTimeIntervalA
関数ミリ秒単位の時間間隔を文字列に変換する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
INT StrFromTimeIntervalA(
LPSTR pszOut,
DWORD cchMax,
DWORD dwTimeMS,
INT digits
);パラメーター
| 名前 | 型 | 方向 | 説明 | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| pszOut | LPSTR | out | バッファーへのポインター。この関数が正常に終了すると、変換された数値を受け取ります。 | |||||||||||||||||||||
| cchMax | DWORD | in | pszOut のサイズ(文字数)。cchMax に 0 を設定すると、StrFromTimeInterval は変換後の文字列を格納するために必要な文字バッファーの最小サイズを返します。この場合、pszOut には変換後の文字列は格納されません。 | |||||||||||||||||||||
| dwTimeMS | DWORD | in | 時間間隔(ミリ秒単位)。 | |||||||||||||||||||||
| digits | INT | in | pszOut に表現される有効桁数の最大値。例を以下に示します。
|
戻り値の型: INT
公式ドキュメント
ミリ秒単位で指定された時間間隔を文字列に変換します。(ANSI)
戻り値
型: int
終端の NULL 文字を除いた、pszOut の文字数を返します。
解説(Remarks)
pszOut に返される時間値は、常に hh hours mm minutes ss seconds の形式になります。24 時間を超える時間は、日や月には変換されません。秒未満の端数は無視されます。
Examples
#include <windows.h>
#include <iostream.h>
#include "Shlwapi.h"
void main(void)
{
char TimeString[256];
char *pszOut;
pszOut = TimeString;
cout << "The return value from the call to"
<< "\nthe function StrFromTimeInterval will"
<< "\nreturn the number of elements in the buffer: " << endl;
cout << "\nThe return from StrFromTimeInterval is "
<< StrFromTimeInterval(pszOut,30, 34000,30);
cout << "\nThe contents of the TimeString Buffer " << pszOut << endl;
cout << "The return from StrFromTimeInterval is "
<< StrFromTimeInterval(pszOut,30, 74000,3);
cout << "\nThe contents of the TimeString Buffer " << pszOut << endl;
cout << "The return from StrFromTimeInterval is "
<< StrFromTimeInterval(pszOut,30, 74000,2);
cout << "\nThe contents of the TimeString Buffer " << pszOut << endl;
cout << "The return from StrFromTimeInterval is "
<< StrFromTimeInterval(pszOut,30, 74000,1)
<< "\nThe contents of the TimeString Buffer " << pszOut << endl;
}
OUTPUT:
- - - - -
The return value from the call to
the function StrFromTimeInterval will
return the number of elements in the buffer:
The return from StrFromTimeInterval is 7
The contents of the TimeString Buffer 34 sec
The return from StrFromTimeInterval is 13
The contents of the TimeString Buffer 1 min 14 sec
The return from StrFromTimeInterval is 13
The contents of the TimeString Buffer 1 min 10 sec
The return from StrFromTimeInterval is 6
The contents of the TimeString Buffer 1 min
メモ
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして StrFromTimeInterval を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
INT StrFromTimeIntervalA(
LPSTR pszOut,
DWORD cchMax,
DWORD dwTimeMS,
INT digits
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int StrFromTimeIntervalA(
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszOut, // LPSTR out
uint cchMax, // DWORD
uint dwTimeMS, // DWORD
int digits // INT
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StrFromTimeIntervalA(
<MarshalAs(UnmanagedType.LPStr)> pszOut As System.Text.StringBuilder, ' LPSTR out
cchMax As UInteger, ' DWORD
dwTimeMS As UInteger, ' DWORD
digits As Integer ' INT
) As Integer
End Function' pszOut : LPSTR out
' cchMax : DWORD
' dwTimeMS : DWORD
' digits : INT
Declare PtrSafe Function StrFromTimeIntervalA Lib "shlwapi" ( _
ByVal pszOut As String, _
ByVal cchMax As Long, _
ByVal dwTimeMS As Long, _
ByVal digits As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
StrFromTimeIntervalA = ctypes.windll.shlwapi.StrFromTimeIntervalA
StrFromTimeIntervalA.restype = ctypes.c_int
StrFromTimeIntervalA.argtypes = [
wintypes.LPSTR, # pszOut : LPSTR out
wintypes.DWORD, # cchMax : DWORD
wintypes.DWORD, # dwTimeMS : DWORD
ctypes.c_int, # digits : INT
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
StrFromTimeIntervalA = Fiddle::Function.new(
lib['StrFromTimeIntervalA'],
[
Fiddle::TYPE_VOIDP, # pszOut : LPSTR out
-Fiddle::TYPE_INT, # cchMax : DWORD
-Fiddle::TYPE_INT, # dwTimeMS : DWORD
Fiddle::TYPE_INT, # digits : INT
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn StrFromTimeIntervalA(
pszOut: *mut u8, // LPSTR out
cchMax: u32, // DWORD
dwTimeMS: u32, // DWORD
digits: i32 // INT
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int StrFromTimeIntervalA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszOut, uint cchMax, uint dwTimeMS, int digits);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrFromTimeIntervalA' -Namespace Win32 -PassThru
# $api::StrFromTimeIntervalA(pszOut, cchMax, dwTimeMS, digits)#uselib "SHLWAPI.dll"
#func global StrFromTimeIntervalA "StrFromTimeIntervalA" sptr, sptr, sptr, sptr
; StrFromTimeIntervalA varptr(pszOut), cchMax, dwTimeMS, digits ; 戻り値は stat
; pszOut : LPSTR out -> "sptr"
; cchMax : DWORD -> "sptr"
; dwTimeMS : DWORD -> "sptr"
; digits : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global StrFromTimeIntervalA "StrFromTimeIntervalA" var, int, int, int ; res = StrFromTimeIntervalA(pszOut, cchMax, dwTimeMS, digits) ; pszOut : LPSTR out -> "var" ; cchMax : DWORD -> "int" ; dwTimeMS : DWORD -> "int" ; digits : INT -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global StrFromTimeIntervalA "StrFromTimeIntervalA" sptr, int, int, int ; res = StrFromTimeIntervalA(varptr(pszOut), cchMax, dwTimeMS, digits) ; pszOut : LPSTR out -> "sptr" ; cchMax : DWORD -> "int" ; dwTimeMS : DWORD -> "int" ; digits : INT -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; INT StrFromTimeIntervalA(LPSTR pszOut, DWORD cchMax, DWORD dwTimeMS, INT digits) #uselib "SHLWAPI.dll" #cfunc global StrFromTimeIntervalA "StrFromTimeIntervalA" var, int, int, int ; res = StrFromTimeIntervalA(pszOut, cchMax, dwTimeMS, digits) ; pszOut : LPSTR out -> "var" ; cchMax : DWORD -> "int" ; dwTimeMS : DWORD -> "int" ; digits : INT -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT StrFromTimeIntervalA(LPSTR pszOut, DWORD cchMax, DWORD dwTimeMS, INT digits) #uselib "SHLWAPI.dll" #cfunc global StrFromTimeIntervalA "StrFromTimeIntervalA" intptr, int, int, int ; res = StrFromTimeIntervalA(varptr(pszOut), cchMax, dwTimeMS, digits) ; pszOut : LPSTR out -> "intptr" ; cchMax : DWORD -> "int" ; dwTimeMS : DWORD -> "int" ; digits : INT -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procStrFromTimeIntervalA = shlwapi.NewProc("StrFromTimeIntervalA")
)
// pszOut (LPSTR out), cchMax (DWORD), dwTimeMS (DWORD), digits (INT)
r1, _, err := procStrFromTimeIntervalA.Call(
uintptr(pszOut),
uintptr(cchMax),
uintptr(dwTimeMS),
uintptr(digits),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction StrFromTimeIntervalA(
pszOut: PAnsiChar; // LPSTR out
cchMax: DWORD; // DWORD
dwTimeMS: DWORD; // DWORD
digits: Integer // INT
): Integer; stdcall;
external 'SHLWAPI.dll' name 'StrFromTimeIntervalA';result := DllCall("SHLWAPI\StrFromTimeIntervalA"
, "Ptr", pszOut ; LPSTR out
, "UInt", cchMax ; DWORD
, "UInt", dwTimeMS ; DWORD
, "Int", digits ; INT
, "Int") ; return: INT●StrFromTimeIntervalA(pszOut, cchMax, dwTimeMS, digits) = DLL("SHLWAPI.dll", "int StrFromTimeIntervalA(char*, dword, dword, int)")
# 呼び出し: StrFromTimeIntervalA(pszOut, cchMax, dwTimeMS, digits)
# pszOut : LPSTR out -> "char*"
# cchMax : DWORD -> "dword"
# dwTimeMS : DWORD -> "dword"
# digits : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn StrFromTimeIntervalA(
pszOut: [*c]u8, // LPSTR out
cchMax: u32, // DWORD
dwTimeMS: u32, // DWORD
digits: i32 // INT
) callconv(std.os.windows.WINAPI) i32;proc StrFromTimeIntervalA(
pszOut: ptr char, # LPSTR out
cchMax: uint32, # DWORD
dwTimeMS: uint32, # DWORD
digits: int32 # INT
): int32 {.importc: "StrFromTimeIntervalA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int StrFromTimeIntervalA(
char* pszOut, // LPSTR out
uint cchMax, // DWORD
uint dwTimeMS, // DWORD
int digits // INT
);ccall((:StrFromTimeIntervalA, "SHLWAPI.dll"), stdcall, Int32,
(Ptr{UInt8}, UInt32, UInt32, Int32),
pszOut, cchMax, dwTimeMS, digits)
# pszOut : LPSTR out -> Ptr{UInt8}
# cchMax : DWORD -> UInt32
# dwTimeMS : DWORD -> UInt32
# digits : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t StrFromTimeIntervalA(
char* pszOut,
uint32_t cchMax,
uint32_t dwTimeMS,
int32_t digits);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrFromTimeIntervalA(pszOut, cchMax, dwTimeMS, digits)
-- pszOut : LPSTR out
-- cchMax : DWORD
-- dwTimeMS : DWORD
-- digits : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const StrFromTimeIntervalA = lib.func('__stdcall', 'StrFromTimeIntervalA', 'int32_t', ['char *', 'uint32_t', 'uint32_t', 'int32_t']);
// StrFromTimeIntervalA(pszOut, cchMax, dwTimeMS, digits)
// pszOut : LPSTR out -> 'char *'
// cchMax : DWORD -> 'uint32_t'
// dwTimeMS : DWORD -> 'uint32_t'
// digits : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
StrFromTimeIntervalA: { parameters: ["buffer", "u32", "u32", "i32"], result: "i32" },
});
// lib.symbols.StrFromTimeIntervalA(pszOut, cchMax, dwTimeMS, digits)
// pszOut : LPSTR out -> "buffer"
// cchMax : DWORD -> "u32"
// dwTimeMS : DWORD -> "u32"
// digits : INT -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t StrFromTimeIntervalA(
char* pszOut,
uint32_t cchMax,
uint32_t dwTimeMS,
int32_t digits);
C, "SHLWAPI.dll");
// $ffi->StrFromTimeIntervalA(pszOut, cchMax, dwTimeMS, digits);
// pszOut : LPSTR out
// cchMax : DWORD
// dwTimeMS : DWORD
// digits : INT
// 構造体/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 Shlwapi extends StdCallLibrary {
Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
int StrFromTimeIntervalA(
byte[] pszOut, // LPSTR out
int cchMax, // DWORD
int dwTimeMS, // DWORD
int digits // INT
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun StrFromTimeIntervalA = StrFromTimeIntervalA(
pszOut : UInt8*, # LPSTR out
cchMax : UInt32, # DWORD
dwTimeMS : UInt32, # DWORD
digits : Int32 # INT
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef StrFromTimeIntervalANative = Int32 Function(Pointer<Utf8>, Uint32, Uint32, Int32);
typedef StrFromTimeIntervalADart = int Function(Pointer<Utf8>, int, int, int);
final StrFromTimeIntervalA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<StrFromTimeIntervalANative, StrFromTimeIntervalADart>('StrFromTimeIntervalA');
// pszOut : LPSTR out -> Pointer<Utf8>
// cchMax : DWORD -> Uint32
// dwTimeMS : DWORD -> Uint32
// digits : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function StrFromTimeIntervalA(
pszOut: PAnsiChar; // LPSTR out
cchMax: DWORD; // DWORD
dwTimeMS: DWORD; // DWORD
digits: Integer // INT
): Integer; stdcall;
external 'SHLWAPI.dll' name 'StrFromTimeIntervalA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "StrFromTimeIntervalA"
c_StrFromTimeIntervalA :: CString -> Word32 -> Word32 -> Int32 -> IO Int32
-- pszOut : LPSTR out -> CString
-- cchMax : DWORD -> Word32
-- dwTimeMS : DWORD -> Word32
-- digits : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let strfromtimeintervala =
foreign "StrFromTimeIntervalA"
(string @-> uint32_t @-> uint32_t @-> int32_t @-> returning int32_t)
(* pszOut : LPSTR out -> string *)
(* cchMax : DWORD -> uint32_t *)
(* dwTimeMS : DWORD -> uint32_t *)
(* digits : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("StrFromTimeIntervalA" str-from-time-interval-a :convention :stdcall) :int32
(psz-out :pointer) ; LPSTR out
(cch-max :uint32) ; DWORD
(dw-time-ms :uint32) ; DWORD
(digits :int32)) ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $StrFromTimeIntervalA = Win32::API::More->new('SHLWAPI',
'int StrFromTimeIntervalA(LPSTR pszOut, DWORD cchMax, DWORD dwTimeMS, int digits)');
# my $ret = $StrFromTimeIntervalA->Call($pszOut, $cchMax, $dwTimeMS, $digits);
# pszOut : LPSTR out -> LPSTR
# cchMax : DWORD -> DWORD
# dwTimeMS : DWORD -> DWORD
# digits : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f StrFromTimeIntervalW (Unicode版) — ミリ秒単位の時間間隔を文字列に変換する。