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

SafeArrayPtrOfIndex

関数
指定したインデックスのセーフ配列要素へのポインタを取得する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT SafeArrayPtrOfIndex(
    SAFEARRAY* psa,
    INT* rgIndices,
    void** ppvData
);

パラメーター

名前方向説明
psaSAFEARRAY*inSafeArrayCreate によって作成された配列記述子。
rgIndicesINT*in配列の要素を識別するインデックス値の配列。要素のすべてのインデックスを指定する必要があります。
ppvDatavoid**out配列要素。

戻り値の型: HRESULT

公式ドキュメント

配列要素へのポインターを取得します。

戻り値

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

戻り値コード 説明
S_OK
成功。
DISP_E_BADINDEX
指定されたインデックスが無効です。
E_INVALIDARG
引数の 1 つが無効です。

解説(Remarks)

SafeArrayPtrOfIndex を呼び出す前に、配列をロックしておく必要があります。配列のロックに失敗すると、予測できない結果を招くおそれがあります。

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

各言語での呼び出し定義

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

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

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

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSafeArrayPtrOfIndex = oleaut32.NewProc("SafeArrayPtrOfIndex")
)

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

extern "oleaut32" fn SafeArrayPtrOfIndex(
    psa: [*c]SAFEARRAY, // SAFEARRAY*
    rgIndices: [*c]i32, // INT*
    ppvData: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i32;
proc SafeArrayPtrOfIndex(
    psa: ptr SAFEARRAY,  # SAFEARRAY*
    rgIndices: ptr int32,  # INT*
    ppvData: pointer  # void** out
): int32 {.importc: "SafeArrayPtrOfIndex", stdcall, dynlib: "OLEAUT32.dll".}
pragma(lib, "oleaut32");
extern(Windows)
int SafeArrayPtrOfIndex(
    SAFEARRAY* psa,   // SAFEARRAY*
    int* rgIndices,   // INT*
    void** ppvData   // void** out
);
ccall((:SafeArrayPtrOfIndex, "OLEAUT32.dll"), stdcall, Int32,
      (Ptr{SAFEARRAY}, Ptr{Int32}, Ptr{Cvoid}),
      psa, rgIndices, ppvData)
# psa : SAFEARRAY* -> Ptr{SAFEARRAY}
# rgIndices : INT* -> Ptr{Int32}
# ppvData : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SafeArrayPtrOfIndex(
    void* psa,
    int32_t* rgIndices,
    void** ppvData);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SafeArrayPtrOfIndex(psa, rgIndices, ppvData)
-- psa : SAFEARRAY*
-- rgIndices : INT*
-- ppvData : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SafeArrayPtrOfIndex = lib.func('__stdcall', 'SafeArrayPtrOfIndex', 'int32_t', ['void *', 'int32_t *', 'void *']);
// SafeArrayPtrOfIndex(psa, rgIndices, ppvData)
// psa : SAFEARRAY* -> 'void *'
// rgIndices : INT* -> 'int32_t *'
// ppvData : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLEAUT32.dll", {
  SafeArrayPtrOfIndex: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SafeArrayPtrOfIndex(psa, rgIndices, ppvData)
// psa : SAFEARRAY* -> "pointer"
// rgIndices : INT* -> "pointer"
// ppvData : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SafeArrayPtrOfIndex(
    void* psa,
    int32_t* rgIndices,
    void** ppvData);
C, "OLEAUT32.dll");
// $ffi->SafeArrayPtrOfIndex(psa, rgIndices, ppvData);
// psa : SAFEARRAY*
// rgIndices : INT*
// ppvData : 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 SafeArrayPtrOfIndex(
        Pointer psa,   // SAFEARRAY*
        IntByReference rgIndices,   // INT*
        Pointer ppvData   // void** out
    );
}
@[Link("oleaut32")]
lib LibOLEAUT32
  fun SafeArrayPtrOfIndex = SafeArrayPtrOfIndex(
    psa : SAFEARRAY*,   # SAFEARRAY*
    rgIndices : Int32*,   # INT*
    ppvData : 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 SafeArrayPtrOfIndexNative = Int32 Function(Pointer<Void>, Pointer<Int32>, Pointer<Void>);
typedef SafeArrayPtrOfIndexDart = int Function(Pointer<Void>, Pointer<Int32>, Pointer<Void>);
final SafeArrayPtrOfIndex = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SafeArrayPtrOfIndexNative, SafeArrayPtrOfIndexDart>('SafeArrayPtrOfIndex');
// psa : SAFEARRAY* -> Pointer<Void>
// rgIndices : INT* -> Pointer<Int32>
// ppvData : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SafeArrayPtrOfIndex(
  psa: Pointer;   // SAFEARRAY*
  rgIndices: Pointer;   // INT*
  ppvData: Pointer   // void** out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'SafeArrayPtrOfIndex';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

使用する型