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

OemToCharW

関数
OEM文字列をUnicode文字セットへ変換する。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL OemToCharW(
    LPCSTR pSrc,
    LPWSTR pDst
);

パラメーター

名前方向説明
pSrcLPCSTRinOEM 定義の文字セットの文字から成る、null 終端文字列です。
pDstLPWSTRout変換後の文字列を受け取る変換先バッファーです。OemToChar 関数を ANSI 関数として使用している場合、lpszDst パラメーターに lpszSrc パラメーターと同じアドレスを指定することで、文字列をその場で変換できます。OemToChar をワイド文字関数として使用している場合は、これを行うことはできません。

戻り値の型: BOOL

公式ドキュメント

OEM 定義の文字セットの文字列を、ANSI 文字列またはワイド文字列に変換します。警告 使用しないでください。(Unicode)

戻り値

型: BOOL

戻り値は、関数のワイド文字版で lpszSrclpszDst に同じアドレスを渡した場合を除き、常に 0 以外になります。この場合、関数は 0 を返し、GetLastErrorERROR_INVALID_ADDRESS を返します。

解説(Remarks)

セキュリティに関する考慮事項

この関数を誤って使用すると、プログラムのセキュリティが損なわれる可能性があります。たとえば、特にアプリケーションが ANSI 版と Unicode 版の両方で使用される場合に、lpszDst バッファーの適切なサイズを誤って計算すると、バッファーオーバーフローを引き起こす可能性があります。詳細については、セキュリティに関する考慮事項: 国際化機能 および セキュリティに関する考慮事項: Windows ユーザーインターフェイス を参照してください。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして OemToChar を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約 を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL OemToCharW(
    LPCSTR pSrc,
    LPWSTR pDst
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool OemToCharW(
    [MarshalAs(UnmanagedType.LPStr)] string pSrc,   // LPCSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pDst   // LPWSTR out
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OemToCharW(
    <MarshalAs(UnmanagedType.LPStr)> pSrc As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPWStr)> pDst As System.Text.StringBuilder   ' LPWSTR out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pSrc : LPCSTR
' pDst : LPWSTR out
Declare PtrSafe Function OemToCharW Lib "user32" ( _
    ByVal pSrc As String, _
    ByVal pDst As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OemToCharW = ctypes.windll.user32.OemToCharW
OemToCharW.restype = wintypes.BOOL
OemToCharW.argtypes = [
    wintypes.LPCSTR,  # pSrc : LPCSTR
    wintypes.LPWSTR,  # pDst : LPWSTR out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
OemToCharW = Fiddle::Function.new(
  lib['OemToCharW'],
  [
    Fiddle::TYPE_VOIDP,  # pSrc : LPCSTR
    Fiddle::TYPE_VOIDP,  # pDst : LPWSTR out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn OemToCharW(
        pSrc: *const u8,  // LPCSTR
        pDst: *mut u16  // LPWSTR out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool OemToCharW([MarshalAs(UnmanagedType.LPStr)] string pSrc, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pDst);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_OemToCharW' -Namespace Win32 -PassThru
# $api::OemToCharW(pSrc, pDst)
#uselib "USER32.dll"
#func global OemToCharW "OemToCharW" wptr, wptr
; OemToCharW pSrc, varptr(pDst)   ; 戻り値は stat
; pSrc : LPCSTR -> "wptr"
; pDst : LPWSTR out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global OemToCharW "OemToCharW" str, var
; res = OemToCharW(pSrc, pDst)
; pSrc : LPCSTR -> "str"
; pDst : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL OemToCharW(LPCSTR pSrc, LPWSTR pDst)
#uselib "USER32.dll"
#cfunc global OemToCharW "OemToCharW" str, var
; res = OemToCharW(pSrc, pDst)
; pSrc : LPCSTR -> "str"
; pDst : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procOemToCharW = user32.NewProc("OemToCharW")
)

// pSrc (LPCSTR), pDst (LPWSTR out)
r1, _, err := procOemToCharW.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pSrc))),
	uintptr(pDst),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function OemToCharW(
  pSrc: PAnsiChar;   // LPCSTR
  pDst: PWideChar   // LPWSTR out
): BOOL; stdcall;
  external 'USER32.dll' name 'OemToCharW';
result := DllCall("USER32\OemToCharW"
    , "AStr", pSrc   ; LPCSTR
    , "Ptr", pDst   ; LPWSTR out
    , "Int")   ; return: BOOL
●OemToCharW(pSrc, pDst) = DLL("USER32.dll", "bool OemToCharW(char*, char*)")
# 呼び出し: OemToCharW(pSrc, pDst)
# pSrc : LPCSTR -> "char*"
# pDst : LPWSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn OemToCharW(
    pSrc: [*c]const u8, // LPCSTR
    pDst: [*c]u16 // LPWSTR out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc OemToCharW(
    pSrc: cstring,  # LPCSTR
    pDst: ptr uint16  # LPWSTR out
): int32 {.importc: "OemToCharW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int OemToCharW(
    const(char)* pSrc,   // LPCSTR
    wchar* pDst   // LPWSTR out
);
ccall((:OemToCharW, "USER32.dll"), stdcall, Int32,
      (Cstring, Ptr{UInt16}),
      pSrc, pDst)
# pSrc : LPCSTR -> Cstring
# pDst : LPWSTR out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t OemToCharW(
    const char* pSrc,
    uint16_t* pDst);
]]
local user32 = ffi.load("user32")
-- user32.OemToCharW(pSrc, pDst)
-- pSrc : LPCSTR
-- pDst : LPWSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const OemToCharW = lib.func('__stdcall', 'OemToCharW', 'int32_t', ['str', 'uint16_t *']);
// OemToCharW(pSrc, pDst)
// pSrc : LPCSTR -> 'str'
// pDst : LPWSTR out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  OemToCharW: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.OemToCharW(pSrc, pDst)
// pSrc : LPCSTR -> "buffer"
// pDst : LPWSTR out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t OemToCharW(
    const char* pSrc,
    uint16_t* pDst);
