SHAnsiToUnicode

関数

ANSI文字列をUnicode文字列へ変換する。

DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT SHAnsiToUnicode(
    LPCSTR pszSrc,
    LPWSTR pwszDst,
    INT cwchBuf
);

パラメーター

名前	型	方向	説明
pszSrc	LPCSTR	in	Unicode に変換する、null 終端された ANSI 文字列へのポインター。
pwszDst	LPWSTR	out	バッファーへのポインター。この関数が正常に終了すると、pszSrc で指定された文字列の ANSI 文字を Unicode (WCHAR) に変換した結果を受け取ります。バッファーは、終端の null 文字を含め、cwchBuf パラメーターで指定された数の Unicode 文字を格納できる十分な大きさである必要があります。
cwchBuf	INT	in	pwszDst が指すバッファーに格納できる Unicode 文字数。このパラメーターは 0 より大きい値である必要があります。

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

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

解説(Remarks)

セキュリティに関する警告: この関数を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。たとえば、pwszDst バッファーが cwchBuf で指定された文字数を格納するのに十分な大きさでない場合、バッファーオーバーランが発生する可能性があります。バッファーオーバーランは、アクセス違反が発生した場合にアプリケーションに対するサービス拒否攻撃を引き起こす可能性があります。最悪の場合、特に pwszDst がスタックベースのバッファーであるときには、バッファーオーバーランによって攻撃者がプロセスに実行可能コードを注入できる可能性があります。文字列全体をコピーする場合、sizeof はバイト数を返すため、cwchBuf パラメーターに使用する値としては正しくないことに注意してください。代わりに sizeof(pwszDst)/sizeof(WCHAR) を使用してください。この手法は pwszDst がポインターではなく配列であることを前提としている点に注意してください。

pwszDst バッファーが変換後の出力文字列全体を格納するのに十分な大きさでない場合、文字列はバッファーに収まるように切り詰められます。返された文字列が切り詰められたかどうかを検出する方法はありません。文字列は切り詰められた場合でも常に null 終端されます。これにより、pwszDst にコピーされる文字数が cwchBuf 文字を超えないことが保証されます。Unicode のサロゲートペアの途中で文字列を切り詰めないようにする処理は行われません。

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

注意この関数が、文字列の終端 null 文字に続く出力バッファー内の文字を変更していないと想定しないでください。文字列の終端 null 文字に続く出力バッファーの内容は、バッファー内の最後の文字までを含め、未定義です。

SHAnsiToTChar は SHAnsiToUnicode と同じものとして定義されています。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

INT SHAnsiToUnicode(
    LPCSTR pszSrc,
    LPWSTR pwszDst,
    INT cwchBuf
);

[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int SHAnsiToUnicode(
    [MarshalAs(UnmanagedType.LPStr)] string pszSrc,   // LPCSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszDst,   // LPWSTR out
    int cwchBuf   // INT
);

<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHAnsiToUnicode(
    <MarshalAs(UnmanagedType.LPStr)> pszSrc As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPWStr)> pwszDst As System.Text.StringBuilder,   ' LPWSTR out
    cwchBuf As Integer   ' INT
) As Integer
End Function

' pszSrc : LPCSTR
' pwszDst : LPWSTR out
' cwchBuf : INT
Declare PtrSafe Function SHAnsiToUnicode Lib "shlwapi" ( _
    ByVal pszSrc As String, _
    ByVal pwszDst As LongPtr, _
    ByVal cwchBuf As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHAnsiToUnicode = ctypes.windll.shlwapi.SHAnsiToUnicode
SHAnsiToUnicode.restype = ctypes.c_int
SHAnsiToUnicode.argtypes = [
    wintypes.LPCSTR,  # pszSrc : LPCSTR
    wintypes.LPWSTR,  # pwszDst : LPWSTR out
    ctypes.c_int,  # cwchBuf : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHAnsiToUnicode = Fiddle::Function.new(
  lib['SHAnsiToUnicode'],
  [
    Fiddle::TYPE_VOIDP,  # pszSrc : LPCSTR
    Fiddle::TYPE_VOIDP,  # pwszDst : LPWSTR out
    Fiddle::TYPE_INT,  # cwchBuf : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHAnsiToUnicode(
        pszSrc: *const u8,  // LPCSTR
        pwszDst: *mut u16,  // LPWSTR out
        cwchBuf: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int SHAnsiToUnicode([MarshalAs(UnmanagedType.LPStr)] string pszSrc, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszDst, int cwchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHAnsiToUnicode' -Namespace Win32 -PassThru
# $api::SHAnsiToUnicode(pszSrc, pwszDst, cwchBuf)

#uselib "SHLWAPI.dll"
#func global SHAnsiToUnicode "SHAnsiToUnicode" sptr, sptr, sptr
; SHAnsiToUnicode pszSrc, varptr(pwszDst), cwchBuf   ; 戻り値は stat
; pszSrc : LPCSTR -> "sptr"
; pwszDst : LPWSTR out -> "sptr"
; cwchBuf : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHAnsiToUnicode "SHAnsiToUnicode" str, var, int
; res = SHAnsiToUnicode(pszSrc, pwszDst, cwchBuf)
; pszSrc : LPCSTR -> "str"
; pwszDst : LPWSTR out -> "var"
; cwchBuf : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global SHAnsiToUnicode "SHAnsiToUnicode" str, sptr, int
; res = SHAnsiToUnicode(pszSrc, varptr(pwszDst), cwchBuf)
; pszSrc : LPCSTR -> "str"
; pwszDst : LPWSTR out -> "sptr"
; cwchBuf : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。