Win32 API 日本語リファレンス
ホーム › Globalization › IsValidLocaleName

IsValidLocaleName

関数
指定したロケール名が有効か判定する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL IsValidLocaleName(
    LPCWSTR lpLocaleName
);

パラメーター

名前型方向説明
lpLocaleNameLPCWSTRin検証するロケール名へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定されたロケール名が、オペレーティングシステムにインストールまたはサポートされているロケールとして有効かどうかを判定します。注意 Windows Vista 以降でのみ動作するアプリケーションでは、補助ロケールの有効性を判定する際に、IsValidLocale ではなくこの関数を優先して呼び出してください。

戻り値

ロケール名が有効な場合は 0 以外の値を返し、無効な名前の場合は 0 を返します。

解説(Remarks)

Windows Vista 以降では、サポートされているすべてのロケールが、すべてのオペレーティングシステムにインストールされている必要があります。

この関数は、カスタムロケールの名前を処理できます。データはコンピューターごと、またはアプリケーションの実行ごとに同一であることが保証されません。アプリケーションがデータを永続化または送信する必要がある場合は、Using Persistent Locale Data を参照してください。

Windows 8 以降: アプリケーションが Windows.Globalization 名前空間から言語タグをこの関数に渡す場合は、まず ResolveLocaleName を呼び出してタグを変換する必要があります。

例

この関数の使用例は、NLS: Name-based APIs Sample にあります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL IsValidLocaleName(
    LPCWSTR lpLocaleName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool IsValidLocaleName(
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName   // LPCWSTR
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function IsValidLocaleName(
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpLocaleName : LPCWSTR
Declare PtrSafe Function IsValidLocaleName Lib "kernel32" ( _
    ByVal lpLocaleName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

IsValidLocaleName = ctypes.windll.kernel32.IsValidLocaleName
IsValidLocaleName.restype = wintypes.BOOL
IsValidLocaleName.argtypes = [
    wintypes.LPCWSTR,  # lpLocaleName : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
IsValidLocaleName = Fiddle::Function.new(
  lib['IsValidLocaleName'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPCWSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn IsValidLocaleName(
        lpLocaleName: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool IsValidLocaleName([MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_IsValidLocaleName' -Namespace Win32 -PassThru
# $api::IsValidLocaleName(lpLocaleName)
#uselib "KERNEL32.dll"
#func global IsValidLocaleName "IsValidLocaleName" sptr
; IsValidLocaleName lpLocaleName   ; 戻り値は stat
; lpLocaleName : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global IsValidLocaleName "IsValidLocaleName" wstr
; res = IsValidLocaleName(lpLocaleName)
; lpLocaleName : LPCWSTR -> "wstr"
; BOOL IsValidLocaleName(LPCWSTR lpLocaleName)
#uselib "KERNEL32.dll"
#cfunc global IsValidLocaleName "IsValidLocaleName" wstr
; res = IsValidLocaleName(lpLocaleName)
; lpLocaleName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procIsValidLocaleName = kernel32.NewProc("IsValidLocaleName")
)

// lpLocaleName (LPCWSTR)
r1, _, err := procIsValidLocaleName.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpLocaleName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function IsValidLocaleName(
  lpLocaleName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'IsValidLocaleName';
result := DllCall("KERNEL32\IsValidLocaleName"
    , "WStr", lpLocaleName   ; LPCWSTR
    , "Int")   ; return: BOOL
●IsValidLocaleName(lpLocaleName) = DLL("KERNEL32.dll", "bool IsValidLocaleName(char*)")
# 呼び出し: IsValidLocaleName(lpLocaleName)
# lpLocaleName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn IsValidLocaleName(
    lpLocaleName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
proc IsValidLocaleName(
    lpLocaleName: WideCString  # LPCWSTR
): int32 {.importc: "IsValidLocaleName", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int IsValidLocaleName(
    const(wchar)* lpLocaleName   // LPCWSTR
);
ccall((:IsValidLocaleName, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring,),
      lpLocaleName)
# lpLocaleName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t IsValidLocaleName(
    const uint16_t* lpLocaleName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.IsValidLocaleName(lpLocaleName)
-- lpLocaleName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const IsValidLocaleName = lib.func('__stdcall', 'IsValidLocaleName', 'int32_t', ['str16']);
// IsValidLocaleName(lpLocaleName)
// lpLocaleName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  IsValidLocaleName: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.IsValidLocaleName(lpLocaleName)
// lpLocaleName : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t IsValidLocaleName(
    const uint16_t* lpLocaleName);
C, "KERNEL32.dll");
// $ffi->IsValidLocaleName(lpLocaleName);
// lpLocaleName : LPCWSTR
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean IsValidLocaleName(
        WString lpLocaleName   // LPCWSTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun IsValidLocaleName = IsValidLocaleName(
    lpLocaleName : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef IsValidLocaleNameNative = Int32 Function(Pointer<Utf16>);
typedef IsValidLocaleNameDart = int Function(Pointer<Utf16>);
final IsValidLocaleName = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<IsValidLocaleNameNative, IsValidLocaleNameDart>('IsValidLocaleName');
// lpLocaleName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IsValidLocaleName(
  lpLocaleName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'IsValidLocaleName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let isvalidlocalename =
  foreign "IsValidLocaleName"
    ((ptr uint16_t) @-> returning int32_t)
(* lpLocaleName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("IsValidLocaleName" is-valid-locale-name :convention :stdcall) :int32
  (lp-locale-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsValidLocaleName = Win32::API::More->new('KERNEL32',
    'BOOL IsValidLocaleName(LPCWSTR lpLocaleName)');
# my $ret = $IsValidLocaleName->Call($lpLocaleName);
# lpLocaleName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目