GetICMProfileW

関数

DCに関連付けられたICMプロファイル名を取得する(Unicode版)。

DLLGDI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL GetICMProfileW(
    HDC hdc,
    DWORD* pBufSize,
    LPWSTR pszFilename   // optional
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	カラープロファイルを取得する対象のデバイスコンテキストを指定します。
pBufSize	DWORD*	inout	lpszFilename が指すバッファーのサイズを格納する DWORD へのポインター。この関数の ANSI 版ではサイズはバイト単位、Unicode 版では WCHAR 単位です。この関数が成功した場合、復帰時にこのパラメーターには実際に使用されたバッファーのサイズが格納されます。ただし、バッファーのサイズが十分でない場合、この関数は FALSE を返します。この場合、GetLastError() 関数は ERROR_INSUFFICIENT_BUFFER を返し、このパラメーターが指す DWORD には lpszFilename バッファーに必要なサイズが格納されます。
pszFilename	LPWSTR	outoptional	プロファイルのパス名を受け取るバッファーを指します。

戻り値の型: BOOL

公式ドキュメント

GetICMProfile 関数は、指定されたデバイスコンテキストの現在の出力カラープロファイルのファイル名を取得します。(Unicode)

戻り値

この関数が成功した場合、戻り値は TRUE です。また、lpszFilename パラメーターが NULL で、バッファーに必要なサイズが lpcbName にコピーされた場合も TRUE を返します。

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

解説(Remarks)

GetICMProfile は、デバイスコンテキストでカラーマネージメントが有効かどうかにかかわらず、現在の出力プロファイルのファイル名を取得します。

デバイスコンテキストを指定すると、GetICMProfile は、そのデバイスコンテキストが現在使用しているカラープロファイルを含むファイルのパス名を、パラメーター lpszFilename を通じて出力します。また、パラメーター lpcbName を通じて、そのパス名を格納する文字列の長さを出力します。

GetICMProfile が返すプロファイル名が、EnumICMProfiles が返すプロファイルの一覧に含まれていない場合があります。EnumICMProfiles 関数は、デバイスコンテキスト (DC) に関連付けられているカラースペースプロファイルのうち、その設定が DC の設定と一致するものをすべて返します。SetICMProfile 関数を使用して現在のプロファイルを設定した場合、DC の設定と一致しないプロファイルが DC に関連付けられることがあります。たとえば、SetICMProfile 関数を使用して、デバイスに依存しない sRGB プロファイルを DC に関連付けることができます。このプロファイルはその DC の現在の WCS プロファイルとして使用され、GetICMProfile の呼び出しはそのファイル名を返します。しかし、このプロファイルは EnumICMProfiles から返されるプロファイルの一覧には現れません。

この関数を SetICMProfile 関数を呼び出す前に呼び出すと、デバイスコンテキストの既定のプロファイルを取得するために使用できます。

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

メモ

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

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

各言語での呼び出し定義

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

BOOL GetICMProfileW(
    HDC hdc,
    DWORD* pBufSize,
    LPWSTR pszFilename   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool GetICMProfileW(
    IntPtr hdc,   // HDC
    ref uint pBufSize,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszFilename   // LPWSTR optional, out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetICMProfileW(
    hdc As IntPtr,   ' HDC
    ByRef pBufSize As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> pszFilename As System.Text.StringBuilder   ' LPWSTR optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' pBufSize : DWORD* in/out
' pszFilename : LPWSTR optional, out
Declare PtrSafe Function GetICMProfileW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByRef pBufSize As Long, _
    ByVal pszFilename 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

GetICMProfileW = ctypes.windll.gdi32.GetICMProfileW
GetICMProfileW.restype = wintypes.BOOL
GetICMProfileW.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.POINTER(wintypes.DWORD),  # pBufSize : DWORD* in/out
    wintypes.LPWSTR,  # pszFilename : LPWSTR optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetICMProfileW = Fiddle::Function.new(
  lib['GetICMProfileW'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # pBufSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # pszFilename : LPWSTR optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "gdi32")]
extern "system" {
    fn GetICMProfileW(
        hdc: *mut core::ffi::c_void,  // HDC
        pBufSize: *mut u32,  // DWORD* in/out
        pszFilename: *mut u16  // LPWSTR optional, out
    ) -> 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 GetICMProfileW(IntPtr hdc, ref uint pBufSize, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszFilename);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetICMProfileW' -Namespace Win32 -PassThru
# $api::GetICMProfileW(hdc, pBufSize, pszFilename)

#uselib "GDI32.dll"
#func global GetICMProfileW "GetICMProfileW" wptr, wptr, wptr
; GetICMProfileW hdc, varptr(pBufSize), varptr(pszFilename)   ; 戻り値は stat
; hdc : HDC -> "wptr"
; pBufSize : DWORD* in/out -> "wptr"
; pszFilename : LPWSTR optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global GetICMProfileW "GetICMProfileW" sptr, var, var
; res = GetICMProfileW(hdc, pBufSize, pszFilename)
; hdc : HDC -> "sptr"
; pBufSize : DWORD* in/out -> "var"
; pszFilename : LPWSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global GetICMProfileW "GetICMProfileW" sptr, sptr, sptr
; res = GetICMProfileW(hdc, varptr(pBufSize), varptr(pszFilename))
; hdc : HDC -> "sptr"
; pBufSize : DWORD* in/out -> "sptr"
; pszFilename : LPWSTR optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。