wvnsprintfA

関数

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

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT wvnsprintfA(
    LPSTR pszDest,
    INT cchDest,
    LPCSTR pszFmt,
    CHAR* arglist
);

パラメーター

名前	型	方向	説明
pszDest	LPSTR	out	この関数が正常に終了したときに出力文字列を受け取るバッファへのポインター。
cchDest	INT	in	pszDest に許可される最大文字数。
pszFmt	LPCSTR	in	printf 形式の書式文字列。%s 書式指定子をサイズ指定なしの形で使用してはいけません。バッファーオーバーランの可能性を避けるため、常にサイズを指定してください(例: "%32s")。
arglist	CHAR*	in	出力をカスタマイズするために使用するコマンドラインパラメーターのリストへのポインター。

戻り値の型: INT

公式ドキュメント

引数のリストを受け取り、それらの値を printf 形式で書式化した文字列として返します。(ANSI)

戻り値

型: int

バッファーに書き込まれた文字数を返します(終端の NULL 文字は含みません)。エラーが発生した場合は負の値を返します。

解説(Remarks)

セキュリティに関する警告: この関数を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。コピーされる文字列が NULL で終端されている保証はありません。次のいずれかの代替手段の使用を検討してください。StringCbPrintf、StringCbPrintfEx、StringCbVPrintf、StringCbVPrintfEx、StringCchPrintf、StringCchPrintfEx、StringCchVPrintf、または StringCchVPrintfEx。続行する前にセキュリティに関する考慮事項: Microsoft Windows シェルを確認してください。

メモ

shlwapi.h ヘッダーは wvnsprintf をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版が自動的に選択されます。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

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

INT wvnsprintfA(
    LPSTR pszDest,
    INT cchDest,
    LPCSTR pszFmt,
    CHAR* arglist
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int wvnsprintfA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDest,   // LPSTR out
    int cchDest,   // INT
    [MarshalAs(UnmanagedType.LPStr)] string pszFmt,   // LPCSTR
    IntPtr arglist   // CHAR*
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function wvnsprintfA(
    <MarshalAs(UnmanagedType.LPStr)> pszDest As System.Text.StringBuilder,   ' LPSTR out
    cchDest As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> pszFmt As String,   ' LPCSTR
    arglist As IntPtr   ' CHAR*
) As Integer
End Function

' pszDest : LPSTR out
' cchDest : INT
' pszFmt : LPCSTR
' arglist : CHAR*
Declare PtrSafe Function wvnsprintfA Lib "shlwapi" ( _
    ByVal pszDest As String, _
    ByVal cchDest As Long, _
    ByVal pszFmt 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

wvnsprintfA = ctypes.windll.shlwapi.wvnsprintfA
wvnsprintfA.restype = ctypes.c_int
wvnsprintfA.argtypes = [
    wintypes.LPSTR,  # pszDest : LPSTR out
    ctypes.c_int,  # cchDest : INT
    wintypes.LPCSTR,  # pszFmt : LPCSTR
    ctypes.POINTER(ctypes.c_byte),  # arglist : CHAR*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
wvnsprintfA = Fiddle::Function.new(
  lib['wvnsprintfA'],
  [
    Fiddle::TYPE_VOIDP,  # pszDest : LPSTR out
    Fiddle::TYPE_INT,  # cchDest : INT
    Fiddle::TYPE_VOIDP,  # pszFmt : LPCSTR
    Fiddle::TYPE_VOIDP,  # arglist : CHAR*
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int wvnsprintfA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDest, int cchDest, [MarshalAs(UnmanagedType.LPStr)] string pszFmt, IntPtr arglist);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_wvnsprintfA' -Namespace Win32 -PassThru
# $api::wvnsprintfA(pszDest, cchDest, pszFmt, arglist)

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

出力引数:

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