ホーム › UI.WindowsAndMessaging › wvsprintfA

wvsprintfA

関数

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

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

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT wvsprintfA(
    LPSTR param0,
    LPCSTR param1,
    CHAR* arglist
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

関数が成功した場合、戻り値は終端の null 文字を数えない、バッファーに格納された文字数です。

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

解説(Remarks)

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

メモ

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

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT wvsprintfA(
    LPSTR param0,
    LPCSTR param1,
    CHAR* arglist
);

[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int wvsprintfA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder param0,   // LPSTR out
    [MarshalAs(UnmanagedType.LPStr)] string param1,   // LPCSTR
    IntPtr arglist   // CHAR*
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function wvsprintfA(
    <MarshalAs(UnmanagedType.LPStr)> param0 As System.Text.StringBuilder,   ' LPSTR out
    <MarshalAs(UnmanagedType.LPStr)> param1 As String,   ' LPCSTR
    arglist As IntPtr   ' CHAR*
) As Integer
End Function

' param0 : LPSTR out
' param1 : LPCSTR
' arglist : CHAR*
Declare PtrSafe Function wvsprintfA Lib "user32" ( _
    ByVal param0 As String, _
    ByVal param1 As String, _
    ByVal arglist As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

wvsprintfA = ctypes.windll.user32.wvsprintfA
wvsprintfA.restype = ctypes.c_int
wvsprintfA.argtypes = [
    wintypes.LPSTR,  # param0 : LPSTR out
    wintypes.LPCSTR,  # param1 : LPCSTR
    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')
wvsprintfA = Fiddle::Function.new(
  lib['wvsprintfA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : LPSTR out
    Fiddle::TYPE_VOIDP,  # param1 : LPCSTR
    Fiddle::TYPE_VOIDP,  # arglist : CHAR*
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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