Win32 API 日本語リファレンス
ホームUI.Shell › wnsprintfW

wnsprintfW

関数可変長引数
書式指定に従い文字列をバッファに生成する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約cdecl対応OSWindows 2000 以降

シグネチャ

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

INT wnsprintfW(
    LPWSTR pszDest,
    INT cchDest,
    LPCWSTR pszFmt,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

パラメーター

名前方向説明
pszDestLPWSTRoutこの関数が正常に終了したときに出力文字列を受け取るバッファーへのポインター。
cchDestINTinpszDest に許容される最大文字数。
pszFmtLPCWSTRinprintf スタイルの書式文字列。%s 書式指定子は、サイズを指定しない形式で使用してはなりません。バッファーオーバーランの可能性を避けるため、たとえば "%32s" のように常にサイズを指定してください。

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

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

解説(Remarks)

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

これは sprintf の Windows 版です。浮動小数点型やポインター型はサポートしません。左揃えフラグのみをサポートします。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 wnsprintfW(
    LPWSTR pszDest,
    INT cchDest,
    LPCWSTR pszFmt,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern int wnsprintfW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszDest,   // LPWSTR out
    int cchDest,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] string pszFmt,   // LPCWSTR
    __arglist
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function wnsprintfW(
    <MarshalAs(UnmanagedType.LPWStr)> pszDest As System.Text.StringBuilder,   ' LPWSTR out
    cchDest As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> pszFmt As String   ' LPCWSTR
) As Integer
End Function
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
' pszDest : LPWSTR out
' cchDest : INT
' pszFmt : LPCWSTR
Declare PtrSafe Function wnsprintfW Lib "shlwapi" ( _
    ByVal pszDest As LongPtr, _
    ByVal cchDest As Long, _
    ByVal pszFmt As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import ctypes
from ctypes import wintypes

wnsprintfW = ctypes.cdll.shlwapi.wnsprintfW
wnsprintfW.restype = ctypes.c_int
wnsprintfW.argtypes = [
    wintypes.LPWSTR,  # pszDest : LPWSTR out
    ctypes.c_int,  # cchDest : INT
    wintypes.LPCWSTR,  # pszFmt : LPCWSTR
]
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
wnsprintfW = Fiddle::Function.new(
  lib['wnsprintfW'],
  [
    Fiddle::TYPE_VOIDP,  # pszDest : LPWSTR out
    Fiddle::TYPE_INT,  # cchDest : INT
    Fiddle::TYPE_VOIDP,  # pszFmt : LPCWSTR
  ],
  Fiddle::TYPE_INT, Fiddle::Function::CDECL)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#[link(name = "shlwapi")]
extern "C" {
    fn wnsprintfW(
        pszDest: *mut u16,  // LPWSTR out
        cchDest: i32,  // INT
        pszFmt: *const u16,  // LPCWSTR
        ...
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.Cdecl)]
public static extern int wnsprintfW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszDest, int cchDest, [MarshalAs(UnmanagedType.LPWStr)] string pszFmt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_wnsprintfW' -Namespace Win32 -PassThru
# $api::wnsprintfW(pszDest, cchDest, pszFmt)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#uselib "SHLWAPI.dll"
#func global wnsprintfW "wnsprintfW" wptr, wptr, wptr
; wnsprintfW varptr(pszDest), cchDest, pszFmt   ; 戻り値は stat
; pszDest : LPWSTR out -> "wptr"
; cchDest : INT -> "wptr"
; pszFmt : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global wnsprintfW "wnsprintfW" var, int, wstr
; res = wnsprintfW(pszDest, cchDest, pszFmt)
; pszDest : LPWSTR out -> "var"
; cchDest : INT -> "int"
; pszFmt : LPCWSTR -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
出力引数:
; INT wnsprintfW(LPWSTR pszDest, INT cchDest, LPCWSTR pszFmt)
#uselib "SHLWAPI.dll"
#cfunc global wnsprintfW "wnsprintfW" var, int, wstr
; res = wnsprintfW(pszDest, cchDest, pszFmt)
; pszDest : LPWSTR out -> "var"
; cchDest : INT -> "int"
; pszFmt : LPCWSTR -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procwnsprintfW = shlwapi.NewProc("wnsprintfW")
)

// pszDest (LPWSTR out), cchDest (INT), pszFmt (LPCWSTR)
r1, _, err := procwnsprintfW.Call(
	uintptr(pszDest),
	uintptr(cchDest),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszFmt))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
function wnsprintfW(
  pszDest: PWideChar;   // LPWSTR out
  cchDest: Integer;   // INT
  pszFmt: PWideChar   // LPCWSTR
): Integer; cdecl; varargs;
  external 'SHLWAPI.dll' name 'wnsprintfW';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
result := DllCall("SHLWAPI\wnsprintfW"
    , "Ptr", pszDest   ; LPWSTR out
    , "Int", cchDest   ; INT
    , "WStr", pszFmt   ; LPCWSTR
    , "Cdecl Int")   ; return: INT
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
●wnsprintfW(pszDest, cchDest, pszFmt) = DLL("SHLWAPI.dll", "int wnsprintfW(char*, int, char*)")
# 呼び出し: wnsprintfW(pszDest, cchDest, pszFmt)
# pszDest : LPWSTR out -> "char*"
# cchDest : INT -> "int"
# pszFmt : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
# ※可変長引数。DLL()は固定引数のみ。追加引数は EXEC_PTR で渡してください。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const std = @import("std");

