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

SHAnsiToAnsi

関数
ANSI文字列をバッファ長を考慮して複製する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll
#include <windows.h>

INT SHAnsiToAnsi(
    LPCSTR pszSrc,
    LPSTR pszDst,
    INT cchBuf
);

パラメーター

名前方向説明
pszSrcLPCSTRinUnicode に変換される、null 終端の ANSI 文字列へのポインターです。
pszDstLPSTRoutこの関数が正常に返ったときに、pszSrc からコピーされた文字を受け取るバッファーへのポインターです。バッファーは、終端の null 文字を含めるための領域も含め、cchBuf パラメーターで指定された文字数を格納できる十分な大きさである必要があります。
cchBufINTinpszDst が指すバッファーに格納できる文字数です。このパラメーターは 0 より大きい値である必要があります。

戻り値の型: INT

公式ドキュメント

ANSI 文字列をコピーします。

戻り値

型: int

pszDst に書き込まれた文字数を、終端の null 文字を含めて返します。失敗した場合は 0 を返します。

解説(Remarks)

セキュリティに関する警告: この関数を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。たとえば、pszDst バッファーが cchBuf で指定された文字数を格納できる十分な大きさでない場合、バッファーオーバーランが発生する可能性があります。バッファーオーバーランは、アクセス違反が発生した場合にアプリケーションに対するサービス拒否攻撃を引き起こす可能性があります。最悪の場合、特に pszDst がスタックベースのバッファーである場合、バッファーオーバーランによって攻撃者がプロセスに実行可能なコードを挿入できる可能性があります。なお、バッファーが十分な大きさでない場合、出力文字列は警告なしに切り詰められます。これにより、正規化やその他のセキュリティ上の脆弱性が生じる可能性があります。

pszDst バッファーが変換後の出力文字列全体を格納できる十分な大きさでない場合、文字列はバッファーに収まるように切り詰められます。返された文字列が切り詰められたことを検出する方法はありません。文字列は切り詰められた場合でも、常に null 終端されます。この関数は、DBCS 文字ペアの先行バイトと後続バイトの間で切り詰めないように配慮します。その場合、cchBuf-1 文字のみが返されます。

pszSrc バッファーと pszDst バッファーが重複している場合、この関数の動作は未定義です。

注意 文字列の終端 null 文字の後に続く出力バッファー内の文字が、この関数によって変更されていないと想定しないでください。文字列の終端 null 文字の後に続く出力バッファーの内容は、バッファー内の最後の文字までを含めて未定義です。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHLWAPI.dll
#include <windows.h>

