wnsprintfA
関数可変長引数書式指定に従い文字列をバッファに生成する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
INT wnsprintfA(
LPSTR pszDest,
INT cchDest,
LPCSTR pszFmt,
...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszDest | LPSTR | out | この関数が正常に終了したときに出力文字列を受け取るバッファーへのポインター。 |
| cchDest | INT | in | pszDest に格納できる最大文字数。 |
| pszFmt | LPCSTR | in | printf スタイルの書式文字列。%s 書式指定子は、サイズを指定しない形式で使用してはなりません。バッファーオーバーランの可能性を避けるため、常にサイズを指定してください。たとえば "%32s" のように指定します。 |
戻り値の型: INT
公式ドキュメント
可変長の引数リストを受け取り、それらの引数の値を printf スタイルで書式化した文字列として返します。(ANSI)
戻り値
型: int
バッファーに書き込まれた文字数を返します。終端の NULL 文字は含みません。エラーが発生した場合は負の値が返されます。
解説(Remarks)
セキュリティに関する警告: この関数を正しく使用しないと、アプリケーションのセキュリティが損なわれる可能性があります。コピーされる文字列は null 終端である保証がありません。次のいずれかの代替手段の使用を検討してください。StringCbPrintf、StringCbPrintfEx、StringCbVPrintf、StringCbVPrintfEx、StringCchPrintf、StringCchPrintfEx、StringCchVPrintf、または 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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
INT wnsprintfA(
LPSTR pszDest,
INT cchDest,
LPCSTR pszFmt,
...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern int wnsprintfA(
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDest, // LPSTR out
int cchDest, // INT
[MarshalAs(UnmanagedType.LPStr)] string pszFmt, // LPCSTR
__arglist
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function wnsprintfA(
<MarshalAs(UnmanagedType.LPStr)> pszDest As System.Text.StringBuilder, ' LPSTR out
cchDest As Integer, ' INT
<MarshalAs(UnmanagedType.LPStr)> pszFmt As String ' LPCSTR
) As Integer
End Function
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。' pszDest : LPSTR out
' cchDest : INT
' pszFmt : LPCSTR
Declare PtrSafe Function wnsprintfA Lib "shlwapi" ( _
ByVal pszDest As String, _
ByVal cchDest As Long, _
ByVal pszFmt As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。import ctypes
from ctypes import wintypes
wnsprintfA = ctypes.cdll.shlwapi.wnsprintfA
wnsprintfA.restype = ctypes.c_int
wnsprintfA.argtypes = [
wintypes.LPSTR, # pszDest : LPSTR out
ctypes.c_int, # cchDest : INT
wintypes.LPCSTR, # pszFmt : LPCSTR
]
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
wnsprintfA = Fiddle::Function.new(
lib['wnsprintfA'],
[
Fiddle::TYPE_VOIDP, # pszDest : LPSTR out
Fiddle::TYPE_INT, # cchDest : INT
Fiddle::TYPE_VOIDP, # pszFmt : LPCSTR
],
Fiddle::TYPE_INT, Fiddle::Function::CDECL)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。#[link(name = "shlwapi")]
extern "C" {
fn wnsprintfA(
pszDest: *mut u8, // LPSTR out
cchDest: i32, // INT
pszFmt: *const u8, // LPCSTR
...
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, CallingConvention = CallingConvention.Cdecl)]
public static extern int wnsprintfA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDest, int cchDest, [MarshalAs(UnmanagedType.LPStr)] string pszFmt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_wnsprintfA' -Namespace Win32 -PassThru
# $api::wnsprintfA(pszDest, cchDest, pszFmt)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。#uselib "SHLWAPI.dll"
#func global wnsprintfA "wnsprintfA" sptr, sptr, sptr
; wnsprintfA varptr(pszDest), cchDest, pszFmt ; 戻り値は stat
; pszDest : LPSTR out -> "sptr"
; cchDest : INT -> "sptr"
; pszFmt : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。出力引数:
#uselib "SHLWAPI.dll" #cfunc global wnsprintfA "wnsprintfA" var, int, str ; res = wnsprintfA(pszDest, cchDest, pszFmt) ; pszDest : LPSTR out -> "var" ; cchDest : INT -> "int" ; pszFmt : LPCSTR -> "str" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。 ; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。#uselib "SHLWAPI.dll" #cfunc global wnsprintfA "wnsprintfA" sptr, int, str ; res = wnsprintfA(varptr(pszDest), cchDest, pszFmt) ; pszDest : LPSTR out -> "sptr" ; cchDest : INT -> "int" ; pszFmt : LPCSTR -> "str" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
出力引数:
; INT wnsprintfA(LPSTR pszDest, INT cchDest, LPCSTR pszFmt) #uselib "SHLWAPI.dll" #cfunc global wnsprintfA "wnsprintfA" var, int, str ; res = wnsprintfA(pszDest, cchDest, pszFmt) ; pszDest : LPSTR out -> "var" ; cchDest : INT -> "int" ; pszFmt : LPCSTR -> "str" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。 ; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。; INT wnsprintfA(LPSTR pszDest, INT cchDest, LPCSTR pszFmt) #uselib "SHLWAPI.dll" #cfunc global wnsprintfA "wnsprintfA" intptr, int, str ; res = wnsprintfA(varptr(pszDest), cchDest, pszFmt) ; pszDest : LPSTR out -> "intptr" ; cchDest : INT -> "int" ; pszFmt : LPCSTR -> "str" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。 ; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procwnsprintfA = shlwapi.NewProc("wnsprintfA")
)
// pszDest (LPSTR out), cchDest (INT), pszFmt (LPCSTR)
r1, _, err := procwnsprintfA.Call(
uintptr(pszDest),
uintptr(cchDest),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszFmt))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INT
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。function wnsprintfA(
pszDest: PAnsiChar; // LPSTR out
cchDest: Integer; // INT
pszFmt: PAnsiChar // LPCSTR
): Integer; cdecl; varargs;
external 'SHLWAPI.dll' name 'wnsprintfA';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。result := DllCall("SHLWAPI\wnsprintfA"
, "Ptr", pszDest ; LPSTR out
, "Int", cchDest ; INT
, "AStr", pszFmt ; LPCSTR
, "Cdecl Int") ; return: INT
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。●wnsprintfA(pszDest, cchDest, pszFmt) = DLL("SHLWAPI.dll", "int wnsprintfA(char*, int, char*)")
# 呼び出し: wnsprintfA(pszDest, cchDest, pszFmt)
# pszDest : LPSTR out -> "char*"
# cchDest : INT -> "int"
# pszFmt : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
# ※可変長引数。DLL()は固定引数のみ。追加引数は EXEC_PTR で渡してください。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。const std = @import("std");
extern "shlwapi" fn wnsprintfA(
pszDest: [*c]u8, // LPSTR out
cchDest: i32, // INT
pszFmt: [*c]const u8, // LPCSTR
...
) callconv(.c) i32;
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。proc wnsprintfA(
pszDest: ptr char, # LPSTR out
cchDest: int32, # INT
pszFmt: cstring # LPCSTR
): int32 {.importc: "wnsprintfA", cdecl, varargs, dynlib: "SHLWAPI.dll".}
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。pragma(lib, "shlwapi");
extern(C)
int wnsprintfA(
char* pszDest, // LPSTR out
int cchDest, // INT
const(char)* pszFmt, // LPCSTR
...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。ccall((:wnsprintfA, "SHLWAPI.dll"), Int32,
(Ptr{UInt8}, Int32, Cstring),
pszDest, cchDest, pszFmt)
# pszDest : LPSTR out -> Ptr{UInt8}
# cchDest : INT -> Int32
# pszFmt : LPCSTR -> Cstring
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。local ffi = require("ffi")
ffi.cdef[[
int32_t wnsprintfA(
char* pszDest,
int32_t cchDest,
const char* pszFmt,
...);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.wnsprintfA(pszDest, cchDest, pszFmt)
-- pszDest : LPSTR out
-- cchDest : INT
-- pszFmt : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const wnsprintfA = lib.func('__cdecl', 'wnsprintfA', 'int32_t', ['char *', 'int32_t', 'str', '...']);
// wnsprintfA(pszDest, cchDest, pszFmt)
// pszDest : LPSTR out -> 'char *'
// cchDest : INT -> 'int32_t'
// pszFmt : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。const lib = Deno.dlopen("SHLWAPI.dll", {
wnsprintfA: { parameters: ["buffer", "i32", "buffer"], result: "i32" },
});
// lib.symbols.wnsprintfA(pszDest, cchDest, pszFmt)
// pszDest : LPSTR out -> "buffer"
// cchDest : INT -> "i32"
// pszFmt : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。<?php
$ffi = FFI::cdef(<<<C
int32_t wnsprintfA(
char* pszDest,
int32_t cchDest,
const char* pszFmt,
...);
C, "SHLWAPI.dll");
// $ffi->wnsprintfA(pszDest, cchDest, pszFmt);
// pszDest : LPSTR out
// cchDest : INT
// pszFmt : LPCSTR
// 構造体/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.ASCII_OPTIONS);
int wnsprintfA(
byte[] pszDest, // LPSTR out
int cchDest, // INT
String pszFmt, // LPCSTR
Object... args // 可変長引数(printf形式)
);
}
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。@[Link("shlwapi")]
lib LibSHLWAPI
fun wnsprintfA = wnsprintfA(
pszDest : UInt8*, # LPSTR out
cchDest : Int32, # INT
pszFmt : UInt8*, # LPCSTR
...
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef wnsprintfANative = Int32 Function(Pointer<Utf8>, Int32, Pointer<Utf8>);
typedef wnsprintfADart = int Function(Pointer<Utf8>, int, Pointer<Utf8>);
final wnsprintfA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<wnsprintfANative, wnsprintfADart>('wnsprintfA');
// pszDest : LPSTR out -> Pointer<Utf8>
// cchDest : INT -> Int32
// pszFmt : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。{$mode objfpc}{$H+}
function wnsprintfA(
pszDest: PAnsiChar; // LPSTR out
cchDest: Integer; // INT
pszFmt: PAnsiChar // LPCSTR
): Integer; cdecl; varargs;
external 'SHLWAPI.dll' name 'wnsprintfA';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import ccall safe "wnsprintfA"
c_wnsprintfA :: CString -> Int32 -> CString -> IO Int32
-- pszDest : LPSTR out -> CString
-- cchDest : INT -> Int32
-- pszFmt : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。open Ctypes
open Foreign
let wnsprintfa =
foreign "wnsprintfA"
(string @-> int32_t @-> string @-> returning int32_t)
(* pszDest : LPSTR out -> string *)
(* cchDest : INT -> int32_t *)
(* pszFmt : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(* ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("wnsprintfA" wnsprintf-a :convention :cdecl) :int32
(psz-dest :pointer) ; LPSTR out
(cch-dest :int32) ; INT
(psz-fmt :string) ; LPCSTR
&rest) ; 可変長引数(printf形式)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。use Win32::API;
my $wnsprintfA = Win32::API::More->new('SHLWAPI',
'int wnsprintfA(LPSTR pszDest, int cchDest, LPCSTR pszFmt)');
# my $ret = $wnsprintfA->Call($pszDest, $cchDest, $pszFmt);
# pszDest : LPSTR out -> LPSTR
# cchDest : INT -> int
# pszFmt : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。関連項目
文字セット違い
- f wnsprintfW (Unicode版) — 書式指定に従い文字列をバッファに生成する。