extern "shlwapi" fn wnsprintfW(
    pszDest: [*c]u16, // LPWSTR out
    cchDest: i32, // INT
    pszFmt: [*c]const u16, // LPCWSTR
    ...
) callconv(.c) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
proc wnsprintfW(
    pszDest: ptr uint16,  # LPWSTR out
    cchDest: int32,  # INT
    pszFmt: WideCString  # LPCWSTR
): int32 {.importc: "wnsprintfW", cdecl, varargs, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
pragma(lib, "shlwapi");
extern(C)
int wnsprintfW(
    wchar* pszDest,   // LPWSTR out
    int cchDest,   // INT
    const(wchar)* pszFmt,   // LPCWSTR
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
ccall((:wnsprintfW, "SHLWAPI.dll"), Int32,
      (Ptr{UInt16}, Int32, Cwstring),
      pszDest, cchDest, pszFmt)
# pszDest : LPWSTR out -> Ptr{UInt16}
# cchDest : INT -> Int32
# pszFmt : LPCWSTR -> Cwstring
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
local ffi = require("ffi")
ffi.cdef[[
int32_t wnsprintfW(
    uint16_t* pszDest,
    int32_t cchDest,
    const uint16_t* pszFmt,
    ...);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.wnsprintfW(pszDest, cchDest, pszFmt)
-- pszDest : LPWSTR out
-- cchDest : INT
-- pszFmt : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const wnsprintfW = lib.func('__cdecl', 'wnsprintfW', 'int32_t', ['uint16_t *', 'int32_t', 'str16', '...']);
// wnsprintfW(pszDest, cchDest, pszFmt)
// pszDest : LPWSTR out -> 'uint16_t *'
// cchDest : INT -> 'int32_t'
// pszFmt : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const lib = Deno.dlopen("SHLWAPI.dll", {
  wnsprintfW: { parameters: ["buffer", "i32", "buffer"], result: "i32" },
});
// lib.symbols.wnsprintfW(pszDest, cchDest, pszFmt)
// pszDest : LPWSTR out -> "buffer"
// cchDest : INT -> "i32"
// pszFmt : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
<?php
$ffi = FFI::cdef(<<<C
int32_t wnsprintfW(
    uint16_t* pszDest,
    int32_t cchDest,
    const uint16_t* pszFmt,
    ...);
C, "SHLWAPI.dll");
// $ffi->wnsprintfW(pszDest, cchDest, pszFmt);
// pszDest : LPWSTR out
// cchDest : INT
// pszFmt : LPCWSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
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 Library {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    int wnsprintfW(
        char[] pszDest,   // LPWSTR out
        int cchDest,   // INT
        WString pszFmt,   // LPCWSTR
        Object... args   // 可変長引数(printf形式)
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun wnsprintfW = wnsprintfW(
    pszDest : UInt16*,   # LPWSTR out
    cchDest : Int32,   # INT
    pszFmt : UInt16*,   # LPCWSTR
    ...
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef wnsprintfWNative = Int32 Function(Pointer<Utf16>, Int32, Pointer<Utf16>);
typedef wnsprintfWDart = int Function(Pointer<Utf16>, int, Pointer<Utf16>);
final wnsprintfW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<wnsprintfWNative, wnsprintfWDart>('wnsprintfW');
// pszDest : LPWSTR out -> Pointer<Utf16>
// cchDest : INT -> Int32
// pszFmt : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
{$mode objfpc}{$H+}
function wnsprintfW(
  pszDest: PWideChar;   // LPWSTR out
  cchDest: Integer;   // INT
  pszFmt: PWideChar   // LPCWSTR
): Integer; cdecl; varargs;
  external 'SHLWAPI.dll' name 'wnsprintfW';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "wnsprintfW"
  c_wnsprintfW :: CWString -> Int32 -> CWString -> IO Int32
-- pszDest : LPWSTR out -> CWString
-- cchDest : INT -> Int32
-- pszFmt : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
open Ctypes
open Foreign

let wnsprintfw =
  foreign "wnsprintfW"
    ((ptr uint16_t) @-> int32_t @-> (ptr uint16_t) @-> returning int32_t)
(* pszDest : LPWSTR out -> (ptr uint16_t) *)
(* cchDest : INT -> int32_t *)
(* pszFmt : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(* ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("wnsprintfW" wnsprintf-w :convention :cdecl) :int32
  (psz-dest :pointer)   ; LPWSTR out
  (cch-dest :int32)   ; INT
  (psz-fmt (:string :encoding :utf-16le))   ; LPCWSTR
  &rest)   ; 可変長引数(printf形式)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
use Win32::API;
my $wnsprintfW = Win32::API::More->new('SHLWAPI',
    'int wnsprintfW(LPWSTR pszDest, int cchDest, LPCWSTR pszFmt)');
# my $ret = $wnsprintfW->Call($pszDest, $cchDest, $pszFmt);
# pszDest : LPWSTR out -> LPWSTR
# cchDest : INT -> int
# pszFmt : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

関連項目

文字セット違い