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

SafeArrayPutElement

関数
SAFEARRAYの指定インデックスに要素を格納する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT SafeArrayPutElement(
    SAFEARRAY* psa,
    INT* rgIndices,
    void* pv
);

パラメーター

名前方向説明
psaSAFEARRAY*inSafeArrayCreate で作成された配列記述子。
rgIndicesINT*in配列の各次元に対するインデックスのベクター。最も右側(最下位)の次元が rgIndices[0] です。最も左側の次元は rgIndices[psa->cDims – 1] に格納されます。
pvvoid*in配列に代入するデータ。VARIANT 型の VT_DISPATCHVT_UNKNOWNVT_BSTR はポインターであり、もう一段階の間接参照を必要としません。

戻り値の型: HRESULT

公式ドキュメント

配列内の指定した位置にデータ要素を格納します。

戻り値

この関数は次のいずれかの値を返します。

戻り値 説明
S_OK
成功しました。
DISP_E_BADINDEX
指定されたインデックスが無効です。
E_INVALIDARG
引数のいずれかが無効です。
E_OUTOFMEMORY
要素のためのメモリを割り当てられませんでした。

解説(Remarks)

この関数は、要素を代入する前後に SafeArrayLockSafeArrayUnlock を自動的に呼び出します。データ要素が文字列、オブジェクト、または VARIANT の場合、セーフ配列が破棄されるときに正しくコピーされます。既存の要素が文字列、オブジェクト、または VARIANT の場合は、正しくクリアされます。データ要素が VT_DISPATCH または VT_UNKNOWN の場合、オブジェクトの参照カウントを増やすために AddRef が呼び出されます。

注意 1 つの配列に対して複数のロックをかけることができます。配列が他の操作によってロックされている間も、要素を配列に格納できます。
SafeArrayPutElement の呼び出しを示す例については、COM Fundamentals の Lines サンプル(Lines.cpp 内の CLines::Add)を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

SafeArrayPutElement = ctypes.windll.oleaut32.SafeArrayPutElement
SafeArrayPutElement.restype = ctypes.c_int
SafeArrayPutElement.argtypes = [
    ctypes.c_void_p,  # psa : SAFEARRAY*
    ctypes.POINTER(ctypes.c_int),  # rgIndices : INT*
    ctypes.POINTER(None),  # pv : void*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSafeArrayPutElement = oleaut32.NewProc("SafeArrayPutElement")
)

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

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

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

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

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

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

関連項目

使用する型