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

ImageList_WriteEx

関数
フラグ指定でイメージリストをストリームに書き込む。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT ImageList_WriteEx(
    HIMAGELIST himl,
    IMAGE_LIST_WRITE_STREAM_FLAGS dwFlags,
    IStream* pstm
);

パラメーター

名前方向説明
himlHIMAGELISTinイメージリストへのハンドルです。
dwFlagsIMAGE_LIST_WRITE_STREAM_FLAGSin

ストリームの書き込み方法を指定するフラグです。

意味
ILP_NORMAL
コモンコントロール 6.0 のファイル形式を使用してストリームに書き込みます。このバージョンで新たに追加されたイメージリスト属性に関する情報が含まれます。
ILP_DOWNLEVEL
バージョン 6.0 より前のファイル形式を使用してストリームに書き込みます。バージョン 6.0 より前のコモンコントロールで読み込んだイメージリストを保存する必要がある場合に、このフラグを指定します。
pstmIStream*inストリームのアドレスです。

戻り値の型: HRESULT

公式ドキュメント

イメージリストをストリームに書き込みます。(ImageList_WriteEx)

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ILP_DOWNLEVEL フラグで書き込まれるイメージリストを ILC_COLOR32 で作成しないでください。

ImageList_WriteEx を使用するには、アプリケーションのマニフェストで Comctl32.dll のバージョン 6 を指定する必要があります。マニフェストの詳細については、ビジュアルスタイルの有効化を参照してください。

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

各言語での呼び出し定義

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

HRESULT ImageList_WriteEx(
    HIMAGELIST himl,
    IMAGE_LIST_WRITE_STREAM_FLAGS dwFlags,
    IStream* pstm
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int ImageList_WriteEx(
    IntPtr himl,   // HIMAGELIST
    uint dwFlags,   // IMAGE_LIST_WRITE_STREAM_FLAGS
    IntPtr pstm   // IStream*
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function ImageList_WriteEx(
    himl As IntPtr,   ' HIMAGELIST
    dwFlags As UInteger,   ' IMAGE_LIST_WRITE_STREAM_FLAGS
    pstm As IntPtr   ' IStream*
) As Integer
End Function
' himl : HIMAGELIST
' dwFlags : IMAGE_LIST_WRITE_STREAM_FLAGS
' pstm : IStream*
Declare PtrSafe Function ImageList_WriteEx Lib "comctl32" ( _
    ByVal himl As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pstm As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImageList_WriteEx = ctypes.windll.comctl32.ImageList_WriteEx
ImageList_WriteEx.restype = ctypes.c_int
ImageList_WriteEx.argtypes = [
    ctypes.c_ssize_t,  # himl : HIMAGELIST
    wintypes.DWORD,  # dwFlags : IMAGE_LIST_WRITE_STREAM_FLAGS
    ctypes.c_void_p,  # pstm : IStream*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procImageList_WriteEx = comctl32.NewProc("ImageList_WriteEx")
)

// himl (HIMAGELIST), dwFlags (IMAGE_LIST_WRITE_STREAM_FLAGS), pstm (IStream*)
r1, _, err := procImageList_WriteEx.Call(
	uintptr(himl),
	uintptr(dwFlags),
	uintptr(pstm),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function ImageList_WriteEx(
  himl: NativeInt;   // HIMAGELIST
  dwFlags: DWORD;   // IMAGE_LIST_WRITE_STREAM_FLAGS
  pstm: Pointer   // IStream*
): Integer; stdcall;
  external 'COMCTL32.dll' name 'ImageList_WriteEx';
result := DllCall("COMCTL32\ImageList_WriteEx"
    , "Ptr", himl   ; HIMAGELIST
    , "UInt", dwFlags   ; IMAGE_LIST_WRITE_STREAM_FLAGS
    , "Ptr", pstm   ; IStream*
    , "Int")   ; return: HRESULT
●ImageList_WriteEx(himl, dwFlags, pstm) = DLL("COMCTL32.dll", "int ImageList_WriteEx(int, dword, void*)")
# 呼び出し: ImageList_WriteEx(himl, dwFlags, pstm)
# himl : HIMAGELIST -> "int"
# dwFlags : IMAGE_LIST_WRITE_STREAM_FLAGS -> "dword"
# pstm : IStream* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ImageList_WriteExNative = Int32 Function(IntPtr, Uint32, Pointer<Void>);
typedef ImageList_WriteExDart = int Function(int, int, Pointer<Void>);
final ImageList_WriteEx = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<ImageList_WriteExNative, ImageList_WriteExDart>('ImageList_WriteEx');
// himl : HIMAGELIST -> IntPtr
// dwFlags : IMAGE_LIST_WRITE_STREAM_FLAGS -> Uint32
// pstm : IStream* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImageList_WriteEx(
  himl: NativeInt;   // HIMAGELIST
  dwFlags: DWORD;   // IMAGE_LIST_WRITE_STREAM_FLAGS
  pstm: Pointer   // IStream*
): Integer; stdcall;
  external 'COMCTL32.dll' name 'ImageList_WriteEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImageList_WriteEx"
  c_ImageList_WriteEx :: CIntPtr -> Word32 -> Ptr () -> IO Int32
-- himl : HIMAGELIST -> CIntPtr
-- dwFlags : IMAGE_LIST_WRITE_STREAM_FLAGS -> Word32
-- pstm : IStream* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let imagelist_writeex =
  foreign "ImageList_WriteEx"
    (intptr_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* himl : HIMAGELIST -> intptr_t *)
(* dwFlags : IMAGE_LIST_WRITE_STREAM_FLAGS -> uint32_t *)
(* pstm : IStream* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("ImageList_WriteEx" image-list-write-ex :convention :stdcall) :int32
  (himl :int64)   ; HIMAGELIST
  (dw-flags :uint32)   ; IMAGE_LIST_WRITE_STREAM_FLAGS
  (pstm :pointer))   ; IStream*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImageList_WriteEx = Win32::API::More->new('COMCTL32',
    'int ImageList_WriteEx(LPARAM himl, DWORD dwFlags, LPVOID pstm)');
# my $ret = $ImageList_WriteEx->Call($himl, $dwFlags, $pstm);
# himl : HIMAGELIST -> LPARAM
# dwFlags : IMAGE_LIST_WRITE_STREAM_FLAGS -> DWORD
# pstm : IStream* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型