C, "USER32.dll");
// $ffi->OemToCharW(pSrc, pDst);
// pSrc : LPCSTR
// pDst : LPWSTR out
// 構造体/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 User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean OemToCharW(
        String pSrc,   // LPCSTR
        char[] pDst   // LPWSTR out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun OemToCharW = OemToCharW(
    pSrc : UInt8*,   # LPCSTR
    pDst : UInt16*   # LPWSTR out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef OemToCharWNative = Int32 Function(Pointer<Utf8>, Pointer<Utf16>);
typedef OemToCharWDart = int Function(Pointer<Utf8>, Pointer<Utf16>);
final OemToCharW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<OemToCharWNative, OemToCharWDart>('OemToCharW');
// pSrc : LPCSTR -> Pointer<Utf8>
// pDst : LPWSTR out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OemToCharW(
  pSrc: PAnsiChar;   // LPCSTR
  pDst: PWideChar   // LPWSTR out
): BOOL; stdcall;
  external 'USER32.dll' name 'OemToCharW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OemToCharW"
  c_OemToCharW :: CString -> CWString -> IO CInt
-- pSrc : LPCSTR -> CString
-- pDst : LPWSTR out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let oemtocharw =
  foreign "OemToCharW"
    (string @-> (ptr uint16_t) @-> returning int32_t)
(* pSrc : LPCSTR -> string *)
(* pDst : LPWSTR out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("OemToCharW" oem-to-char-w :convention :stdcall) :int32
  (p-src :string)   ; LPCSTR
  (p-dst :pointer))   ; LPWSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OemToCharW = Win32::API::More->new('USER32',
    'BOOL OemToCharW(LPCSTR pSrc, LPWSTR pDst)');
# my $ret = $OemToCharW->Call($pSrc, $pDst);
# pSrc : LPCSTR -> LPCSTR
# pDst : LPWSTR out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目