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

SafeArrayGetElement

関数
SAFEARRAYから指定インデックスの要素を取得する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

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

パラメーター

名前方向説明
psaSAFEARRAY*inSafeArrayCreate によって作成された配列記述子。
rgIndicesINT*in配列の各次元に対するインデックスのベクター。最も右側(最下位)の次元が rgIndices[0] です。最も左側の次元は rgIndices[psa->cDims – 1] に格納されます。
pvvoid*out配列の要素。

戻り値の型: HRESULT

公式ドキュメント

配列の単一の要素を取得します。

戻り値

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

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

解説(Remarks)

この関数は、要素を取得する前後に SafeArrayLock および SafeArrayUnlock を自動的に呼び出します。呼び出し元は、データを受け取るために正しいサイズの記憶域を用意する必要があります。データ要素が文字列、オブジェクト、またはバリアントの場合、この関数は適切な方法で要素をコピーします。

次の例は、COM Fundamentals SPoly サンプル (Cenumpt.cpp) から引用したものです。

STDMETHODIMP CEnumPoint::Next(
   ULONG celt,
   VARIANT  rgvar[],
   ULONG * pceltFetched)
{
   unsigned int i;
   long ix;
   HRESULT hresult;

   for(i = 0; i < celt; ++i)
      VariantInit(&rgvar[i]);

   for(i = 0; i < celt; ++i){
      // Are we at the last element?
      if(m_iCurrent == m_celts){
      hresult = S_FALSE;
         goto LDone;
   }

      ix = m_iCurrent++;
      // m_psa is a global variable that holds the safe array.
      hresult = SafeArrayGetElement(m_psa, &ix, &rgvar[i]);
      if(FAILED(hresult))
         goto LError0;
   }
   hresult = NOERROR;

LDone:;
   if (pceltFetched != NULL)
      *pceltFetched = i;

   return hresult;

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

各言語での呼び出し定義

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

HRESULT SafeArrayGetElement(
    SAFEARRAY* psa,
    INT* rgIndices,
    void* pv
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayGetElement(
    IntPtr psa,   // SAFEARRAY*
    ref int rgIndices,   // INT*
    IntPtr pv   // void* out
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayGetElement(
    psa As IntPtr,   ' SAFEARRAY*
    ByRef rgIndices As Integer,   ' INT*
    pv As IntPtr   ' void* out
) As Integer
End Function
' psa : SAFEARRAY*
' rgIndices : INT*
' pv : void* out
Declare PtrSafe Function SafeArrayGetElement 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

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

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSafeArrayGetElement = oleaut32.NewProc("SafeArrayGetElement")
)

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

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

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

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

let safearraygetelement =
  foreign "SafeArrayGetElement"
    ((ptr void) @-> (ptr int32_t) @-> (ptr void) @-> returning int32_t)
(* psa : SAFEARRAY* -> (ptr void) *)
(* rgIndices : INT* -> (ptr int32_t) *)
(* pv : void* 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 ("SafeArrayGetElement" safe-array-get-element :convention :stdcall) :int32
  (psa :pointer)   ; SAFEARRAY*
  (rg-indices :pointer)   ; INT*
  (pv :pointer))   ; void* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SafeArrayGetElement = Win32::API::More->new('OLEAUT32',
    'int SafeArrayGetElement(LPVOID psa, LPVOID rgIndices, LPVOID pv)');
# my $ret = $SafeArrayGetElement->Call($psa, $rgIndices, $pv);
# psa : SAFEARRAY* -> LPVOID
# rgIndices : INT* -> LPVOID
# pv : void* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型