ホーム › UI.WindowsAndMessaging › OemToCharBuffA

OemToCharBuffA

関数

指定長のOEM文字列をANSIへ変換する(ANSI)。

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

シグネチャ

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

BOOL OemToCharBuffA(
    LPCSTR lpszSrc,
    LPSTR lpszDst,
    DWORD cchDstLength
);

パラメーター

名前	型	方向	説明
lpszSrc	LPCSTR	in	OEM 定義の文字セットに含まれる 1 つ以上の文字です。
lpszDst	LPSTR	out	変換後の文字列を受け取る変換先バッファーです。OemToCharBuff 関数を ANSI 関数として使用している場合は、 lpszDst パラメーターに lpszSrc パラメーターと同じアドレスを設定することで、文字列をその場で変換できます。OemToCharBuff 関数をワイド文字関数として使用している場合は、これを行うことはできません。
cchDstLength	DWORD	in	`<i>lpszSrc</i> パラメーターで識別されるバッファー内で変換する文字数です。`

戻り値の型: BOOL

公式ドキュメント

文字列内の指定された数の文字を、OEM 定義の文字セットから ANSI 文字列またはワイド文字列のいずれかに変換します。(ANSI)

戻り値

型: BOOL

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

解説(Remarks)

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

メモ

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

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

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

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

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

import ctypes
from ctypes import wintypes

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

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

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

出力引数:

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