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

IsValidLocale

関数
指定ロケールがインストール済みで有効か判定する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL IsValidLocale(
    DWORD Locale,
    IS_VALID_LOCALE_FLAGS dwFlags
);

パラメーター

名前方向説明
LocaleDWORDin

検証するロケールの ロケール識別子MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。

dwFlagsIS_VALID_LOCALE_FLAGSin

ロケール識別子に適用する有効性テストを指定するフラグです。このパラメーターには、次のいずれかの値を指定できます。

意味
LCID_INSTALLED
ロケール識別子がサポートされており、かつインストールされているかどうかを判定します。
LCID_SUPPORTED
ロケール識別子がサポートされているかどうかを判定します。
0x39
使用しないでください。代わりに LCID_INSTALLED を使用してください。

Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP、および Windows 2000: dwFlags に 0x39 を設定するのは特殊なケースであり、一部のバージョンの Windows の一部のロケールでは LCID_INSTALLED と同様に動作することがあります。

戻り値の型: BOOL

公式ドキュメント

指定したロケールがオペレーティングシステムにインストールされているか、またはサポートされているかを判定します。詳細については、「Locales and Languages」を参照してください。

戻り値

ロケール識別子が指定した有効性テストに合格した場合は、0 以外の値を返します。成功しなかった場合、関数は 0 を返します。

解説(Remarks)

LCID_INSTALLED フラグが指定されており、この関数が 0 以外の値を返した場合、そのロケール識別子はオペレーティングシステムでサポートされており、かつインストールされています。識別子がインストールされているということは、指定したロケールに対して完全なレベルの言語サポートが利用可能であることを意味します。完全なサポートには、コードページ変換テーブル、キーボードレイアウト、フォント、並べ替えおよびロケールデータが含まれます。

LCID_SUPPORTED が指定されており、この関数が 0 を返した場合、そのロケール識別子はそのリリースでサポートされていますが、必ずしもオペレーティングシステムにインストールされているとは限りません。

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

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

各言語での呼び出し定義

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

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

IsValidLocale = ctypes.windll.kernel32.IsValidLocale
IsValidLocale.restype = wintypes.BOOL
IsValidLocale.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwFlags : IS_VALID_LOCALE_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procIsValidLocale = kernel32.NewProc("IsValidLocale")
)

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

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

typedef IsValidLocaleNative = Int32 Function(Uint32, Uint32);
typedef IsValidLocaleDart = int Function(int, int);
final IsValidLocale = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<IsValidLocaleNative, IsValidLocaleDart>('IsValidLocale');
// Locale : DWORD -> Uint32
// dwFlags : IS_VALID_LOCALE_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IsValidLocale(
  Locale: DWORD;   // DWORD
  dwFlags: DWORD   // IS_VALID_LOCALE_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'IsValidLocale';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "IsValidLocale"
  c_IsValidLocale :: Word32 -> Word32 -> IO CInt
-- Locale : DWORD -> Word32
-- dwFlags : IS_VALID_LOCALE_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let isvalidlocale =
  foreign "IsValidLocale"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* Locale : DWORD -> uint32_t *)
(* dwFlags : IS_VALID_LOCALE_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("IsValidLocale" is-valid-locale :convention :stdcall) :int32
  (locale :uint32)   ; DWORD
  (dw-flags :uint32))   ; IS_VALID_LOCALE_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsValidLocale = Win32::API::More->new('KERNEL32',
    'BOOL IsValidLocale(DWORD Locale, DWORD dwFlags)');
# my $ret = $IsValidLocale->Call($Locale, $dwFlags);
# Locale : DWORD -> DWORD
# dwFlags : IS_VALID_LOCALE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型