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

CharUpperBuffW

関数
指定長のバッファ内文字列を大文字化する(Unicode)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD CharUpperBuffW(
    LPWSTR lpsz,
    DWORD cchLength
);

パラメーター

名前方向説明
lpszLPWSTRinout処理対象となる 1 つ以上の文字を含むバッファ。
cchLengthDWORDin

lpsz が指すバッファのサイズ(文字数)。

この関数は各文字を調べ、小文字を大文字に変換します。cchLength で指定された文字数を、たとえその中に 1 つ以上の null 文字が含まれていても調べます。

戻り値の型: DWORD

公式ドキュメント

バッファ内の小文字を大文字に変換します。この関数は文字をその場で変換します。(Unicode)

戻り値

型: DWORD

戻り値は処理された文字数です。

たとえば CharUpperBuff("Zenith of API Sets", 10) が成功した場合、戻り値は 10 になります。

解説(Remarks)

CharUpperBuff は、現在の言語がトルコ語またはアゼルバイジャン語であっても、常に小文字の I("i")を大文字の I にマップする点に注意してください。この点で言語的に適切な処理を行う関数が必要な場合は、LCMapString を呼び出してください。

関数の ANSI バージョンでの Unicode への変換は、すべての場合においてシステムの既定のロケールを使用して行われます。

Examples

例については、Creating and Using a Temporary File を参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

DWORD CharUpperBuffW(
    LPWSTR lpsz,
    DWORD cchLength
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint CharUpperBuffW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpsz,   // LPWSTR in/out
    uint cchLength   // DWORD
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function CharUpperBuffW(
    <MarshalAs(UnmanagedType.LPWStr)> lpsz As System.Text.StringBuilder,   ' LPWSTR in/out
    cchLength As UInteger   ' DWORD
) As UInteger
End Function
' lpsz : LPWSTR in/out
' cchLength : DWORD
Declare PtrSafe Function CharUpperBuffW Lib "user32" ( _
    ByVal lpsz As LongPtr, _
    ByVal cchLength 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

CharUpperBuffW = ctypes.windll.user32.CharUpperBuffW
CharUpperBuffW.restype = wintypes.DWORD
CharUpperBuffW.argtypes = [
    wintypes.LPWSTR,  # lpsz : LPWSTR in/out
    wintypes.DWORD,  # cchLength : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procCharUpperBuffW = user32.NewProc("CharUpperBuffW")
)

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

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

typedef CharUpperBuffWNative = Uint32 Function(Pointer<Utf16>, Uint32);
typedef CharUpperBuffWDart = int Function(Pointer<Utf16>, int);
final CharUpperBuffW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<CharUpperBuffWNative, CharUpperBuffWDart>('CharUpperBuffW');
// lpsz : LPWSTR in/out -> Pointer<Utf16>
// cchLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CharUpperBuffW(
  lpsz: PWideChar;   // LPWSTR in/out
  cchLength: DWORD   // DWORD
): DWORD; stdcall;
  external 'USER32.dll' name 'CharUpperBuffW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CharUpperBuffW"
  c_CharUpperBuffW :: CWString -> Word32 -> IO Word32
-- lpsz : LPWSTR in/out -> CWString
-- cchLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let charupperbuffw =
  foreign "CharUpperBuffW"
    ((ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* lpsz : LPWSTR in/out -> (ptr uint16_t) *)
(* cchLength : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("CharUpperBuffW" char-upper-buff-w :convention :stdcall) :uint32
  (lpsz :pointer)   ; LPWSTR in/out
  (cch-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CharUpperBuffW = Win32::API::More->new('USER32',
    'DWORD CharUpperBuffW(LPWSTR lpsz, DWORD cchLength)');
# my $ret = $CharUpperBuffW->Call($lpsz, $cchLength);
# lpsz : LPWSTR in/out -> LPWSTR
# cchLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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