ホーム › UI.WindowsAndMessaging › CharToOemBuffW

CharToOemBuffW

関数

指定長のUnicode文字列をOEMへ変換する。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL CharToOemBuffW(
    LPCWSTR lpszSrc,
    LPSTR lpszDst,
    DWORD cchDstLength
);

パラメーター

名前	型	方向	説明
lpszSrc	LPCWSTR	in	変換対象の null 終端文字列です。
lpszDst	LPSTR	out	変換後の文字列を格納するバッファーです。CharToOemBuff 関数を ANSI 関数として使用している場合は、lpszDst パラメーターに lpszSrc パラメーターと同じアドレスを指定することで、文字列をその場で変換できます。CharToOemBuff をワイド文字関数として使用している場合は、これを行うことはできません。
cchDstLength	DWORD	in	lpszSrc パラメーターで指定された文字列のうち、変換する文字数です。

戻り値の型: BOOL

公式ドキュメント

文字列内の指定された数の文字を OEM 定義の文字セットに変換します。(Unicode)

戻り値

型: BOOL

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

解説(Remarks)

CharToOem 関数とは異なり、CharToOemBuff 関数は lpszSrc が指すバッファー内で null 文字に遭遇しても変換を停止しません。CharToOemBuff 関数は cchDstLength 個すべての文字を変換します。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CharToOemBuffW(
    LPCWSTR lpszSrc,
    LPSTR lpszDst,
    DWORD cchDstLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CharToOemBuffW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszSrc,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszDst,   // LPSTR out
    uint cchDstLength   // DWORD
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CharToOemBuffW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszSrc As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszDst As System.Text.StringBuilder,   ' LPSTR out
    cchDstLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszSrc : LPCWSTR
' lpszDst : LPSTR out
' cchDstLength : DWORD
Declare PtrSafe Function CharToOemBuffW Lib "user32" ( _
    ByVal lpszSrc As LongPtr, _
    ByVal lpszDst As String, _
    ByVal cchDstLength As Long) 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

CharToOemBuffW = ctypes.windll.user32.CharToOemBuffW
CharToOemBuffW.restype = wintypes.BOOL
CharToOemBuffW.argtypes = [
    wintypes.LPCWSTR,  # lpszSrc : LPCWSTR
    wintypes.LPSTR,  # lpszDst : LPSTR out
    wintypes.DWORD,  # cchDstLength : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
CharToOemBuffW = Fiddle::Function.new(
  lib['CharToOemBuffW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszSrc : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszDst : LPSTR out
    -Fiddle::TYPE_INT,  # cchDstLength : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn CharToOemBuffW(
        lpszSrc: *const u16,  // LPCWSTR
        lpszDst: *mut u8,  // LPSTR out
        cchDstLength: u32  // DWORD
    ) -> 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 CharToOemBuffW([MarshalAs(UnmanagedType.LPWStr)] string lpszSrc, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszDst, uint cchDstLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CharToOemBuffW' -Namespace Win32 -PassThru
# $api::CharToOemBuffW(lpszSrc, lpszDst, cchDstLength)

#uselib "USER32.dll"
#func global CharToOemBuffW "CharToOemBuffW" wptr, wptr, wptr
; CharToOemBuffW lpszSrc, varptr(lpszDst), cchDstLength   ; 戻り値は stat
; lpszSrc : LPCWSTR -> "wptr"
; lpszDst : LPSTR out -> "wptr"
; cchDstLength : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global CharToOemBuffW "CharToOemBuffW" wstr, var, int
; res = CharToOemBuffW(lpszSrc, lpszDst, cchDstLength)
; lpszSrc : LPCWSTR -> "wstr"
; lpszDst : LPSTR out -> "var"
; cchDstLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global CharToOemBuffW "CharToOemBuffW" wstr, sptr, int
; res = CharToOemBuffW(lpszSrc, varptr(lpszDst), cchDstLength)
; lpszSrc : LPCWSTR -> "wstr"
; lpszDst : LPSTR out -> "sptr"
; cchDstLength : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。