SetCalendarInfoW

関数

指定ロケールと暦のカレンダー情報を設定する。Unicode版。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetCalendarInfoW(
    DWORD Locale,
    DWORD Calendar,
    DWORD CalType,
    LPCWSTR lpCalData
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	ロケールを指定するロケール識別子です。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT 次のカスタムロケール識別子もサポートされています。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED
Calendar	DWORD	in	情報を設定する対象のカレンダーのカレンダー識別子です。
CalType	DWORD	in	設定するカレンダー情報の種類です。この関数で有効なのは、次の CALTYPE 値のみです。CAL_USE_CP_ACP 定数は、この関数の ANSI バージョンでのみ意味を持ちます。 CAL_USE_CP_ACP CAL_ITWODIGITYEARMAX アプリケーションは、この関数の呼び出しごとにカレンダー識別子を 1 つだけ指定できます。ただし、アプリケーションがバイナリ OR 演算子を使用して、CAL_USE_CP_ACP を Calendar Type Information で定義されている任意の有効な CALTYPE 値と組み合わせる場合は例外となります。
lpCalData	LPCWSTR	in	null で終端されたカレンダー情報文字列へのポインターです。この情報は、指定されたカレンダーの種類の形式である必要があります。

戻り値の型: BOOL

公式ドキュメント

カレンダーのロケール情報の項目を設定します。詳細については、「Date and Calendar」を参照してください。(Unicode)

戻り値

成功した場合は 0 以外の値を返し、それ以外の場合は 0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができます。これは次のいずれかのエラーコードを返す可能性があります。

ERROR_INTERNAL_ERROR。関数内で予期しないエラーが発生しました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

この関数は、カレンダー設定のユーザーオーバーライド部分にのみ影響します。システムの既定値は設定しません。

カレンダー情報は、この関数の Unicode バージョンでは常に null で終端された Unicode 文字列として渡され、ANSI バージョンでは null で終端された ANSI 文字列として渡されます。この関数では整数は使用できません。数値はすべて Unicode または ANSI のテキストとして指定する必要があります。

この関数の ANSI バージョンを Unicode 専用のロケール識別子とともに使用する場合、オペレーティングシステムがシステムコードページを使用するため、関数は成功することがあります。ただし、システムコードページで未定義の文字は、文字列内で疑問符 (?) として表示されます。

CAL_ITWODIGITYEARMAX は、指定されたロケールでカレンダーがサポートされていない場合でも、任意のカレンダーで使用できます。問題を回避するには、アプリケーションは EnumCalendarInfo を呼び出して、対象のロケールでカレンダーがサポートされていることを確認する必要があります。

メモ

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

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

各言語での呼び出し定義

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

BOOL SetCalendarInfoW(
    DWORD Locale,
    DWORD Calendar,
    DWORD CalType,
    LPCWSTR lpCalData
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetCalendarInfoW(
    uint Locale,   // DWORD
    uint Calendar,   // DWORD
    uint CalType,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpCalData   // LPCWSTR
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetCalendarInfoW(
    Locale As UInteger,   ' DWORD
    Calendar As UInteger,   ' DWORD
    CalType As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpCalData As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Locale : DWORD
' Calendar : DWORD
' CalType : DWORD
' lpCalData : LPCWSTR
Declare PtrSafe Function SetCalendarInfoW Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal Calendar As Long, _
    ByVal CalType As Long, _
    ByVal lpCalData As LongPtr) 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

SetCalendarInfoW = ctypes.windll.kernel32.SetCalendarInfoW
SetCalendarInfoW.restype = wintypes.BOOL
SetCalendarInfoW.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # Calendar : DWORD
    wintypes.DWORD,  # CalType : DWORD
    wintypes.LPCWSTR,  # lpCalData : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetCalendarInfoW = Fiddle::Function.new(
  lib['SetCalendarInfoW'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # Calendar : DWORD
    -Fiddle::TYPE_INT,  # CalType : DWORD
    Fiddle::TYPE_VOIDP,  # lpCalData : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn SetCalendarInfoW(
        Locale: u32,  // DWORD
        Calendar: u32,  // DWORD
        CalType: u32,  // DWORD
        lpCalData: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetCalendarInfoW(uint Locale, uint Calendar, uint CalType, [MarshalAs(UnmanagedType.LPWStr)] string lpCalData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetCalendarInfoW' -Namespace Win32 -PassThru
# $api::SetCalendarInfoW(Locale, Calendar, CalType, lpCalData)

#uselib "KERNEL32.dll"
#func global SetCalendarInfoW "SetCalendarInfoW" wptr, wptr, wptr, wptr
; SetCalendarInfoW Locale, Calendar, CalType, lpCalData   ; 戻り値は stat
; Locale : DWORD -> "wptr"
; Calendar : DWORD -> "wptr"
; CalType : DWORD -> "wptr"
; lpCalData : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global SetCalendarInfoW "SetCalendarInfoW" int, int, int, wstr
; res = SetCalendarInfoW(Locale, Calendar, CalType, lpCalData)
; Locale : DWORD -> "int"
; Calendar : DWORD -> "int"
; CalType : DWORD -> "int"
; lpCalData : LPCWSTR -> "wstr"

; BOOL SetCalendarInfoW(DWORD Locale, DWORD Calendar, DWORD CalType, LPCWSTR lpCalData)
#uselib "KERNEL32.dll"
#cfunc global SetCalendarInfoW "SetCalendarInfoW" int, int, int, wstr
; res = SetCalendarInfoW(Locale, Calendar, CalType, lpCalData)
; Locale : DWORD -> "int"
; Calendar : DWORD -> "int"
; CalType : DWORD -> "int"
; lpCalData : LPCWSTR -> "wstr"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetCalendarInfoW = kernel32.NewProc("SetCalendarInfoW")
)

// Locale (DWORD), Calendar (DWORD), CalType (DWORD), lpCalData (LPCWSTR)
r1, _, err := procSetCalendarInfoW.Call(
	uintptr(Locale),
	uintptr(Calendar),
	uintptr(CalType),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpCalData))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function SetCalendarInfoW(
  Locale: DWORD;   // DWORD
  Calendar: DWORD;   // DWORD
  CalType: DWORD;   // DWORD
  lpCalData: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetCalendarInfoW';

result := DllCall("KERNEL32\SetCalendarInfoW"
    , "UInt", Locale   ; DWORD
    , "UInt", Calendar   ; DWORD
    , "UInt", CalType   ; DWORD
    , "WStr", lpCalData   ; LPCWSTR
    , "Int")   ; return: BOOL

●SetCalendarInfoW(Locale, Calendar, CalType, lpCalData) = DLL("KERNEL32.dll", "bool SetCalendarInfoW(dword, dword, dword, char*)")
# 呼び出し: SetCalendarInfoW(Locale, Calendar, CalType, lpCalData)
# Locale : DWORD -> "dword"
# Calendar : DWORD -> "dword"
# CalType : DWORD -> "dword"
# lpCalData : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。

const std = @import("std");

extern "kernel32" fn SetCalendarInfoW(
    Locale: u32, // DWORD
    Calendar: u32, // DWORD
    CalType: u32, // DWORD
    lpCalData: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。

proc SetCalendarInfoW(
    Locale: uint32,  # DWORD
    Calendar: uint32,  # DWORD
    CalType: uint32,  # DWORD
    lpCalData: WideCString  # LPCWSTR
): int32 {.importc: "SetCalendarInfoW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。

pragma(lib, "kernel32");
extern(Windows)
int SetCalendarInfoW(
    uint Locale,   // DWORD
    uint Calendar,   // DWORD
    uint CalType,   // DWORD
    const(wchar)* lpCalData   // LPCWSTR
);

ccall((:SetCalendarInfoW, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, UInt32, UInt32, Cwstring),
      Locale, Calendar, CalType, lpCalData)
# Locale : DWORD -> UInt32
# Calendar : DWORD -> UInt32
# CalType : DWORD -> UInt32
# lpCalData : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。

local ffi = require("ffi")
ffi.cdef[[
int32_t SetCalendarInfoW(
    uint32_t Locale,
    uint32_t Calendar,
    uint32_t CalType,
    const uint16_t* lpCalData);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetCalendarInfoW(Locale, Calendar, CalType, lpCalData)
-- Locale : DWORD
-- Calendar : DWORD
-- CalType : DWORD
-- lpCalData : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetCalendarInfoW = lib.func('__stdcall', 'SetCalendarInfoW', 'int32_t', ['uint32_t', 'uint32_t', 'uint32_t', 'str16']);
// SetCalendarInfoW(Locale, Calendar, CalType, lpCalData)
// Locale : DWORD -> 'uint32_t'
// Calendar : DWORD -> 'uint32_t'
// CalType : DWORD -> 'uint32_t'
// lpCalData : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  SetCalendarInfoW: { parameters: ["u32", "u32", "u32", "buffer"], result: "i32" },
});
// lib.symbols.SetCalendarInfoW(Locale, Calendar, CalType, lpCalData)
// Locale : DWORD -> "u32"
// Calendar : DWORD -> "u32"
// CalType : DWORD -> "u32"
// lpCalData : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t SetCalendarInfoW(
    uint32_t Locale,
    uint32_t Calendar,
    uint32_t CalType,
    const uint16_t* lpCalData);
C, "KERNEL32.dll");
// $ffi->SetCalendarInfoW(Locale, Calendar, CalType, lpCalData);
// Locale : DWORD
// Calendar : DWORD
// CalType : DWORD
// lpCalData : 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, W32APIOptions.UNICODE_OPTIONS);
    boolean SetCalendarInfoW(
        int Locale,   // DWORD
        int Calendar,   // DWORD
        int CalType,   // DWORD
        WString lpCalData   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。

@[Link("kernel32")]
lib LibKERNEL32
  fun SetCalendarInfoW = SetCalendarInfoW(
    Locale : UInt32,   # DWORD
    Calendar : UInt32,   # DWORD
    CalType : UInt32,   # DWORD
    lpCalData : 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 SetCalendarInfoWNative = Int32 Function(Uint32, Uint32, Uint32, Pointer<Utf16>);
typedef SetCalendarInfoWDart = int Function(int, int, int, Pointer<Utf16>);
final SetCalendarInfoW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetCalendarInfoWNative, SetCalendarInfoWDart>('SetCalendarInfoW');
// Locale : DWORD -> Uint32
// Calendar : DWORD -> Uint32
// CalType : DWORD -> Uint32
// lpCalData : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function SetCalendarInfoW(
  Locale: DWORD;   // DWORD
  Calendar: DWORD;   // DWORD
  CalType: DWORD;   // DWORD
  lpCalData: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetCalendarInfoW';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetCalendarInfoW"
  c_SetCalendarInfoW :: Word32 -> Word32 -> Word32 -> CWString -> IO CInt
-- Locale : DWORD -> Word32
-- Calendar : DWORD -> Word32
-- CalType : DWORD -> Word32
-- lpCalData : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let setcalendarinfow =
  foreign "SetCalendarInfoW"
    (uint32_t @-> uint32_t @-> uint32_t @-> (ptr uint16_t) @-> returning int32_t)
(* Locale : DWORD -> uint32_t *)
(* Calendar : DWORD -> uint32_t *)
(* CalType : DWORD -> uint32_t *)
(* lpCalData : 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 ("SetCalendarInfoW" set-calendar-info-w :convention :stdcall) :int32
  (locale :uint32)   ; DWORD
  (calendar :uint32)   ; DWORD
  (cal-type :uint32)   ; DWORD
  (lp-cal-data (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $SetCalendarInfoW = Win32::API::More->new('KERNEL32',
    'BOOL SetCalendarInfoW(DWORD Locale, DWORD Calendar, DWORD CalType, LPCWSTR lpCalData)');
# my $ret = $SetCalendarInfoW->Call($Locale, $Calendar, $CalType, $lpCalData);
# Locale : DWORD -> DWORD
# Calendar : DWORD -> DWORD
# CalType : DWORD -> DWORD
# lpCalData : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。