INT SHAnsiToAnsi(
    LPCSTR pszSrc,
    LPSTR pszDst,
    INT cchBuf
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int SHAnsiToAnsi(
    [MarshalAs(UnmanagedType.LPStr)] string pszSrc,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDst,   // LPSTR out
    int cchBuf   // INT
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHAnsiToAnsi(
    <MarshalAs(UnmanagedType.LPStr)> pszSrc As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszDst As System.Text.StringBuilder,   ' LPSTR out
    cchBuf As Integer   ' INT
) As Integer
End Function
' pszSrc : LPCSTR
' pszDst : LPSTR out
' cchBuf : INT
Declare PtrSafe Function SHAnsiToAnsi Lib "shlwapi" ( _
    ByVal pszSrc As String, _
    ByVal pszDst As String, _
    ByVal cchBuf As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHAnsiToAnsi = ctypes.windll.shlwapi.SHAnsiToAnsi
SHAnsiToAnsi.restype = ctypes.c_int
SHAnsiToAnsi.argtypes = [
    wintypes.LPCSTR,  # pszSrc : LPCSTR
    wintypes.LPSTR,  # pszDst : LPSTR out
    ctypes.c_int,  # cchBuf : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHAnsiToAnsi = Fiddle::Function.new(
  lib['SHAnsiToAnsi'],
  [
    Fiddle::TYPE_VOIDP,  # pszSrc : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszDst : LPSTR out
    Fiddle::TYPE_INT,  # cchBuf : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHAnsiToAnsi(
        pszSrc: *const u8,  // LPCSTR
        pszDst: *mut u8,  // LPSTR out
        cchBuf: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int SHAnsiToAnsi([MarshalAs(UnmanagedType.LPStr)] string pszSrc, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDst, int cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHAnsiToAnsi' -Namespace Win32 -PassThru
# $api::SHAnsiToAnsi(pszSrc, pszDst, cchBuf)
#uselib "SHLWAPI.dll"
#func global SHAnsiToAnsi "SHAnsiToAnsi" sptr, sptr, sptr
; SHAnsiToAnsi pszSrc, varptr(pszDst), cchBuf   ; 戻り値は stat
; pszSrc : LPCSTR -> "sptr"
; pszDst : LPSTR out -> "sptr"
; cchBuf : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global SHAnsiToAnsi "SHAnsiToAnsi" str, var, int
; res = SHAnsiToAnsi(pszSrc, pszDst, cchBuf)
; pszSrc : LPCSTR -> "str"
; pszDst : LPSTR out -> "var"
; cchBuf : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT SHAnsiToAnsi(LPCSTR pszSrc, LPSTR pszDst, INT cchBuf)
#uselib "SHLWAPI.dll"
#cfunc global SHAnsiToAnsi "SHAnsiToAnsi" str, var, int
; res = SHAnsiToAnsi(pszSrc, pszDst, cchBuf)
; pszSrc : LPCSTR -> "str"
; pszDst : LPSTR out -> "var"
; cchBuf : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHAnsiToAnsi = shlwapi.NewProc("SHAnsiToAnsi")
)

// pszSrc (LPCSTR), pszDst (LPSTR out), cchBuf (INT)
r1, _, err := procSHAnsiToAnsi.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSrc))),
	uintptr(pszDst),
	uintptr(cchBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SHAnsiToAnsi(
  pszSrc: PAnsiChar;   // LPCSTR
  pszDst: PAnsiChar;   // LPSTR out
  cchBuf: Integer   // INT
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHAnsiToAnsi';
result := DllCall("SHLWAPI\SHAnsiToAnsi"
    , "AStr", pszSrc   ; LPCSTR
    , "Ptr", pszDst   ; LPSTR out
    , "Int", cchBuf   ; INT
    , "Int")   ; return: INT
●SHAnsiToAnsi(pszSrc, pszDst, cchBuf) = DLL("SHLWAPI.dll", "int SHAnsiToAnsi(char*, char*, int)")
# 呼び出し: SHAnsiToAnsi(pszSrc, pszDst, cchBuf)
# pszSrc : LPCSTR -> "char*"
# pszDst : LPSTR out -> "char*"
# cchBuf : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn SHAnsiToAnsi(
    pszSrc: [*c]const u8, // LPCSTR
    pszDst: [*c]u8, // LPSTR out
    cchBuf: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc SHAnsiToAnsi(
    pszSrc: cstring,  # LPCSTR
    pszDst: ptr char,  # LPSTR out
    cchBuf: int32  # INT
): int32 {.importc: "SHAnsiToAnsi", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int SHAnsiToAnsi(
    const(char)* pszSrc,   // LPCSTR
    char* pszDst,   // LPSTR out
    int cchBuf   // INT
);
ccall((:SHAnsiToAnsi, "SHLWAPI.dll"), stdcall, Int32,
      (Cstring, Ptr{UInt8}, Int32),
      pszSrc, pszDst, cchBuf)
# pszSrc : LPCSTR -> Cstring
# pszDst : LPSTR out -> Ptr{UInt8}
# cchBuf : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHAnsiToAnsi(
    const char* pszSrc,
    char* pszDst,
    int32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHAnsiToAnsi(pszSrc, pszDst, cchBuf)
-- pszSrc : LPCSTR
-- pszDst : LPSTR out
-- cchBuf : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHAnsiToAnsi = lib.func('__stdcall', 'SHAnsiToAnsi', 'int32_t', ['str', 'char *', 'int32_t']);
// SHAnsiToAnsi(pszSrc, pszDst, cchBuf)
// pszSrc : LPCSTR -> 'str'
// pszDst : LPSTR out -> 'char *'
// cchBuf : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHAnsiToAnsi: { parameters: ["buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.SHAnsiToAnsi(pszSrc, pszDst, cchBuf)
// pszSrc : LPCSTR -> "buffer"
// pszDst : LPSTR out -> "buffer"
// cchBuf : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHAnsiToAnsi(
    const char* pszSrc,
    char* pszDst,
    int32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->SHAnsiToAnsi(pszSrc, pszDst, cchBuf);
// pszSrc : LPCSTR
// pszDst : LPSTR out
// cchBuf : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
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 StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class);
    int SHAnsiToAnsi(
        String pszSrc,   // LPCSTR
        byte[] pszDst,   // LPSTR out
        int cchBuf   // INT
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHAnsiToAnsi = SHAnsiToAnsi(
    pszSrc : UInt8*,   # LPCSTR
    pszDst : UInt8*,   # LPSTR out
    cchBuf : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHAnsiToAnsiNative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32);
typedef SHAnsiToAnsiDart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final SHAnsiToAnsi = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHAnsiToAnsiNative, SHAnsiToAnsiDart>('SHAnsiToAnsi');
// pszSrc : LPCSTR -> Pointer<Utf8>
// pszDst : LPSTR out -> Pointer<Utf8>
// cchBuf : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHAnsiToAnsi(
  pszSrc: PAnsiChar;   // LPCSTR
  pszDst: PAnsiChar;   // LPSTR out
  cchBuf: Integer   // INT
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHAnsiToAnsi';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHAnsiToAnsi"
  c_SHAnsiToAnsi :: CString -> CString -> Int32 -> IO Int32
-- pszSrc : LPCSTR -> CString
-- pszDst : LPSTR out -> CString
-- cchBuf : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shansitoansi =
  foreign "SHAnsiToAnsi"
    (string @-> string @-> int32_t @-> returning int32_t)
(* pszSrc : LPCSTR -> string *)
(* pszDst : LPSTR out -> string *)
(* cchBuf : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHAnsiToAnsi" shansi-to-ansi :convention :stdcall) :int32
  (psz-src :string)   ; LPCSTR
  (psz-dst :pointer)   ; LPSTR out
  (cch-buf :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHAnsiToAnsi = Win32::API::More->new('SHLWAPI',
    'int SHAnsiToAnsi(LPCSTR pszSrc, LPSTR pszDst, int cchBuf)');
# my $ret = $SHAnsiToAnsi->Call($pszSrc, $pszDst, $cchBuf);
# pszSrc : LPCSTR -> LPCSTR
# pszDst : LPSTR out -> LPSTR
# cchBuf : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。