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

SetCalendarInfoA

関数
指定ロケールと暦のカレンダー情報を設定する。ANSI版。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetCalendarInfoA(
    DWORD Locale,
    DWORD Calendar,
    DWORD CalType,
    LPCSTR lpCalData
);

パラメーター

名前方向説明
LocaleDWORDin

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

次のカスタムロケール識別子もサポートされています。
CalendarDWORDin情報を設定する対象のカレンダーの カレンダー識別子です。
CalTypeDWORDin

設定するカレンダー情報の種類です。この関数で有効なのは、次の CALTYPE 値のみです。CAL_USE_CP_ACP 定数は、この関数の ANSI 版でのみ意味を持ちます。

アプリケーションは、この関数の 1 回の呼び出しにつき 1 つのカレンダー識別子のみを指定できます。例外として、アプリケーションがバイナリ OR 演算子を使用して CAL_USE_CP_ACPCalendar Type Information で定義された有効な CALTYPE 値と組み合わせる場合は許可されます。
lpCalDataLPCSTRinnull で終わるカレンダー情報文字列へのポインターです。情報は、指定したカレンダー種別の形式である必要があります。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

解説(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  (ANSI / -A)
#include <windows.h>

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

SetCalendarInfoA = ctypes.windll.kernel32.SetCalendarInfoA
SetCalendarInfoA.restype = wintypes.BOOL
SetCalendarInfoA.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # Calendar : DWORD
    wintypes.DWORD,  # CalType : DWORD
    wintypes.LPCSTR,  # lpCalData : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetCalendarInfoA = kernel32.NewProc("SetCalendarInfoA")
)

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

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

typedef SetCalendarInfoANative = Int32 Function(Uint32, Uint32, Uint32, Pointer<Utf8>);
typedef SetCalendarInfoADart = int Function(int, int, int, Pointer<Utf8>);
final SetCalendarInfoA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetCalendarInfoANative, SetCalendarInfoADart>('SetCalendarInfoA');
// Locale : DWORD -> Uint32
// Calendar : DWORD -> Uint32
// CalType : DWORD -> Uint32
// lpCalData : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetCalendarInfoA(
  Locale: DWORD;   // DWORD
  Calendar: DWORD;   // DWORD
  CalType: DWORD;   // DWORD
  lpCalData: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetCalendarInfoA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("SetCalendarInfoA" set-calendar-info-a :convention :stdcall) :int32
  (locale :uint32)   ; DWORD
  (calendar :uint32)   ; DWORD
  (cal-type :uint32)   ; DWORD
  (lp-cal-data :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetCalendarInfoA = Win32::API::More->new('KERNEL32',
    'BOOL SetCalendarInfoA(DWORD Locale, DWORD Calendar, DWORD CalType, LPCSTR lpCalData)');
# my $ret = $SetCalendarInfoA->Call($Locale, $Calendar, $CalType, $lpCalData);
# Locale : DWORD -> DWORD
# Calendar : DWORD -> DWORD
# CalType : DWORD -> DWORD
# lpCalData : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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