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

UpdateICMRegKeyW

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

シグネチャ

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

BOOL UpdateICMRegKeyW(
    DWORD reserved,   // optional
    LPWSTR lpszCMID,
    LPWSTR lpszFileName,
    ICM_COMMAND command
);

パラメーター

名前方向説明
reservedDWORDoptional予約済みパラメータ。0を指定する必要がある。
lpszCMIDLPWSTRinカラーマッチングモジュール(CMM)のIDを指すワイド文字列ポインタ。
lpszFileNameLPWSTRin対象となるプロファイルまたはCMMのファイル名を指すワイド文字列ポインタ。
commandICM_COMMANDinレジストリ更新操作を指定する列挙値。登録・登録解除・存在確認などを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL UpdateICMRegKeyW(
    DWORD reserved,   // optional
    LPWSTR lpszCMID,
    LPWSTR lpszFileName,
    ICM_COMMAND command
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool UpdateICMRegKeyW(
    uint reserved,   // DWORD optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpszCMID,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpszFileName,   // LPWSTR
    uint command   // ICM_COMMAND
);
<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function UpdateICMRegKeyW(
    reserved As UInteger,   ' DWORD optional
    <MarshalAs(UnmanagedType.LPWStr)> lpszCMID As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszFileName As String,   ' LPWSTR
    command As UInteger   ' ICM_COMMAND
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' reserved : DWORD optional
' lpszCMID : LPWSTR
' lpszFileName : LPWSTR
' command : ICM_COMMAND
Declare PtrSafe Function UpdateICMRegKeyW Lib "gdi32" ( _
    ByVal reserved As Long, _
    ByVal lpszCMID As LongPtr, _
    ByVal lpszFileName As LongPtr, _
    ByVal command As Long) 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

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

lib = Fiddle.dlopen('GDI32.dll')
UpdateICMRegKeyW = Fiddle::Function.new(
  lib['UpdateICMRegKeyW'],
  [
    -Fiddle::TYPE_INT,  # reserved : DWORD optional
    Fiddle::TYPE_VOIDP,  # lpszCMID : LPWSTR
    Fiddle::TYPE_VOIDP,  # lpszFileName : LPWSTR
    -Fiddle::TYPE_INT,  # command : ICM_COMMAND
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "gdi32")]
extern "system" {
    fn UpdateICMRegKeyW(
        reserved: u32,  // DWORD optional
        lpszCMID: *mut u16,  // LPWSTR
        lpszFileName: *mut u16,  // LPWSTR
        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.Unicode)]
public static extern bool UpdateICMRegKeyW(uint reserved, [MarshalAs(UnmanagedType.LPWStr)] string lpszCMID, [MarshalAs(UnmanagedType.LPWStr)] string lpszFileName, uint command);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_UpdateICMRegKeyW' -Namespace Win32 -PassThru
# $api::UpdateICMRegKeyW(reserved, lpszCMID, lpszFileName, command)
#uselib "GDI32.dll"
#func global UpdateICMRegKeyW "UpdateICMRegKeyW" wptr, wptr, wptr, wptr
; UpdateICMRegKeyW reserved, lpszCMID, lpszFileName, command   ; 戻り値は stat
; reserved : DWORD optional -> "wptr"
; lpszCMID : LPWSTR -> "wptr"
; lpszFileName : LPWSTR -> "wptr"
; command : ICM_COMMAND -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global UpdateICMRegKeyW "UpdateICMRegKeyW" int, wstr, wstr, int
; res = UpdateICMRegKeyW(reserved, lpszCMID, lpszFileName, command)
; reserved : DWORD optional -> "int"
; lpszCMID : LPWSTR -> "wstr"
; lpszFileName : LPWSTR -> "wstr"
; command : ICM_COMMAND -> "int"
; BOOL UpdateICMRegKeyW(DWORD reserved, LPWSTR lpszCMID, LPWSTR lpszFileName, ICM_COMMAND command)
#uselib "GDI32.dll"
#cfunc global UpdateICMRegKeyW "UpdateICMRegKeyW" int, wstr, wstr, int
; res = UpdateICMRegKeyW(reserved, lpszCMID, lpszFileName, command)
; reserved : DWORD optional -> "int"
; lpszCMID : LPWSTR -> "wstr"
; lpszFileName : LPWSTR -> "wstr"
; command : ICM_COMMAND -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procUpdateICMRegKeyW = gdi32.NewProc("UpdateICMRegKeyW")
)

// reserved (DWORD optional), lpszCMID (LPWSTR), lpszFileName (LPWSTR), command (ICM_COMMAND)
r1, _, err := procUpdateICMRegKeyW.Call(
	uintptr(reserved),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszCMID))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszFileName))),
	uintptr(command),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function UpdateICMRegKeyW(
  reserved: DWORD;   // DWORD optional
  lpszCMID: PWideChar;   // LPWSTR
  lpszFileName: PWideChar;   // LPWSTR
  command: DWORD   // ICM_COMMAND
): BOOL; stdcall;
  external 'GDI32.dll' name 'UpdateICMRegKeyW';
result := DllCall("GDI32\UpdateICMRegKeyW"
    , "UInt", reserved   ; DWORD optional
    , "WStr", lpszCMID   ; LPWSTR
    , "WStr", lpszFileName   ; LPWSTR
    , "UInt", command   ; ICM_COMMAND
    , "Int")   ; return: BOOL
