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

CharToOemW

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

シグネチャ

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

BOOL CharToOemW(
    LPCWSTR pSrc,
    LPSTR pDst
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

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

解説(Remarks)

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CharToOemW(
    LPCWSTR pSrc,
    LPSTR pDst
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CharToOemW(
    [MarshalAs(UnmanagedType.LPWStr)] string pSrc,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pDst   // LPSTR out
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CharToOemW(
    <MarshalAs(UnmanagedType.LPWStr)> pSrc As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPStr)> pDst As System.Text.StringBuilder   ' LPSTR out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pSrc : LPCWSTR
' pDst : LPSTR out
Declare PtrSafe Function CharToOemW Lib "user32" ( _
    ByVal pSrc As LongPtr, _
    ByVal pDst As String) 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

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

lib = Fiddle.dlopen('USER32.dll')
CharToOemW = Fiddle::Function.new(
  lib['CharToOemW'],
  [
    Fiddle::TYPE_VOIDP,  # pSrc : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pDst : LPSTR out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn CharToOemW(
        pSrc: *const u16,  // LPCWSTR
        pDst: *mut u8  // LPSTR 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 CharToOemW([MarshalAs(UnmanagedType.LPWStr)] string pSrc, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pDst);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CharToOemW' -Namespace Win32 -PassThru
# $api::CharToOemW(pSrc, pDst)
#uselib "USER32.dll"
#func global CharToOemW "CharToOemW" wptr, wptr
; CharToOemW pSrc, varptr(pDst)   ; 戻り値は stat
; pSrc : LPCWSTR -> "wptr"
; pDst : LPSTR out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global CharToOemW "CharToOemW" wstr, var
; res = CharToOemW(pSrc, pDst)
; pSrc : LPCWSTR -> "wstr"
; pDst : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CharToOemW(LPCWSTR pSrc, LPSTR pDst)
#uselib "USER32.dll"
#cfunc global CharToOemW "CharToOemW" wstr, var
; res = CharToOemW(pSrc, pDst)
; pSrc : LPCWSTR -> "wstr"
; pDst : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procCharToOemW = user32.NewProc("CharToOemW")
)

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

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

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

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

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

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

関連項目

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