wvnsprintfW

関数

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

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

シグネチャ

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

INT wvnsprintfW(
    LPWSTR pszDest,
    INT cchDest,
    LPCWSTR pszFmt,
    CHAR* arglist
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

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

戻り値

型: 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  (Unicode / -W)
#include <windows.h>

INT wvnsprintfW(
    LPWSTR pszDest,
    INT cchDest,
    LPCWSTR pszFmt,
    CHAR* arglist
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int wvnsprintfW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszDest,   // LPWSTR out
    int cchDest,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] string pszFmt,   // LPCWSTR
    IntPtr arglist   // CHAR*
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function wvnsprintfW(
    <MarshalAs(UnmanagedType.LPWStr)> pszDest As System.Text.StringBuilder,   ' LPWSTR out
    cchDest As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> pszFmt As String,   ' LPCWSTR
    arglist As IntPtr   ' CHAR*
) As Integer
End Function

' pszDest : LPWSTR out
' cchDest : INT
' pszFmt : LPCWSTR
' arglist : CHAR*
Declare PtrSafe Function wvnsprintfW Lib "shlwapi" ( _
    ByVal pszDest As LongPtr, _
    ByVal cchDest As Long, _
    ByVal pszFmt 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
wvnsprintfW = Fiddle::Function.new(
  lib['wvnsprintfW'],
  [
    Fiddle::TYPE_VOIDP,  # pszDest : LPWSTR out
    Fiddle::TYPE_INT,  # cchDest : INT
    Fiddle::TYPE_VOIDP,  # pszFmt : LPCWSTR
    Fiddle::TYPE_VOIDP,  # arglist : CHAR*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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