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

SafeArrayCopy

関数
セーフ配列をデータ込みで複製し、新しいセーフ配列を作成する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT SafeArrayCopy(
    SAFEARRAY* psa,
    SAFEARRAY** ppsaOut
);

パラメーター

名前方向説明
psaSAFEARRAY*inSafeArrayCreate によって作成されたセーフ配列記述子。
ppsaOutSAFEARRAY**outセーフ配列記述子。

戻り値の型: HRESULT

公式ドキュメント

既存のセーフ配列のコピーを作成します。

戻り値

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

戻り値 説明
S_OK
成功しました。
E_INVALIDARG
引数 psa が無効でした。
E_OUTOFMEMORY
操作を完了するためのメモリが不足しています。

解説(Remarks)

コピー対象の配列に文字列型またはバリアント型のいずれかのデータ型が含まれている場合、SafeArrayCopy は文字列またはバリアントの操作関数を呼び出します。コピーされる配列にオブジェクト参照が含まれている場合は、それらのオブジェクトの参照カウントがインクリメントされます。

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

各言語での呼び出し定義

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

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

SafeArrayCopy = ctypes.windll.oleaut32.SafeArrayCopy
SafeArrayCopy.restype = ctypes.c_int
SafeArrayCopy.argtypes = [
    ctypes.c_void_p,  # psa : SAFEARRAY*
    ctypes.c_void_p,  # ppsaOut : SAFEARRAY** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSafeArrayCopy = oleaut32.NewProc("SafeArrayCopy")
)

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

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

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

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

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

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

関連項目

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