ホーム › UI.ColorSystem › EnumColorProfilesW

EnumColorProfilesW

関数

条件に合うカラープロファイルを列挙する(Unicode版)。

DLLmscms.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

BOOL EnumColorProfilesW(
    LPCWSTR pMachineName,   // optional
    ENUMTYPEW* pEnumRecord,
    BYTE* pEnumerationBuffer,   // optional
    DWORD* pdwSizeOfEnumerationBuffer,
    DWORD* pnProfiles   // optional
);

パラメーター

名前	型	方向	説明
pMachineName	LPCWSTR	inoptional	予約されています。NULL を指定する必要があります。このパラメーターは、プロファイルを列挙する対象のコンピューター名を指すことを意図しています。NULL ポインターはローカルコンピューターを示します。
pEnumRecord	ENUMTYPEW*	in	列挙条件を指定する構造体へのポインター。
pEnumerationBuffer	BYTE*	outoptional	プロファイルを列挙するバッファーへのポインター。*pEnumRecord で指定された条件を満たすプロファイル名の MULTI_SZ 文字列が、このバッファーに格納されます。
pdwSizeOfEnumerationBuffer	DWORD*	inout	pBuffer が指すバッファーのサイズを格納する変数へのポインター。戻り時に、*pdwSize には実際に使用された、または必要なバッファーのサイズが格納されます。
pnProfiles	DWORD*	outoptional	戻り時に、実際にバッファーへコピーされたプロファイル名の数が格納される変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定された列挙条件を満たすすべてのプロファイルを列挙します。(Unicode)

戻り値

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

この関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

通常、プリンターには用紙とインクの種類に基づいて複数のプロファイルが関連付けられています。デバイスごとに既定のプロファイルが 1 つあります。International Color Consortium (ICC) プロファイルの場合、アプリケーションがデバイスコンテキスト (DC) を作成すると、GDI は ICC に関連付けられたプロファイルの中から最適なものを選択します。

デバイスの既定のプロファイルを特定する目的で EnumColorProfiles を使用しないでください。代わりに、そのデバイスのデバイスコンテキストを作成し、GetICMProfile 関数を呼び出してください。Windows Vista および Windows 7 では、WcsGetDefaultColorProfile 関数を使用してデバイスの既定のカラープロファイルを特定することもできます。

pEnumRecord パラメーターが指す ENUMTYPE 型の構造体の dwFields メンバーが ET_DEVICENAME に設定されている場合、この関数は、デバイスクラスに関係なく、ユーザーのコンピューターに接続されているすべての種類のデバイスに関連付けられたすべてのカラープロファイルを列挙します。pEnumRecord パラメーターが指す構造体の dwFields メンバーが ET_DEVICENAME または ET_DEVICECLASS に設定され、かつ構造体の dwDeviceClass メンバーにデバイスクラスが指定されている場合、この関数は指定されたデバイスクラスに関連付けられたプロファイルのみを列挙します。dwFields メンバーが ET_DEVICECLASS のみに設定されている場合、EnumColorProfiles 関数は、その種類のデバイスに関連付けることができるすべてのプロファイルを列挙します。

EnumColorProfiles が特定のデバイスに関連付けられたプロファイルを調べる際、その結果は、そのデバイスに関連付けられたシステム全体のプロファイル一覧を使用するか、ユーザー自身の (「ユーザーごと」の) 一覧を使用するかというユーザーの選択によって異なります。WcsSetUsePerUserProfiles を usePerUserProfiles パラメーターに TRUE を指定して呼び出すと、以降の EnumColorProfiles の呼び出しでは、指定されたデバイスについて現在のユーザーのユーザーごとのプロファイル関連付け一覧のみが参照されます。WcsSetUsePerUserProfiles を usePerUserProfiles パラメーターに FALSE を指定して呼び出すと、以降の EnumColorProfiles の呼び出しでは、指定されたデバイスについてシステム全体のプロファイル関連付け一覧が参照されます。現在のユーザーに対して WcsSetUsePerUserProfiles が一度も呼び出されていない場合、EnumColorProfiles はシステム全体の一覧を調べます。

アプリケーションは、EnumColorProfiles を使用して、プロファイルを列挙するバッファーのサイズを取得できます。その場合は、pBuffer パラメーターに NULL を指定して EnumColorProfiles 関数を呼び出します。関数から戻ると、pdwSize パラメーターに必要なバッファーのサイズがバイト単位で格納されます。プログラムはこの情報を使用して列挙用バッファーを割り当てることができます。その後、pBuffer パラメーターにそのバッファーのアドレスを指定して EnumColorProfiles を再度呼び出します。

この関数は、一貫したプロファイル列挙を可能にするために、WCS 固有の DMP 情報を従来の EnumType レコードへ変換するための情報を提供します。この情報が存在しない場合、既定値は ICC と同じになります。

ユーザーごと/LUA のサポート

列挙は現在のユーザーに固有です。システム全体のデバイス関連付けと現在のユーザーのデバイス関連付けの両方が考慮されます。既定のプロファイル構成については、現在のユーザーの設定がシステム全体の設定より優先されます。

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

各言語での呼び出し定義

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

