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

UpdateICMRegKeyA

関数
ICMプロファイルのレジストリ登録を更新する(ANSI版)。
DLLGDI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL UpdateICMRegKeyA(
    DWORD reserved,   // optional
    LPSTR lpszCMID,
    LPSTR lpszFileName,
    ICM_COMMAND command
);

パラメーター

名前型方向説明
reservedDWORDoptional予約済みです。0 に設定する必要があります。
lpszCMIDLPSTRinプロファイルで使用するカラーマネジメント DLL の ICC プロファイル識別子を指定する文字列へのポインターです。
lpszFileNameLPSTRin完全修飾された ICC カラープロファイルのファイル名、または DEVMODE 構造体へのポインターです。
commandICM_COMMANDin

実行する機能を指定します。次のいずれかの値を指定できます。

値 意味
ICM_ADDPROFILE
ICC プロファイルをシステムにインストールします。
ICM_DELETEPROFILE
ICC プロファイルをシステムからアンインストールします。ただし、ファイル自体は削除されません。
ICM_QUERYPROFILE
プロファイルが既にシステムにインストールされているかどうかを判定します。
ICM_SETDEFAULTPROFILE
同等のプロファイルの中で、そのプロファイルを最優先 (既定) にします。
ICM_REGISTERICMATCHER
CMM をシステムに登録します。pszFileName パラメーターは、CMM DLL の完全修飾パスを指します。lpszCMID パラメーターは、CMM を識別する DWORD を指します。
ICM_UNREGISTERICMATCHER
CMM の登録をシステムから解除します。lpszCMID パラメーターは、CMM を識別する DWORD を指します。
ICM_QUERYMATCH
pszFileName パラメーターが指す DEVMODE 構造体に基づいて、プロファイルが存在するかどうかを判定します。

戻り値の型: BOOL

公式ドキュメント

UpdateICMRegKey 関数は、システム内のカラープロファイルとカラーマネジメントモジュール (CMM) を管理します。(ANSI)

戻り値

この関数が成功した場合、戻り値は TRUE です。

この関数が失敗した場合、戻り値は FALSE です。

解説(Remarks)

すべてのパラメーターがすべての機能で使用されるわけではありません。nCommand パラメーターで、実行する機能を指定します。

この関数は下位互換性のために残されており、将来のバージョンの ICM では削除される可能性があります。

Windows 95/98/Me: UpdateICMRegKeyW は Microsoft Layer for Unicode によってサポートされています。これを使用するには、Microsoft Layer for Unicode on Windows 95/98/Me Systems で説明されているとおり、特定のファイルをアプリケーションに追加する必要があります。

メモ

wingdi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、UpdateICMRegKey を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因になることがあります。詳細については、関数プロトタイプの規則 を参照してください。

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

各言語での呼び出し定義

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

BOOL UpdateICMRegKeyA(
    DWORD reserved,   // optional
    LPSTR lpszCMID,
    LPSTR lpszFileName,
    ICM_COMMAND command
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool UpdateICMRegKeyA(
    uint reserved,   // DWORD optional
    [MarshalAs(UnmanagedType.LPStr)] string lpszCMID,   // LPSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszFileName,   // LPSTR
    uint command   // ICM_COMMAND
);
<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function UpdateICMRegKeyA(
    reserved As UInteger,   ' DWORD optional
    <MarshalAs(UnmanagedType.LPStr)> lpszCMID As String,   ' LPSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszFileName As String,   ' LPSTR
    command As UInteger   ' ICM_COMMAND
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' reserved : DWORD optional
' lpszCMID : LPSTR
' lpszFileName : LPSTR
' command : ICM_COMMAND
Declare PtrSafe Function UpdateICMRegKeyA Lib "gdi32" ( _
    ByVal reserved As Long, _
    ByVal lpszCMID As String, _
    ByVal lpszFileName As String, _
    ByVal command As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UpdateICMRegKeyA = ctypes.windll.gdi32.UpdateICMRegKeyA
UpdateICMRegKeyA.restype = wintypes.BOOL
UpdateICMRegKeyA.argtypes = [
    wintypes.DWORD,  # reserved : DWORD optional
    wintypes.LPCSTR,  # lpszCMID : LPSTR
    wintypes.LPCSTR,  # lpszFileName : LPSTR
    wintypes.DWORD,  # command : ICM_COMMAND
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procUpdateICMRegKeyA = gdi32.NewProc("UpdateICMRegKeyA")
)

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

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

typedef UpdateICMRegKeyANative = Int32 Function(Uint32, Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef UpdateICMRegKeyADart = int Function(int, Pointer<Utf8>, Pointer<Utf8>, int);
final UpdateICMRegKeyA = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<UpdateICMRegKeyANative, UpdateICMRegKeyADart>('UpdateICMRegKeyA');
// reserved : DWORD optional -> Uint32
// lpszCMID : LPSTR -> Pointer<Utf8>
// lpszFileName : LPSTR -> Pointer<Utf8>
// command : ICM_COMMAND -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UpdateICMRegKeyA(
  reserved: DWORD;   // DWORD optional
  lpszCMID: PAnsiChar;   // LPSTR
  lpszFileName: PAnsiChar;   // LPSTR
  command: DWORD   // ICM_COMMAND
): BOOL; stdcall;
  external 'GDI32.dll' name 'UpdateICMRegKeyA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UpdateICMRegKeyA"
  c_UpdateICMRegKeyA :: Word32 -> CString -> CString -> Word32 -> IO CInt
-- reserved : DWORD optional -> Word32
-- lpszCMID : LPSTR -> CString
-- lpszFileName : LPSTR -> CString
-- command : ICM_COMMAND -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let updateicmregkeya =
  foreign "UpdateICMRegKeyA"
    (uint32_t @-> string @-> string @-> uint32_t @-> returning int32_t)
(* reserved : DWORD optional -> uint32_t *)
(* lpszCMID : LPSTR -> string *)
(* lpszFileName : LPSTR -> string *)
(* command : ICM_COMMAND -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("UpdateICMRegKeyA" update-icmreg-key-a :convention :stdcall) :int32
  (reserved :uint32)   ; DWORD optional
  (lpsz-cmid :string)   ; LPSTR
  (lpsz-file-name :string)   ; LPSTR
  (command :uint32))   ; ICM_COMMAND
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UpdateICMRegKeyA = Win32::API::More->new('GDI32',
    'BOOL UpdateICMRegKeyA(DWORD reserved, LPCSTR lpszCMID, LPCSTR lpszFileName, DWORD command)');
# my $ret = $UpdateICMRegKeyA->Call($reserved, $lpszCMID, $lpszFileName, $command);
# reserved : DWORD optional -> DWORD
# lpszCMID : LPSTR -> LPCSTR
# lpszFileName : LPSTR -> LPCSTR
# command : ICM_COMMAND -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型