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

ConvertIndexToColorName

関数
インデックス値を対応する色名に変換する。
DLLmscms.dll呼出規約winapi

シグネチャ

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

BOOL ConvertIndexToColorName(
    INT_PTR hProfile,
    DWORD* paIndex,
    CHAR** paColorName,
    DWORD dwCount
);

パラメーター

名前方向説明
hProfileINT_PTRinインデックス変換に使用する名前付きカラープロファイルハンドル。
paIndexDWORD*in入力するインデックス値のDWORD配列へのポインタ。
paColorNameCHAR**out変換結果の色名文字列(固定長)の配列を受け取るポインタ。
dwCountDWORDin変換するインデックス・色名の個数。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ConvertIndexToColorName(
    INT_PTR hProfile,
    DWORD* paIndex,
    CHAR** paColorName,
    DWORD dwCount
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mscms.dll", ExactSpelling = true)]
static extern bool ConvertIndexToColorName(
    IntPtr hProfile,   // INT_PTR
    ref uint paIndex,   // DWORD*
    IntPtr paColorName,   // CHAR** out
    uint dwCount   // DWORD
);
<DllImport("mscms.dll", ExactSpelling:=True)>
Public Shared Function ConvertIndexToColorName(
    hProfile As IntPtr,   ' INT_PTR
    ByRef paIndex As UInteger,   ' DWORD*
    paColorName As IntPtr,   ' CHAR** out
    dwCount As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProfile : INT_PTR
' paIndex : DWORD*
' paColorName : CHAR** out
' dwCount : DWORD
Declare PtrSafe Function ConvertIndexToColorName Lib "mscms" ( _
    ByVal hProfile As LongPtr, _
    ByRef paIndex As Long, _
    ByVal paColorName As LongPtr, _
    ByVal dwCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ConvertIndexToColorName = ctypes.windll.mscms.ConvertIndexToColorName
ConvertIndexToColorName.restype = wintypes.BOOL
ConvertIndexToColorName.argtypes = [
    ctypes.c_ssize_t,  # hProfile : INT_PTR
    ctypes.POINTER(wintypes.DWORD),  # paIndex : DWORD*
    ctypes.c_void_p,  # paColorName : CHAR** out
    wintypes.DWORD,  # dwCount : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('mscms.dll')
ConvertIndexToColorName = Fiddle::Function.new(
  lib['ConvertIndexToColorName'],
  [
    Fiddle::TYPE_INTPTR_T,  # hProfile : INT_PTR
    Fiddle::TYPE_VOIDP,  # paIndex : DWORD*
    Fiddle::TYPE_VOIDP,  # paColorName : CHAR** out
    -Fiddle::TYPE_INT,  # dwCount : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "mscms")]
extern "system" {
    fn ConvertIndexToColorName(
        hProfile: isize,  // INT_PTR
        paIndex: *mut u32,  // DWORD*
        paColorName: *mut *mut i8,  // CHAR** out
        dwCount: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mscms.dll")]
public static extern bool ConvertIndexToColorName(IntPtr hProfile, ref uint paIndex, IntPtr paColorName, uint dwCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'mscms_ConvertIndexToColorName' -Namespace Win32 -PassThru
# $api::ConvertIndexToColorName(hProfile, paIndex, paColorName, dwCount)
#uselib "mscms.dll"
#func global ConvertIndexToColorName "ConvertIndexToColorName" sptr, sptr, sptr, sptr
; ConvertIndexToColorName hProfile, varptr(paIndex), varptr(paColorName), dwCount   ; 戻り値は stat
; hProfile : INT_PTR -> "sptr"
; paIndex : DWORD* -> "sptr"
; paColorName : CHAR** out -> "sptr"
; dwCount : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "mscms.dll"
#cfunc global ConvertIndexToColorName "ConvertIndexToColorName" sptr, var, var, int
; res = ConvertIndexToColorName(hProfile, paIndex, paColorName, dwCount)
; hProfile : INT_PTR -> "sptr"
; paIndex : DWORD* -> "var"
; paColorName : CHAR** out -> "var"
; dwCount : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ConvertIndexToColorName(INT_PTR hProfile, DWORD* paIndex, CHAR** paColorName, DWORD dwCount)
#uselib "mscms.dll"
#cfunc global ConvertIndexToColorName "ConvertIndexToColorName" intptr, var, var, int
; res = ConvertIndexToColorName(hProfile, paIndex, paColorName, dwCount)
; hProfile : INT_PTR -> "intptr"
; paIndex : DWORD* -> "var"
; paColorName : CHAR** out -> "var"
; dwCount : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mscms = windows.NewLazySystemDLL("mscms.dll")
	procConvertIndexToColorName = mscms.NewProc("ConvertIndexToColorName")
)

// hProfile (INT_PTR), paIndex (DWORD*), paColorName (CHAR** out), dwCount (DWORD)
r1, _, err := procConvertIndexToColorName.Call(
	uintptr(hProfile),
	uintptr(paIndex),
	uintptr(paColorName),
	uintptr(dwCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ConvertIndexToColorName(
  hProfile: NativeInt;   // INT_PTR
  paIndex: Pointer;   // DWORD*
  paColorName: Pointer;   // CHAR** out
  dwCount: DWORD   // DWORD
): BOOL; stdcall;
  external 'mscms.dll' name 'ConvertIndexToColorName';
result := DllCall("mscms\ConvertIndexToColorName"
    , "Ptr", hProfile   ; INT_PTR
    , "Ptr", paIndex   ; DWORD*
    , "Ptr", paColorName   ; CHAR** out
    , "UInt", dwCount   ; DWORD
    , "Int")   ; return: BOOL
●ConvertIndexToColorName(hProfile, paIndex, paColorName, dwCount) = DLL("mscms.dll", "bool ConvertIndexToColorName(int, void*, void*, dword)")
# 呼び出し: ConvertIndexToColorName(hProfile, paIndex, paColorName, dwCount)
# hProfile : INT_PTR -> "int"
# paIndex : DWORD* -> "void*"
# paColorName : CHAR** out -> "void*"
# dwCount : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "mscms" fn ConvertIndexToColorName(
    hProfile: isize, // INT_PTR
    paIndex: [*c]u32, // DWORD*
    paColorName: [*c][*c]i8, // CHAR** out
    dwCount: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc ConvertIndexToColorName(
    hProfile: int,  # INT_PTR
    paIndex: ptr uint32,  # DWORD*
    paColorName: ptr int8,  # CHAR** out
    dwCount: uint32  # DWORD
): int32 {.importc: "ConvertIndexToColorName", stdcall, dynlib: "mscms.dll".}
pragma(lib, "mscms");
extern(Windows)
int ConvertIndexToColorName(
    ptrdiff_t hProfile,   // INT_PTR
    uint* paIndex,   // DWORD*
    byte** paColorName,   // CHAR** out
    uint dwCount   // DWORD
);
ccall((:ConvertIndexToColorName, "mscms.dll"), stdcall, Int32,
      (Int, Ptr{UInt32}, Ptr{Int8}, UInt32),
      hProfile, paIndex, paColorName, dwCount)
# hProfile : INT_PTR -> Int
# paIndex : DWORD* -> Ptr{UInt32}
# paColorName : CHAR** out -> Ptr{Int8}
# dwCount : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ConvertIndexToColorName(
    intptr_t hProfile,
    uint32_t* paIndex,
    int8_t** paColorName,
    uint32_t dwCount);
]]
local mscms = ffi.load("mscms")
-- mscms.ConvertIndexToColorName(hProfile, paIndex, paColorName, dwCount)
-- hProfile : INT_PTR
-- paIndex : DWORD*
-- paColorName : CHAR** out
-- dwCount : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('mscms.dll');
const ConvertIndexToColorName = lib.func('__stdcall', 'ConvertIndexToColorName', 'int32_t', ['intptr_t', 'uint32_t *', 'int8_t *', 'uint32_t']);
// ConvertIndexToColorName(hProfile, paIndex, paColorName, dwCount)
// hProfile : INT_PTR -> 'intptr_t'
// paIndex : DWORD* -> 'uint32_t *'
// paColorName : CHAR** out -> 'int8_t *'
// dwCount : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("mscms.dll", {
  ConvertIndexToColorName: { parameters: ["isize", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.ConvertIndexToColorName(hProfile, paIndex, paColorName, dwCount)
// hProfile : INT_PTR -> "isize"
// paIndex : DWORD* -> "pointer"
// paColorName : CHAR** out -> "pointer"
// dwCount : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ConvertIndexToColorName(
    intptr_t hProfile,
    uint32_t* paIndex,
    int8_t** paColorName,
    uint32_t dwCount);
C, "mscms.dll");
// $ffi->ConvertIndexToColorName(hProfile, paIndex, paColorName, dwCount);
// hProfile : INT_PTR
// paIndex : DWORD*
// paColorName : CHAR** out
// dwCount : DWORD
// 構造体/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 Mscms extends StdCallLibrary {
    Mscms INSTANCE = Native.load("mscms", Mscms.class);
    boolean ConvertIndexToColorName(
        long hProfile,   // INT_PTR
        IntByReference paIndex,   // DWORD*
        Pointer paColorName,   // CHAR** out
        int dwCount   // DWORD
    );
}
@[Link("mscms")]
lib Libmscms
  fun ConvertIndexToColorName = ConvertIndexToColorName(
    hProfile : LibC::SSizeT,   # INT_PTR
    paIndex : UInt32*,   # DWORD*
    paColorName : Int8**,   # CHAR** out
    dwCount : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ConvertIndexToColorNameNative = Int32 Function(IntPtr, Pointer<Uint32>, Pointer<Int8>, Uint32);
typedef ConvertIndexToColorNameDart = int Function(int, Pointer<Uint32>, Pointer<Int8>, int);
final ConvertIndexToColorName = DynamicLibrary.open('mscms.dll')
    .lookupFunction<ConvertIndexToColorNameNative, ConvertIndexToColorNameDart>('ConvertIndexToColorName');
// hProfile : INT_PTR -> IntPtr
// paIndex : DWORD* -> Pointer<Uint32>
// paColorName : CHAR** out -> Pointer<Int8>
// dwCount : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ConvertIndexToColorName(
  hProfile: NativeInt;   // INT_PTR
  paIndex: Pointer;   // DWORD*
  paColorName: Pointer;   // CHAR** out
  dwCount: DWORD   // DWORD
): BOOL; stdcall;
  external 'mscms.dll' name 'ConvertIndexToColorName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ConvertIndexToColorName"
  c_ConvertIndexToColorName :: CIntPtr -> Ptr Word32 -> Ptr Int8 -> Word32 -> IO CInt
-- hProfile : INT_PTR -> CIntPtr
-- paIndex : DWORD* -> Ptr Word32
-- paColorName : CHAR** out -> Ptr Int8
-- dwCount : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let convertindextocolorname =
  foreign "ConvertIndexToColorName"
    (intptr_t @-> (ptr uint32_t) @-> (ptr int8_t) @-> uint32_t @-> returning int32_t)
(* hProfile : INT_PTR -> intptr_t *)
(* paIndex : DWORD* -> (ptr uint32_t) *)
(* paColorName : CHAR** out -> (ptr int8_t) *)
(* dwCount : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mscms (t "mscms.dll"))
(cffi:use-foreign-library mscms)

(cffi:defcfun ("ConvertIndexToColorName" convert-index-to-color-name :convention :stdcall) :int32
  (h-profile :int64)   ; INT_PTR
  (pa-index :pointer)   ; DWORD*
  (pa-color-name :pointer)   ; CHAR** out
  (dw-count :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ConvertIndexToColorName = Win32::API::More->new('mscms',
    'BOOL ConvertIndexToColorName(LPARAM hProfile, LPVOID paIndex, LPVOID paColorName, DWORD dwCount)');
# my $ret = $ConvertIndexToColorName->Call($hProfile, $paIndex, $paColorName, $dwCount);
# hProfile : INT_PTR -> LPARAM
# paIndex : DWORD* -> LPVOID
# paColorName : CHAR** out -> LPVOID
# dwCount : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。