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

SetICMMode

関数
デバイスコンテキストのICM色管理モードを設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT SetICMMode(
    HDC hdc,
    ICM_MODE mode
);

パラメーター

名前型方向説明
hdcHDCinデバイスコンテキストのハンドルを指定します。
modeICM_MODEin

イメージカラーマネージメントのオン/オフを切り替えます。このパラメーターには、次の定数値のいずれかを指定できます。

値 意味
ICM_ON
カラーマネージメントをオンにします。ハーフトーンに対する旧形式の色補正をオフにします。
ICM_OFF
カラーマネージメントをオフにします。ハーフトーンに対する旧形式の色補正をオンにします。
ICM_QUERY
カラーマネージメントの現在の状態を照会します。
ICM_DONE_OUTSIDEDC
DC 内のカラーマネージメントをオフにします。Windows 2000 では、ハーフトーンに対する旧形式の色補正もオフにします。Windows 95 ではサポートされません。

戻り値の型: INT

公式ドキュメント

SetICMMode 関数は、指定したデバイスコンテキスト (DC) に対して Image Color Management の有効化、無効化、または状態の照会を行います。

戻り値

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

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

ICM_QUERY を指定して関数が成功した場合、返される 0 以外の値は現在のモードを示す ICM_ON または ICM_OFF です。

解説(Remarks)

デバイスの状態に一致する ICC カラープロファイルがシステムで見つからない場合、SetICMMode は失敗し、0 を返します。

デバイスコンテキスト (DC) に対して WCS が有効になると、ほとんどの Win32 API 関数によってその DC に渡された色は、カラーマッチングの対象になります。主な例外は BitBlt と StretchBlt です。これは、ある DC から別の DC へビットブロック転送 (ブリット) を行う場合、2 つの DC は既に互換性があり、色補正は不要であることが前提となっているためです。そうでない場合は、色補正が行われることがあります。具体的には、デバイス非依存ビットマップ (DIB) をブリットのソースとして使用し、WCS が有効な DC に対してブリットを実行すると、カラーマッチングが行われます。これが望ましくない場合は、BitBlt または StretchBlt を呼び出す前に SetICMMode を呼び出して、転送先の DC の WCS をオフにしてください。

CreateCompatibleDC 関数を使用して DC 内にビットマップを作成する場合、そのビットマップは、作成時とブリットの実行時の 2 回カラーマッチングされる可能性があります。これは、CreateCompatibleDC 関数で作成された DC 内のビットマップが、ソース DC の現在のブラシ、ペン、パレットを引き継ぐためです。ただし、新しい DC では WCS は既定で無効になります。その後 SetICMMode 関数を使用して新しい DC で WCS を有効にすると、色補正が行われます。CreateCompatibleDC 関数の使用による二重の色補正を防ぐには、CreateCompatibleDC 関数を呼び出す前に SetICMMode 関数を使用してソース DC の WCS をオフにしてください。

プリンターの DC から互換 DC を作成する場合 (CreateCompatibleDC を参照)、プリンターの DC でカラーマッチングが有効になっていれば、既定では常にカラーマッチングが行われます。SetDIBitsToDevice または StretchDIBits を使用してプリンターの DC にブリットを実行すると、プリンターの既定のカラープロファイルが使用されます。これが望ましくない場合は、SetDIBitsToDevice または StretchDIBits を呼び出す前に SetICMMode を呼び出して、プリンターの DC の WCS をオフにしてください。

また、WCS をオンにした状態でプリンターの DC に印刷する場合は、StartPage 関数を呼び出すたびに SetICMMode 関数を呼び出して WCS を再度オンにする必要があります。StartPage 関数は RestoreDC 関数と SaveDC 関数を呼び出すため、プリンターの DC の WCS がオフになります。

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

各言語での呼び出し定義

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

INT SetICMMode(
    HDC hdc,
    ICM_MODE mode
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int SetICMMode(
    IntPtr hdc,   // HDC
    int mode   // ICM_MODE
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetICMMode(
    hdc As IntPtr,   ' HDC
    mode As Integer   ' ICM_MODE
) As Integer
End Function
' hdc : HDC
' mode : ICM_MODE
Declare PtrSafe Function SetICMMode Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal mode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetICMMode = ctypes.windll.gdi32.SetICMMode
SetICMMode.restype = ctypes.c_int
SetICMMode.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # mode : ICM_MODE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
SetICMMode = Fiddle::Function.new(
  lib['SetICMMode'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_INT,  # mode : ICM_MODE
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn SetICMMode(
        hdc: *mut core::ffi::c_void,  // HDC
        mode: i32  // ICM_MODE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll")]
public static extern int SetICMMode(IntPtr hdc, int mode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_SetICMMode' -Namespace Win32 -PassThru
# $api::SetICMMode(hdc, mode)
#uselib "GDI32.dll"
#func global SetICMMode "SetICMMode" sptr, sptr
; SetICMMode hdc, mode   ; 戻り値は stat
; hdc : HDC -> "sptr"
; mode : ICM_MODE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global SetICMMode "SetICMMode" sptr, int
; res = SetICMMode(hdc, mode)
; hdc : HDC -> "sptr"
; mode : ICM_MODE -> "int"
; INT SetICMMode(HDC hdc, ICM_MODE mode)
#uselib "GDI32.dll"
#cfunc global SetICMMode "SetICMMode" intptr, int
; res = SetICMMode(hdc, mode)
; hdc : HDC -> "intptr"
; mode : ICM_MODE -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSetICMMode = gdi32.NewProc("SetICMMode")
)

// hdc (HDC), mode (ICM_MODE)
r1, _, err := procSetICMMode.Call(
	uintptr(hdc),
	uintptr(mode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SetICMMode(
  hdc: THandle;   // HDC
  mode: Integer   // ICM_MODE
): Integer; stdcall;
  external 'GDI32.dll' name 'SetICMMode';
result := DllCall("GDI32\SetICMMode"
    , "Ptr", hdc   ; HDC
    , "Int", mode   ; ICM_MODE
    , "Int")   ; return: INT
●SetICMMode(hdc, mode) = DLL("GDI32.dll", "int SetICMMode(void*, int)")
# 呼び出し: SetICMMode(hdc, mode)
# hdc : HDC -> "void*"
# mode : ICM_MODE -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetICMModeNative = Int32 Function(Pointer<Void>, Int32);
typedef SetICMModeDart = int Function(Pointer<Void>, int);
final SetICMMode = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<SetICMModeNative, SetICMModeDart>('SetICMMode');
// hdc : HDC -> Pointer<Void>
// mode : ICM_MODE -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetICMMode(
  hdc: THandle;   // HDC
  mode: Integer   // ICM_MODE
): Integer; stdcall;
  external 'GDI32.dll' name 'SetICMMode';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetICMMode"
  c_SetICMMode :: Ptr () -> Int32 -> IO Int32
-- hdc : HDC -> Ptr ()
-- mode : ICM_MODE -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let seticmmode =
  foreign "SetICMMode"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* mode : ICM_MODE -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("SetICMMode" set-icmmode :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (mode :int32))   ; ICM_MODE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetICMMode = Win32::API::More->new('GDI32',
    'int SetICMMode(HANDLE hdc, int mode)');
# my $ret = $SetICMMode->Call($hdc, $mode);
# hdc : HDC -> HANDLE
# mode : ICM_MODE -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型