ホーム › UI.WindowsAndMessaging › wvsprintfW

wvsprintfW

関数

可変引数リストから書式付き文字列を生成する(Unicode)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT wvsprintfW(
    LPWSTR param0,
    LPCWSTR param1,
    CHAR* arglist
);

パラメーター

名前	型	方向	説明
param0	LPWSTR	out	書式化結果を受け取る出力ワイド文字バッファ。
param1	LPCWSTR	in	書式指定文字列を表すワイド文字列。
arglist	CHAR*	in	このリストの各要素は、書式制御文字列に対する引数を指定します。引数の数、型、および解釈は、 lpFmt パラメーター内の対応する書式制御の指定によって決まります。

戻り値の型: INT

公式ドキュメント

引数リストへのポインターを使用して、指定したバッファーに書式化されたデータを書き込みます。(Unicode)

戻り値

型: int

関数が成功した場合、戻り値はバッファーに格納された文字数です(終端の null 文字は含みません)。

関数が失敗した場合、戻り値は期待される出力の長さよりも小さくなります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数は、書式制御文字列を文字列の先頭文字から 1 文字ずつ出力バッファーにコピーします。文字列中で書式指定に遭遇すると、次に利用可能な引数(リストの最初の引数から開始)の値を取得し、その値を指定された書式に変換して、結果を出力バッファーにコピーします。この関数は、書式制御文字列の末尾に到達するまで、このように文字のコピーと書式指定の展開を続けます。書式指定よりも引数の数が多い場合、余分な引数は無視されます。すべての書式指定に対して引数の数が足りない場合、結果は未定義となります。

メモ

winuser.h ヘッダーは wvsprintf をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT wvsprintfW(
    LPWSTR param0,
    LPCWSTR param1,
    CHAR* arglist
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int wvsprintfW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder param0,   // LPWSTR out
    [MarshalAs(UnmanagedType.LPWStr)] string param1,   // LPCWSTR
    IntPtr arglist   // CHAR*
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function wvsprintfW(
    <MarshalAs(UnmanagedType.LPWStr)> param0 As System.Text.StringBuilder,   ' LPWSTR out
    <MarshalAs(UnmanagedType.LPWStr)> param1 As String,   ' LPCWSTR
    arglist As IntPtr   ' CHAR*
) As Integer
End Function

' param0 : LPWSTR out
' param1 : LPCWSTR
' arglist : CHAR*
Declare PtrSafe Function wvsprintfW Lib "user32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As LongPtr, _
    ByVal arglist As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

wvsprintfW = ctypes.windll.user32.wvsprintfW
wvsprintfW.restype = ctypes.c_int
wvsprintfW.argtypes = [
    wintypes.LPWSTR,  # param0 : LPWSTR out
    wintypes.LPCWSTR,  # param1 : LPCWSTR
    ctypes.POINTER(ctypes.c_byte),  # arglist : CHAR*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
wvsprintfW = Fiddle::Function.new(
  lib['wvsprintfW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : LPWSTR out
    Fiddle::TYPE_VOIDP,  # param1 : LPCWSTR
    Fiddle::TYPE_VOIDP,  # arglist : CHAR*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn wvsprintfW(
        param0: *mut u16,  // LPWSTR out
        param1: *const u16,  // LPCWSTR
        arglist: *mut i8  // CHAR*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int wvsprintfW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder param0, [MarshalAs(UnmanagedType.LPWStr)] string param1, IntPtr arglist);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_wvsprintfW' -Namespace Win32 -PassThru
# $api::wvsprintfW(param0, param1, arglist)

#uselib "USER32.dll"
#func global wvsprintfW "wvsprintfW" wptr, wptr, wptr
; wvsprintfW varptr(param0), param1, varptr(arglist)   ; 戻り値は stat
; param0 : LPWSTR out -> "wptr"
; param1 : LPCWSTR -> "wptr"
; arglist : CHAR* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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