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

DPA_SaveStream

関数
動的ポインタ配列をストリームに保存する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT DPA_SaveStream(
    HDPA hdpa,
    PFNDPASTREAM pfn,
    IStream* pstream,
    void* pvInstData   // optional
);

パラメーター

名前方向説明
hdpaHDPAinDPA へのハンドルを受け取ります。
pfnPFNDPASTREAMinコールバック関数です。コールバック関数のプロトタイプについては PFNDPASTREAM を参照してください。
pstreamIStream*inIStream オブジェクトです。
pvInstDatavoid*inoptionalコールバックデータへのポインターです。pvInstDatapfn へのパラメーターとして渡されます。

戻り値の型: HRESULT

公式ドキュメント

ヘッダーを書き出し、続いて指定されたコールバック関数を呼び出して各要素を書き込むことにより、動的ポインター配列 (DPA) をストリームに保存します。

戻り値

型: HRESULT

次のいずれかの値を返します。

戻り値 説明
S_OK
コールバック関数が要素の保存に失敗したものの、処理は継続すべきであることを示します。
S_FALSE
コールバックが失敗したにもかかわらず、処理が中断されなかったことを示します。
E_INVALIDARG
パラメーターのうち 1 つ以上が無効であることを示します。

解説(Remarks)

この関数は ComCtl32.dll から直接呼び出す必要があります。序数 (ordinal) は 10 です。

コールバックは pvInstData のデータをストリームに書き込む責任を負います。

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

各言語での呼び出し定義

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

HRESULT DPA_SaveStream(
    HDPA hdpa,
    PFNDPASTREAM pfn,
    IStream* pstream,
    void* pvInstData   // optional
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int DPA_SaveStream(
    IntPtr hdpa,   // HDPA
    IntPtr pfn,   // PFNDPASTREAM
    IntPtr pstream,   // IStream*
    IntPtr pvInstData   // void* optional
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function DPA_SaveStream(
    hdpa As IntPtr,   ' HDPA
    pfn As IntPtr,   ' PFNDPASTREAM
    pstream As IntPtr,   ' IStream*
    pvInstData As IntPtr   ' void* optional
) As Integer
End Function
' hdpa : HDPA
' pfn : PFNDPASTREAM
' pstream : IStream*
' pvInstData : void* optional
Declare PtrSafe Function DPA_SaveStream Lib "comctl32" ( _
    ByVal hdpa As LongPtr, _
    ByVal pfn As LongPtr, _
    ByVal pstream As LongPtr, _
    ByVal pvInstData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DPA_SaveStream = ctypes.windll.comctl32.DPA_SaveStream
DPA_SaveStream.restype = ctypes.c_int
DPA_SaveStream.argtypes = [
    ctypes.c_ssize_t,  # hdpa : HDPA
    ctypes.c_void_p,  # pfn : PFNDPASTREAM
    ctypes.c_void_p,  # pstream : IStream*
    ctypes.POINTER(None),  # pvInstData : void* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procDPA_SaveStream = comctl32.NewProc("DPA_SaveStream")
)

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

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

typedef DPA_SaveStreamNative = Int32 Function(IntPtr, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef DPA_SaveStreamDart = int Function(int, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final DPA_SaveStream = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<DPA_SaveStreamNative, DPA_SaveStreamDart>('DPA_SaveStream');
// hdpa : HDPA -> IntPtr
// pfn : PFNDPASTREAM -> Pointer<Void>
// pstream : IStream* -> Pointer<Void>
// pvInstData : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DPA_SaveStream(
  hdpa: NativeInt;   // HDPA
  pfn: Pointer;   // PFNDPASTREAM
  pstream: Pointer;   // IStream*
  pvInstData: Pointer   // void* optional
): Integer; stdcall;
  external 'COMCTL32.dll' name 'DPA_SaveStream';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DPA_SaveStream"
  c_DPA_SaveStream :: CIntPtr -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- hdpa : HDPA -> CIntPtr
-- pfn : PFNDPASTREAM -> Ptr ()
-- pstream : IStream* -> Ptr ()
-- pvInstData : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dpa_savestream =
  foreign "DPA_SaveStream"
    (intptr_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hdpa : HDPA -> intptr_t *)
(* pfn : PFNDPASTREAM -> (ptr void) *)
(* pstream : IStream* -> (ptr void) *)
(* pvInstData : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("DPA_SaveStream" dpa-save-stream :convention :stdcall) :int32
  (hdpa :int64)   ; HDPA
  (pfn :pointer)   ; PFNDPASTREAM
  (pstream :pointer)   ; IStream*
  (pv-inst-data :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DPA_SaveStream = Win32::API::More->new('COMCTL32',
    'int DPA_SaveStream(LPARAM hdpa, LPVOID pfn, LPVOID pstream, LPVOID pvInstData)');
# my $ret = $DPA_SaveStream->Call($hdpa, $pfn, $pstream, $pvInstData);
# hdpa : HDPA -> LPARAM
# pfn : PFNDPASTREAM -> LPVOID
# pstream : IStream* -> LPVOID
# pvInstData : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型