Win32 API 日本語リファレンス
ホームSystem.Ole › SafeArrayCopyData

SafeArrayCopyData

関数
SAFEARRAYのデータを別のSAFEARRAYへコピーする。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT SafeArrayCopyData(
    SAFEARRAY* psaSource,
    SAFEARRAY* psaTarget
);

パラメーター

名前方向説明
psaSourceSAFEARRAY*inコピー元のセーフ配列です。
psaTargetSAFEARRAY*inコピー先のターゲットとなるセーフ配列です。

戻り値の型: HRESULT

公式ドキュメント

ターゲット配列内のリソースを解放した後、ソース配列を指定されたターゲット配列にコピーします。

戻り値

この関数は次のいずれかの値を返すことがあります。

戻り値 説明
S_OK
成功しました。
E_INVALIDARG
引数 psa が無効でした。
E_OUTOFMEMORY
操作を完了するためのメモリが不足しています。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT SafeArrayCopyData(
    SAFEARRAY* psaSource,
    SAFEARRAY* psaTarget
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayCopyData(
    IntPtr psaSource,   // SAFEARRAY*
    IntPtr psaTarget   // SAFEARRAY*
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayCopyData(
    psaSource As IntPtr,   ' SAFEARRAY*
    psaTarget As IntPtr   ' SAFEARRAY*
) As Integer
End Function
' psaSource : SAFEARRAY*
' psaTarget : SAFEARRAY*
Declare PtrSafe Function SafeArrayCopyData Lib "oleaut32" ( _
    ByVal psaSource As LongPtr, _
    ByVal psaTarget As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SafeArrayCopyData = ctypes.windll.oleaut32.SafeArrayCopyData
SafeArrayCopyData.restype = ctypes.c_int
SafeArrayCopyData.argtypes = [
    ctypes.c_void_p,  # psaSource : SAFEARRAY*
    ctypes.c_void_p,  # psaTarget : SAFEARRAY*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayCopyData = Fiddle::Function.new(
  lib['SafeArrayCopyData'],
  [
    Fiddle::TYPE_VOIDP,  # psaSource : SAFEARRAY*
    Fiddle::TYPE_VOIDP,  # psaTarget : SAFEARRAY*
  ],
  Fiddle::TYPE_INT)
#[link(name = "oleaut32")]
extern "system" {
    fn SafeArrayCopyData(
        psaSource: *mut SAFEARRAY,  // SAFEARRAY*
        psaTarget: *mut SAFEARRAY  // SAFEARRAY*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int SafeArrayCopyData(IntPtr psaSource, IntPtr psaTarget);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayCopyData' -Namespace Win32 -PassThru
# $api::SafeArrayCopyData(psaSource, psaTarget)
#uselib "OLEAUT32.dll"
#func global SafeArrayCopyData "SafeArrayCopyData" sptr, sptr
; SafeArrayCopyData varptr(psaSource), varptr(psaTarget)   ; 戻り値は stat
; psaSource : SAFEARRAY* -> "sptr"
; psaTarget : SAFEARRAY* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLEAUT32.dll"
#cfunc global SafeArrayCopyData "SafeArrayCopyData" var, var
; res = SafeArrayCopyData(psaSource, psaTarget)
; psaSource : SAFEARRAY* -> "var"
; psaTarget : SAFEARRAY* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SafeArrayCopyData(SAFEARRAY* psaSource, SAFEARRAY* psaTarget)
#uselib "OLEAUT32.dll"
#cfunc global SafeArrayCopyData "SafeArrayCopyData" var, var
; res = SafeArrayCopyData(psaSource, psaTarget)
; psaSource : SAFEARRAY* -> "var"
; psaTarget : SAFEARRAY* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSafeArrayCopyData = oleaut32.NewProc("SafeArrayCopyData")
)

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

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

typedef SafeArrayCopyDataNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef SafeArrayCopyDataDart = int Function(Pointer<Void>, Pointer<Void>);
final SafeArrayCopyData = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SafeArrayCopyDataNative, SafeArrayCopyDataDart>('SafeArrayCopyData');
// psaSource : SAFEARRAY* -> Pointer<Void>
// psaTarget : SAFEARRAY* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SafeArrayCopyData(
  psaSource: Pointer;   // SAFEARRAY*
  psaTarget: Pointer   // SAFEARRAY*
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'SafeArrayCopyData';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SafeArrayCopyData"
  c_SafeArrayCopyData :: Ptr () -> Ptr () -> IO Int32
-- psaSource : SAFEARRAY* -> Ptr ()
-- psaTarget : SAFEARRAY* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let safearraycopydata =
  foreign "SafeArrayCopyData"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* psaSource : SAFEARRAY* -> (ptr void) *)
(* psaTarget : SAFEARRAY* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("SafeArrayCopyData" safe-array-copy-data :convention :stdcall) :int32
  (psa-source :pointer)   ; SAFEARRAY*
  (psa-target :pointer))   ; SAFEARRAY*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SafeArrayCopyData = Win32::API::More->new('OLEAUT32',
    'int SafeArrayCopyData(LPVOID psaSource, LPVOID psaTarget)');
# my $ret = $SafeArrayCopyData->Call($psaSource, $psaTarget);
# psaSource : SAFEARRAY* -> LPVOID
# psaTarget : SAFEARRAY* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型