●UpdateICMRegKeyW(reserved, lpszCMID, lpszFileName, command) = DLL("GDI32.dll", "bool UpdateICMRegKeyW(dword, char*, char*, dword)")
# 呼び出し: UpdateICMRegKeyW(reserved, lpszCMID, lpszFileName, command)
# reserved : DWORD optional -> "dword"
# lpszCMID : LPWSTR -> "char*"
# lpszFileName : LPWSTR -> "char*"
# command : ICM_COMMAND -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "gdi32" fn UpdateICMRegKeyW(
    reserved: u32, // DWORD optional
    lpszCMID: [*c]const u16, // LPWSTR
    lpszFileName: [*c]const u16, // LPWSTR
    command: u32 // ICM_COMMAND
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc UpdateICMRegKeyW(
    reserved: uint32,  # DWORD optional
    lpszCMID: WideCString,  # LPWSTR
    lpszFileName: WideCString,  # LPWSTR
    command: uint32  # ICM_COMMAND
): int32 {.importc: "UpdateICMRegKeyW", stdcall, dynlib: "GDI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "gdi32");
extern(Windows)
int UpdateICMRegKeyW(
    uint reserved,   // DWORD optional
    const(wchar)* lpszCMID,   // LPWSTR
    const(wchar)* lpszFileName,   // LPWSTR
    uint command   // ICM_COMMAND
);
ccall((:UpdateICMRegKeyW, "GDI32.dll"), stdcall, Int32,
      (UInt32, Cwstring, Cwstring, UInt32),
      reserved, lpszCMID, lpszFileName, command)
# reserved : DWORD optional -> UInt32
# lpszCMID : LPWSTR -> Cwstring
# lpszFileName : LPWSTR -> Cwstring
# command : ICM_COMMAND -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t UpdateICMRegKeyW(
    uint32_t reserved,
    const uint16_t* lpszCMID,
    const uint16_t* lpszFileName,
    uint32_t command);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.UpdateICMRegKeyW(reserved, lpszCMID, lpszFileName, command)
-- reserved : DWORD optional
-- lpszCMID : LPWSTR
-- lpszFileName : LPWSTR
-- command : ICM_COMMAND
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const UpdateICMRegKeyW = lib.func('__stdcall', 'UpdateICMRegKeyW', 'int32_t', ['uint32_t', 'str16', 'str16', 'uint32_t']);
// UpdateICMRegKeyW(reserved, lpszCMID, lpszFileName, command)
// reserved : DWORD optional -> 'uint32_t'
// lpszCMID : LPWSTR -> 'str16'
// lpszFileName : LPWSTR -> 'str16'
// command : ICM_COMMAND -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  UpdateICMRegKeyW: { parameters: ["u32", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.UpdateICMRegKeyW(reserved, lpszCMID, lpszFileName, command)
// reserved : DWORD optional -> "u32"
// lpszCMID : LPWSTR -> "buffer"
// lpszFileName : LPWSTR -> "buffer"
// command : ICM_COMMAND -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UpdateICMRegKeyW(
    uint32_t reserved,
    const uint16_t* lpszCMID,
    const uint16_t* lpszFileName,
    uint32_t command);
C, "GDI32.dll");
// $ffi->UpdateICMRegKeyW(reserved, lpszCMID, lpszFileName, command);
// reserved : DWORD optional
// lpszCMID : LPWSTR
// lpszFileName : LPWSTR
// 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.UNICODE_OPTIONS);
    boolean UpdateICMRegKeyW(
        int reserved,   // DWORD optional
        WString lpszCMID,   // LPWSTR
        WString lpszFileName,   // LPWSTR
        int command   // ICM_COMMAND
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("gdi32")]
lib LibGDI32
  fun UpdateICMRegKeyW = UpdateICMRegKeyW(
    reserved : UInt32,   # DWORD optional
    lpszCMID : UInt16*,   # LPWSTR
    lpszFileName : UInt16*,   # LPWSTR
    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 UpdateICMRegKeyWNative = Int32 Function(Uint32, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef UpdateICMRegKeyWDart = int Function(int, Pointer<Utf16>, Pointer<Utf16>, int);
final UpdateICMRegKeyW = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<UpdateICMRegKeyWNative, UpdateICMRegKeyWDart>('UpdateICMRegKeyW');
// reserved : DWORD optional -> Uint32
// lpszCMID : LPWSTR -> Pointer<Utf16>
// lpszFileName : LPWSTR -> Pointer<Utf16>
// command : ICM_COMMAND -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UpdateICMRegKeyW(
  reserved: DWORD;   // DWORD optional
  lpszCMID: PWideChar;   // LPWSTR
  lpszFileName: PWideChar;   // LPWSTR
  command: DWORD   // ICM_COMMAND
): BOOL; stdcall;
  external 'GDI32.dll' name 'UpdateICMRegKeyW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let updateicmregkeyw =
  foreign "UpdateICMRegKeyW"
    (uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* reserved : DWORD optional -> uint32_t *)
(* lpszCMID : LPWSTR -> (ptr uint16_t) *)
(* lpszFileName : LPWSTR -> (ptr uint16_t) *)
(* 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 ("UpdateICMRegKeyW" update-icmreg-key-w :convention :stdcall) :int32
  (reserved :uint32)   ; DWORD optional
  (lpsz-cmid (:string :encoding :utf-16le))   ; LPWSTR
  (lpsz-file-name (:string :encoding :utf-16le))   ; LPWSTR
  (command :uint32))   ; ICM_COMMAND
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UpdateICMRegKeyW = Win32::API::More->new('GDI32',
    'BOOL UpdateICMRegKeyW(DWORD reserved, LPCWSTR lpszCMID, LPCWSTR lpszFileName, DWORD command)');
# my $ret = $UpdateICMRegKeyW->Call($reserved, $lpszCMID, $lpszFileName, $command);
# reserved : DWORD optional -> DWORD
# lpszCMID : LPWSTR -> LPCWSTR
# lpszFileName : LPWSTR -> LPCWSTR
# command : ICM_COMMAND -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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