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

SHUnicodeToAnsi

関数
Unicode文字列をANSI文字列へ変換する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT SHUnicodeToAnsi(
    LPCWSTR pwszSrc,
    LPSTR pszDst,
    INT cchBuf
);

パラメーター

名前方向説明
pwszSrcLPCWSTRinANSI に変換する、null で終端された Unicode 文字列へのポインターです。
pszDstLPSTRoutこの関数が正常に返ったときに、変換された文字を受け取るバッファーへのポインターです。バッファーは、終端の null 文字分も含めて、cchBuf パラメーターで指定された数の CHAR 文字を格納できる十分な大きさが必要です。
cchBufINTinpszDst が指すバッファーに格納できる CHAR 値の数です。このパラメーターに指定する値は 0 より大きくなければなりません。

戻り値の型: INT

公式ドキュメント

文字列を Unicode コードページから ANSI コードページに変換します。

戻り値

型: int

出力バッファーに書き込まれた CHAR 値の数を、終端の null 文字を含めて返します。失敗した場合は 0 を返します。

解説(Remarks)

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

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

pwszSrc バッファーと pszDst バッファーが重なり合う場合、この関数の動作は未定義です。

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

各言語での呼び出し定義

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

INT SHUnicodeToAnsi(
    LPCWSTR pwszSrc,
    LPSTR pszDst,
    INT cchBuf
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int SHUnicodeToAnsi(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszSrc,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDst,   // LPSTR out
    int cchBuf   // INT
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHUnicodeToAnsi(
    <MarshalAs(UnmanagedType.LPWStr)> pwszSrc As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPStr)> pszDst As System.Text.StringBuilder,   ' LPSTR out
    cchBuf As Integer   ' INT
) As Integer
End Function
' pwszSrc : LPCWSTR
' pszDst : LPSTR out
' cchBuf : INT
Declare PtrSafe Function SHUnicodeToAnsi Lib "shlwapi" ( _
    ByVal pwszSrc As LongPtr, _
    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

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

lib = Fiddle.dlopen('SHLWAPI.dll')
SHUnicodeToAnsi = Fiddle::Function.new(
  lib['SHUnicodeToAnsi'],
  [
    Fiddle::TYPE_VOIDP,  # pwszSrc : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszDst : LPSTR out
    Fiddle::TYPE_INT,  # cchBuf : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHUnicodeToAnsi(
        pwszSrc: *const u16,  // LPCWSTR
        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 SHUnicodeToAnsi([MarshalAs(UnmanagedType.LPWStr)] string pwszSrc, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDst, int cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHUnicodeToAnsi' -Namespace Win32 -PassThru
# $api::SHUnicodeToAnsi(pwszSrc, pszDst, cchBuf)
#uselib "SHLWAPI.dll"
#func global SHUnicodeToAnsi "SHUnicodeToAnsi" sptr, sptr, sptr
; SHUnicodeToAnsi pwszSrc, varptr(pszDst), cchBuf   ; 戻り値は stat
; pwszSrc : LPCWSTR -> "sptr"
; pszDst : LPSTR out -> "sptr"
; cchBuf : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global SHUnicodeToAnsi "SHUnicodeToAnsi" wstr, var, int
; res = SHUnicodeToAnsi(pwszSrc, pszDst, cchBuf)
; pwszSrc : LPCWSTR -> "wstr"
; pszDst : LPSTR out -> "var"
; cchBuf : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT SHUnicodeToAnsi(LPCWSTR pwszSrc, LPSTR pszDst, INT cchBuf)
#uselib "SHLWAPI.dll"
#cfunc global SHUnicodeToAnsi "SHUnicodeToAnsi" wstr, var, int
; res = SHUnicodeToAnsi(pwszSrc, pszDst, cchBuf)
; pwszSrc : LPCWSTR -> "wstr"
; pszDst : LPSTR out -> "var"
; cchBuf : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHUnicodeToAnsi = shlwapi.NewProc("SHUnicodeToAnsi")
)

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

extern "shlwapi" fn SHUnicodeToAnsi(
    pwszSrc: [*c]const u16, // LPCWSTR
    pszDst: [*c]u8, // LPSTR out
    cchBuf: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc SHUnicodeToAnsi(
    pwszSrc: WideCString,  # LPCWSTR
    pszDst: ptr char,  # LPSTR out
    cchBuf: int32  # INT
): int32 {.importc: "SHUnicodeToAnsi", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int SHUnicodeToAnsi(
    const(wchar)* pwszSrc,   // LPCWSTR
    char* pszDst,   // LPSTR out
    int cchBuf   // INT
);
ccall((:SHUnicodeToAnsi, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, Ptr{UInt8}, Int32),
      pwszSrc, pszDst, cchBuf)
# pwszSrc : LPCWSTR -> Cwstring
# pszDst : LPSTR out -> Ptr{UInt8}
# cchBuf : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHUnicodeToAnsi(
    const uint16_t* pwszSrc,
    char* pszDst,
    int32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHUnicodeToAnsi(pwszSrc, pszDst, cchBuf)
-- pwszSrc : LPCWSTR
-- pszDst : LPSTR out
-- cchBuf : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHUnicodeToAnsi = lib.func('__stdcall', 'SHUnicodeToAnsi', 'int32_t', ['str16', 'char *', 'int32_t']);
// SHUnicodeToAnsi(pwszSrc, pszDst, cchBuf)
// pwszSrc : LPCWSTR -> 'str16'
// pszDst : LPSTR out -> 'char *'
// cchBuf : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHUnicodeToAnsi: { parameters: ["buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.SHUnicodeToAnsi(pwszSrc, pszDst, cchBuf)
// pwszSrc : LPCWSTR -> "buffer"
// pszDst : LPSTR out -> "buffer"
// cchBuf : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHUnicodeToAnsi(
    const uint16_t* pwszSrc,
    char* pszDst,
    int32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->SHUnicodeToAnsi(pwszSrc, pszDst, cchBuf);
// pwszSrc : LPCWSTR
// 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 SHUnicodeToAnsi(
        WString pwszSrc,   // LPCWSTR
        byte[] pszDst,   // LPSTR out
        int cchBuf   // INT
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHUnicodeToAnsi = SHUnicodeToAnsi(
    pwszSrc : UInt16*,   # LPCWSTR
    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 SHUnicodeToAnsiNative = Int32 Function(Pointer<Utf16>, Pointer<Utf8>, Int32);
typedef SHUnicodeToAnsiDart = int Function(Pointer<Utf16>, Pointer<Utf8>, int);
final SHUnicodeToAnsi = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHUnicodeToAnsiNative, SHUnicodeToAnsiDart>('SHUnicodeToAnsi');
// pwszSrc : LPCWSTR -> Pointer<Utf16>
// pszDst : LPSTR out -> Pointer<Utf8>
// cchBuf : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHUnicodeToAnsi(
  pwszSrc: PWideChar;   // LPCWSTR
  pszDst: PAnsiChar;   // LPSTR out
  cchBuf: Integer   // INT
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHUnicodeToAnsi';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let shunicodetoansi =
  foreign "SHUnicodeToAnsi"
    ((ptr uint16_t) @-> string @-> int32_t @-> returning int32_t)
(* pwszSrc : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("SHUnicodeToAnsi" shunicode-to-ansi :convention :stdcall) :int32
  (pwsz-src (:string :encoding :utf-16le))   ; LPCWSTR
  (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 $SHUnicodeToAnsi = Win32::API::More->new('SHLWAPI',
    'int SHUnicodeToAnsi(LPCWSTR pwszSrc, LPSTR pszDst, int cchBuf)');
# my $ret = $SHUnicodeToAnsi->Call($pwszSrc, $pszDst, $cchBuf);
# pwszSrc : LPCWSTR -> LPCWSTR
# pszDst : LPSTR out -> LPSTR
# cchBuf : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。