ホーム › UI.WindowsAndMessaging › CharToOemA

CharToOemA

関数

文字列をANSIからOEM文字セットへ変換する(ANSI)。

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

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL CharToOemA(
    LPCSTR pSrc,
    LPSTR pDst
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

戻り値は、関数のワイド文字バージョンで lpszSrc と lpszDst に同じアドレスを渡した場合を除き、常に 0 以外になります。この場合、関数は 0 を返し、GetLastError は ERROR_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  (ANSI / -A)
#include <windows.h>

BOOL CharToOemA(
    LPCSTR pSrc,
    LPSTR pDst
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CharToOemA(
    [MarshalAs(UnmanagedType.LPStr)] string pSrc,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pDst   // LPSTR out
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CharToOemA(
    <MarshalAs(UnmanagedType.LPStr)> pSrc As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pDst As System.Text.StringBuilder   ' LPSTR out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pSrc : LPCSTR
' pDst : LPSTR out
Declare PtrSafe Function CharToOemA Lib "user32" ( _
    ByVal pSrc As String, _
    ByVal pDst As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CharToOemA = ctypes.windll.user32.CharToOemA
CharToOemA.restype = wintypes.BOOL
CharToOemA.argtypes = [
    wintypes.LPCSTR,  # pSrc : LPCSTR
    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')
CharToOemA = Fiddle::Function.new(
  lib['CharToOemA'],
  [
    Fiddle::TYPE_VOIDP,  # pSrc : LPCSTR
    Fiddle::TYPE_VOIDP,  # pDst : LPSTR out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn CharToOemA(
        pSrc: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool CharToOemA([MarshalAs(UnmanagedType.LPStr)] string pSrc, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pDst);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CharToOemA' -Namespace Win32 -PassThru
# $api::CharToOemA(pSrc, pDst)

#uselib "USER32.dll"
#func global CharToOemA "CharToOemA" sptr, sptr
; CharToOemA pSrc, varptr(pDst)   ; 戻り値は stat
; pSrc : LPCSTR -> "sptr"
; pDst : LPSTR out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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