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

DPA_LoadStream

関数
ストリームから動的ポインタ配列を読み込む。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT DPA_LoadStream(
    HDPA* phdpa,
    PFNDPASTREAM pfn,
    IStream* pstream,
    void* pvInstData   // optional
);

パラメーター

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

戻り値の型: HRESULT

公式ドキュメント

指定したコールバック関数を呼び出して各要素を読み込むことで、ストリームから動的ポインター配列 (DPA) を読み込みます。

戻り値

型: HRESULT

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

戻り値 説明
S_OK
コールバック関数が成功し、要素が読み込まれたことを示します。
S_FALSE
コールバック関数が要素の読み込みに失敗したものの、処理は続行すべきであることを示します。
E_INVALIDARG
1 つ以上のパラメーターが無効であることを示します。
E_FAIL
ストリームオブジェクトを読み取れなかったことを示します。
E_OUTOFMEMORY
バッファー長が無効であるか、操作を完了するのに十分なメモリがありませんでした。

解説(Remarks)

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

コールバックは 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_LoadStream(
    HDPA* phdpa,
    PFNDPASTREAM pfn,
    IStream* pstream,
    void* pvInstData   // optional
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int DPA_LoadStream(
    out IntPtr phdpa,   // HDPA* out
    IntPtr pfn,   // PFNDPASTREAM
    IntPtr pstream,   // IStream*
    IntPtr pvInstData   // void* optional
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function DPA_LoadStream(
    <Out> ByRef phdpa As IntPtr,   ' HDPA* out
    pfn As IntPtr,   ' PFNDPASTREAM
    pstream As IntPtr,   ' IStream*
    pvInstData As IntPtr   ' void* optional
) As Integer
End Function
' phdpa : HDPA* out
' pfn : PFNDPASTREAM
' pstream : IStream*
' pvInstData : void* optional
Declare PtrSafe Function DPA_LoadStream Lib "comctl32" ( _
    ByRef phdpa 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_LoadStream = ctypes.windll.comctl32.DPA_LoadStream
DPA_LoadStream.restype = ctypes.c_int
DPA_LoadStream.argtypes = [
    ctypes.c_void_p,  # phdpa : HDPA* out
    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_LoadStream = Fiddle::Function.new(
  lib['DPA_LoadStream'],
  [
    Fiddle::TYPE_VOIDP,  # phdpa : HDPA* out
    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_LoadStream(
        phdpa: *mut isize,  // HDPA* out
        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_LoadStream(out IntPtr phdpa, IntPtr pfn, IntPtr pstream, IntPtr pvInstData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_DPA_LoadStream' -Namespace Win32 -PassThru
# $api::DPA_LoadStream(phdpa, pfn, pstream, pvInstData)
#uselib "COMCTL32.dll"
#func global DPA_LoadStream "DPA_LoadStream" sptr, sptr, sptr, sptr
; DPA_LoadStream varptr(phdpa), pfn, pstream, pvInstData   ; 戻り値は stat
; phdpa : HDPA* out -> "sptr"
; pfn : PFNDPASTREAM -> "sptr"
; pstream : IStream* -> "sptr"
; pvInstData : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "COMCTL32.dll"
#cfunc global DPA_LoadStream "DPA_LoadStream" var, sptr, sptr, sptr
; res = DPA_LoadStream(phdpa, pfn, pstream, pvInstData)
; phdpa : HDPA* out -> "var"
; pfn : PFNDPASTREAM -> "sptr"
; pstream : IStream* -> "sptr"
; pvInstData : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT DPA_LoadStream(HDPA* phdpa, PFNDPASTREAM pfn, IStream* pstream, void* pvInstData)
#uselib "COMCTL32.dll"
#cfunc global DPA_LoadStream "DPA_LoadStream" var, intptr, intptr, intptr
; res = DPA_LoadStream(phdpa, pfn, pstream, pvInstData)
; phdpa : HDPA* out -> "var"
; pfn : PFNDPASTREAM -> "intptr"
; pstream : IStream* -> "intptr"
; pvInstData : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procDPA_LoadStream = comctl32.NewProc("DPA_LoadStream")
)

// phdpa (HDPA* out), pfn (PFNDPASTREAM), pstream (IStream*), pvInstData (void* optional)
r1, _, err := procDPA_LoadStream.Call(
	uintptr(phdpa),
	uintptr(pfn),
	uintptr(pstream),
	uintptr(pvInstData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function DPA_LoadStream(
  phdpa: Pointer;   // HDPA* out
  pfn: Pointer;   // PFNDPASTREAM
  pstream: Pointer;   // IStream*
  pvInstData: Pointer   // void* optional
): Integer; stdcall;
  external 'COMCTL32.dll' name 'DPA_LoadStream';
result := DllCall("COMCTL32\DPA_LoadStream"
    , "Ptr", phdpa   ; HDPA* out
    , "Ptr", pfn   ; PFNDPASTREAM
    , "Ptr", pstream   ; IStream*
    , "Ptr", pvInstData   ; void* optional
    , "Int")   ; return: HRESULT
●DPA_LoadStream(phdpa, pfn, pstream, pvInstData) = DLL("COMCTL32.dll", "int DPA_LoadStream(void*, void*, void*, void*)")
# 呼び出し: DPA_LoadStream(phdpa, pfn, pstream, pvInstData)
# phdpa : HDPA* out -> "void*"
# 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_LoadStream(
    phdpa: [*c]isize, // HDPA* out
    pfn: ?*anyopaque, // PFNDPASTREAM
    pstream: ?*anyopaque, // IStream*
    pvInstData: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc DPA_LoadStream(
    phdpa: ptr int,  # HDPA* out
    pfn: pointer,  # PFNDPASTREAM
    pstream: pointer,  # IStream*
    pvInstData: pointer  # void* optional
): int32 {.importc: "DPA_LoadStream", stdcall, dynlib: "COMCTL32.dll".}
pragma(lib, "comctl32");
extern(Windows)
int DPA_LoadStream(
    ptrdiff_t* phdpa,   // HDPA* out
    void* pfn,   // PFNDPASTREAM
    void* pstream,   // IStream*
    void* pvInstData   // void* optional
);
ccall((:DPA_LoadStream, "COMCTL32.dll"), stdcall, Int32,
      (Ptr{Int}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
      phdpa, pfn, pstream, pvInstData)
# phdpa : HDPA* out -> Ptr{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_LoadStream(
    intptr_t* phdpa,
    void* pfn,
    void* pstream,
    void* pvInstData);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.DPA_LoadStream(phdpa, pfn, pstream, pvInstData)
-- phdpa : HDPA* out
-- 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_LoadStream = lib.func('__stdcall', 'DPA_LoadStream', 'int32_t', ['intptr_t *', 'void *', 'void *', 'void *']);
// DPA_LoadStream(phdpa, pfn, pstream, pvInstData)
// phdpa : HDPA* out -> '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_LoadStream: { parameters: ["pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.DPA_LoadStream(phdpa, pfn, pstream, pvInstData)
// phdpa : HDPA* out -> "pointer"
// pfn : PFNDPASTREAM -> "pointer"
// pstream : IStream* -> "pointer"
// pvInstData : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DPA_LoadStream(
    intptr_t* phdpa,
    void* pfn,
    void* pstream,
    void* pvInstData);
C, "COMCTL32.dll");
// $ffi->DPA_LoadStream(phdpa, pfn, pstream, pvInstData);
// phdpa : HDPA* out
// 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_LoadStream(
        LongByReference phdpa,   // HDPA* out
        Callback pfn,   // PFNDPASTREAM
        Pointer pstream,   // IStream*
        Pointer pvInstData   // void* optional
    );
}
@[Link("comctl32")]
lib LibCOMCTL32
  fun DPA_LoadStream = DPA_LoadStream(
    phdpa : LibC::SSizeT*,   # HDPA* out
    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_LoadStreamNative = Int32 Function(Pointer<IntPtr>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef DPA_LoadStreamDart = int Function(Pointer<IntPtr>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final DPA_LoadStream = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<DPA_LoadStreamNative, DPA_LoadStreamDart>('DPA_LoadStream');
// phdpa : HDPA* out -> Pointer<IntPtr>
// pfn : PFNDPASTREAM -> Pointer<Void>
// pstream : IStream* -> Pointer<Void>
// pvInstData : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DPA_LoadStream(
  phdpa: Pointer;   // HDPA* out
  pfn: Pointer;   // PFNDPASTREAM
  pstream: Pointer;   // IStream*
  pvInstData: Pointer   // void* optional
): Integer; stdcall;
  external 'COMCTL32.dll' name 'DPA_LoadStream';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let dpa_loadstream =
  foreign "DPA_LoadStream"
    ((ptr intptr_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* phdpa : HDPA* out -> (ptr 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_LoadStream" dpa-load-stream :convention :stdcall) :int32
  (phdpa :pointer)   ; HDPA* out
  (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_LoadStream = Win32::API::More->new('COMCTL32',
    'int DPA_LoadStream(LPVOID phdpa, LPVOID pfn, LPVOID pstream, LPVOID pvInstData)');
# my $ret = $DPA_LoadStream->Call($phdpa, $pfn, $pstream, $pvInstData);
# phdpa : HDPA* out -> LPVOID
# pfn : PFNDPASTREAM -> LPVOID
# pstream : IStream* -> LPVOID
# pvInstData : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型