BOOL EnumColorProfilesW(
    LPCWSTR pMachineName,   // optional
    ENUMTYPEW* pEnumRecord,
    BYTE* pEnumerationBuffer,   // optional
    DWORD* pdwSizeOfEnumerationBuffer,
    DWORD* pnProfiles   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mscms.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool EnumColorProfilesW(
    [MarshalAs(UnmanagedType.LPWStr)] string pMachineName,   // LPCWSTR optional
    IntPtr pEnumRecord,   // ENUMTYPEW*
    IntPtr pEnumerationBuffer,   // BYTE* optional, out
    ref uint pdwSizeOfEnumerationBuffer,   // DWORD* in/out
    IntPtr pnProfiles   // DWORD* optional, out
);

<DllImport("mscms.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function EnumColorProfilesW(
    <MarshalAs(UnmanagedType.LPWStr)> pMachineName As String,   ' LPCWSTR optional
    pEnumRecord As IntPtr,   ' ENUMTYPEW*
    pEnumerationBuffer As IntPtr,   ' BYTE* optional, out
    ByRef pdwSizeOfEnumerationBuffer As UInteger,   ' DWORD* in/out
    pnProfiles As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pMachineName : LPCWSTR optional
' pEnumRecord : ENUMTYPEW*
' pEnumerationBuffer : BYTE* optional, out
' pdwSizeOfEnumerationBuffer : DWORD* in/out
' pnProfiles : DWORD* optional, out
Declare PtrSafe Function EnumColorProfilesW Lib "mscms" ( _
    ByVal pMachineName As LongPtr, _
    ByVal pEnumRecord As LongPtr, _
    ByVal pEnumerationBuffer As LongPtr, _
    ByRef pdwSizeOfEnumerationBuffer As Long, _
    ByVal pnProfiles 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

EnumColorProfilesW = ctypes.windll.mscms.EnumColorProfilesW
EnumColorProfilesW.restype = wintypes.BOOL
EnumColorProfilesW.argtypes = [
    wintypes.LPCWSTR,  # pMachineName : LPCWSTR optional
    ctypes.c_void_p,  # pEnumRecord : ENUMTYPEW*
    ctypes.POINTER(ctypes.c_ubyte),  # pEnumerationBuffer : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwSizeOfEnumerationBuffer : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # pnProfiles : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('mscms.dll')
EnumColorProfilesW = Fiddle::Function.new(
  lib['EnumColorProfilesW'],
  [
    Fiddle::TYPE_VOIDP,  # pMachineName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pEnumRecord : ENUMTYPEW*
    Fiddle::TYPE_VOIDP,  # pEnumerationBuffer : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # pdwSizeOfEnumerationBuffer : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # pnProfiles : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "mscms")]
extern "system" {
    fn EnumColorProfilesW(
        pMachineName: *const u16,  // LPCWSTR optional
        pEnumRecord: *mut ENUMTYPEW,  // ENUMTYPEW*
        pEnumerationBuffer: *mut u8,  // BYTE* optional, out
        pdwSizeOfEnumerationBuffer: *mut u32,  // DWORD* in/out
        pnProfiles: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mscms.dll", CharSet = CharSet.Unicode)]
public static extern bool EnumColorProfilesW([MarshalAs(UnmanagedType.LPWStr)] string pMachineName, IntPtr pEnumRecord, IntPtr pEnumerationBuffer, ref uint pdwSizeOfEnumerationBuffer, IntPtr pnProfiles);
"@
$api = Add-Type -MemberDefinition $sig -Name 'mscms_EnumColorProfilesW' -Namespace Win32 -PassThru
# $api::EnumColorProfilesW(pMachineName, pEnumRecord, pEnumerationBuffer, pdwSizeOfEnumerationBuffer, pnProfiles)

#uselib "mscms.dll"
#func global EnumColorProfilesW "EnumColorProfilesW" wptr, wptr, wptr, wptr, wptr
; EnumColorProfilesW pMachineName, varptr(pEnumRecord), varptr(pEnumerationBuffer), varptr(pdwSizeOfEnumerationBuffer), varptr(pnProfiles)   ; 戻り値は stat
; pMachineName : LPCWSTR optional -> "wptr"
; pEnumRecord : ENUMTYPEW* -> "wptr"
; pEnumerationBuffer : BYTE* optional, out -> "wptr"
; pdwSizeOfEnumerationBuffer : DWORD* in/out -> "wptr"
; pnProfiles : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "mscms.dll"
#cfunc global EnumColorProfilesW "EnumColorProfilesW" wstr, var, var, var, var
; res = EnumColorProfilesW(pMachineName, pEnumRecord, pEnumerationBuffer, pdwSizeOfEnumerationBuffer, pnProfiles)
; pMachineName : LPCWSTR optional -> "wstr"
; pEnumRecord : ENUMTYPEW* -> "var"
; pEnumerationBuffer : BYTE* optional, out -> "var"
; pdwSizeOfEnumerationBuffer : DWORD* in/out -> "var"
; pnProfiles : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "mscms.dll"
#cfunc global EnumColorProfilesW "EnumColorProfilesW" wstr, sptr, sptr, sptr, sptr
; res = EnumColorProfilesW(pMachineName, varptr(pEnumRecord), varptr(pEnumerationBuffer), varptr(pdwSizeOfEnumerationBuffer), varptr(pnProfiles))
; pMachineName : LPCWSTR optional -> "wstr"
; pEnumRecord : ENUMTYPEW* -> "sptr"
; pEnumerationBuffer : BYTE* optional, out -> "sptr"
; pdwSizeOfEnumerationBuffer : DWORD* in/out -> "sptr"
; pnProfiles : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。