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

SHUnicodeToUnicode

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

シグネチャ

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

INT SHUnicodeToUnicode(
    LPCWSTR pwzSrc,
    LPWSTR pwzDst,
    INT cwchBuf
);

パラメーター

名前方向説明
pwzSrcLPCWSTRin出力バッファーへコピーする、null で終端された Unicode 文字列へのポインターです。
pwzDstLPWSTRoutコピーされた文字を受け取る出力バッファーへのポインターです。バッファーは、終端の null 文字分を含めて、cwchBuf で指定された数の WCHAR 文字を格納できる十分な大きさが必要です。
cwchBufINTinpwzDst パラメーターが指すバッファーに格納できる WCHAR 文字の数です。このパラメーターは 0 より大きい値である必要があります。

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

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

解説(Remarks)

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

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

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

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

SHUnicodeToTCharSHUnicodeToUnicode と同じものとして定義されています。

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

各言語での呼び出し定義

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

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

SHUnicodeToUnicode = ctypes.windll.shlwapi.SHUnicodeToUnicode
SHUnicodeToUnicode.restype = ctypes.c_int
SHUnicodeToUnicode.argtypes = [
    wintypes.LPCWSTR,  # pwzSrc : LPCWSTR
    wintypes.LPWSTR,  # pwzDst : LPWSTR out
    ctypes.c_int,  # cwchBuf : INT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHUnicodeToUnicode = shlwapi.NewProc("SHUnicodeToUnicode")
)

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

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

foreign import stdcall safe "SHUnicodeToUnicode"
  c_SHUnicodeToUnicode :: CWString -> CWString -> Int32 -> IO Int32
-- pwzSrc : LPCWSTR -> CWString
-- pwzDst : LPWSTR out -> CWString
-- cwchBuf : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shunicodetounicode =
  foreign "SHUnicodeToUnicode"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* pwzSrc : LPCWSTR -> (ptr uint16_t) *)
(* pwzDst : LPWSTR out -> (ptr uint16_t) *)
(* cwchBuf : 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 ("SHUnicodeToUnicode" shunicode-to-unicode :convention :stdcall) :int32
  (pwz-src (:string :encoding :utf-16le))   ; LPCWSTR
  (pwz-dst :pointer)   ; LPWSTR out
  (cwch-buf :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHUnicodeToUnicode = Win32::API::More->new('SHLWAPI',
    'int SHUnicodeToUnicode(LPCWSTR pwzSrc, LPWSTR pwzDst, int cwchBuf)');
# my $ret = $SHUnicodeToUnicode->Call($pwzSrc, $pwzDst, $cwchBuf);
# pwzSrc : LPCWSTR -> LPCWSTR
# pwzDst : LPWSTR out -> LPWSTR
# cwchBuf : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。