ホーム › System.Ole › SafeArrayAccessData
SafeArrayAccessData
関数SAFEARRAYのデータへのポインタを取得しロックする。
シグネチャ
// OLEAUT32.dll
#include <windows.h>
HRESULT SafeArrayAccessData(
SAFEARRAY* psa,
void** ppvData
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| psa | SAFEARRAY* | in | SafeArrayCreate によって作成された配列記述子です。 |
| ppvData | void** | out | 配列データです。 |
戻り値の型: HRESULT
公式ドキュメント
配列のロックカウントを増やし、配列データへのポインターを取得します。
戻り値
この関数は次のいずれかの値を返します。
| 戻り値 | 説明 |
|---|---|
| 成功しました。 | |
| 引数 psa が無効です。 | |
| 配列をロックできませんでした。 |
解説(Remarks)
SafeArrayAccessData を呼び出した後は、SafeArrayUnaccessData 関数を呼び出して配列のロックを解除する必要があります。
例
次の例では、BSTR を格納する 1 次元のセーフ配列を、配列要素へ直接アクセスして並べ替えます。この方法は SafeArrayGetElement や SafeArrayPutElement を使用するよりも高速です。
long i, j, min;
BSTR bstrTemp;
BSTR HUGEP *pbstr;
HRESULT hr;
// Get a pointer to the elements of the array.
hr = SafeArrayAccessData(psa, (void HUGEP**)&pbstr);
if (FAILED(hr))
goto error;
// Selection sort.
for (i = 0; i < psa->rgsabound.cElements-1; i++)
{
min = i;
for (j = i+1; j < psa->rgsabound.cElements; j++)
{
if (wcscmp(pbstr[j], pbstr[min]) < 0)
min = j;
}
// Swap array[min] and array[i].
bstrTemp = pbstr[min];
pbstr[min] = pbstr[i];
pbstr[i] = bstrTemp;
}
SafeArrayUnaccessData(psa);
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// OLEAUT32.dll
#include <windows.h>
HRESULT SafeArrayAccessData(
SAFEARRAY* psa,
void** ppvData
);[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayAccessData(
IntPtr psa, // SAFEARRAY*
IntPtr ppvData // void** out
);<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayAccessData(
psa As IntPtr, ' SAFEARRAY*
ppvData As IntPtr ' void** out
) As Integer
End Function' psa : SAFEARRAY*
' ppvData : void** out
Declare PtrSafe Function SafeArrayAccessData Lib "oleaut32" ( _
ByVal psa As LongPtr, _
ByVal ppvData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SafeArrayAccessData = ctypes.windll.oleaut32.SafeArrayAccessData
SafeArrayAccessData.restype = ctypes.c_int
SafeArrayAccessData.argtypes = [
ctypes.c_void_p, # psa : SAFEARRAY*
ctypes.c_void_p, # ppvData : void** out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayAccessData = Fiddle::Function.new(
lib['SafeArrayAccessData'],
[
Fiddle::TYPE_VOIDP, # psa : SAFEARRAY*
Fiddle::TYPE_VOIDP, # ppvData : void** out
],
Fiddle::TYPE_INT)#[link(name = "oleaut32")]
extern "system" {
fn SafeArrayAccessData(
psa: *mut SAFEARRAY, // SAFEARRAY*
ppvData: *mut *mut () // void** out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int SafeArrayAccessData(IntPtr psa, IntPtr ppvData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayAccessData' -Namespace Win32 -PassThru
# $api::SafeArrayAccessData(psa, ppvData)#uselib "OLEAUT32.dll"
#func global SafeArrayAccessData "SafeArrayAccessData" sptr, sptr
; SafeArrayAccessData varptr(psa), ppvData ; 戻り値は stat
; psa : SAFEARRAY* -> "sptr"
; ppvData : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "OLEAUT32.dll" #cfunc global SafeArrayAccessData "SafeArrayAccessData" var, sptr ; res = SafeArrayAccessData(psa, ppvData) ; psa : SAFEARRAY* -> "var" ; ppvData : void** out -> "sptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll" #cfunc global SafeArrayAccessData "SafeArrayAccessData" sptr, sptr ; res = SafeArrayAccessData(varptr(psa), ppvData) ; psa : SAFEARRAY* -> "sptr" ; ppvData : void** out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT SafeArrayAccessData(SAFEARRAY* psa, void** ppvData) #uselib "OLEAUT32.dll" #cfunc global SafeArrayAccessData "SafeArrayAccessData" var, intptr ; res = SafeArrayAccessData(psa, ppvData) ; psa : SAFEARRAY* -> "var" ; ppvData : void** out -> "intptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT SafeArrayAccessData(SAFEARRAY* psa, void** ppvData) #uselib "OLEAUT32.dll" #cfunc global SafeArrayAccessData "SafeArrayAccessData" intptr, intptr ; res = SafeArrayAccessData(varptr(psa), ppvData) ; psa : SAFEARRAY* -> "intptr" ; ppvData : void** out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
procSafeArrayAccessData = oleaut32.NewProc("SafeArrayAccessData")
)
// psa (SAFEARRAY*), ppvData (void** out)
r1, _, err := procSafeArrayAccessData.Call(
uintptr(psa),
uintptr(ppvData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction SafeArrayAccessData(
psa: Pointer; // SAFEARRAY*
ppvData: Pointer // void** out
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SafeArrayAccessData';result := DllCall("OLEAUT32\SafeArrayAccessData"
, "Ptr", psa ; SAFEARRAY*
, "Ptr", ppvData ; void** out
, "Int") ; return: HRESULT●SafeArrayAccessData(psa, ppvData) = DLL("OLEAUT32.dll", "int SafeArrayAccessData(void*, void*)")
# 呼び出し: SafeArrayAccessData(psa, ppvData)
# psa : SAFEARRAY* -> "void*"
# ppvData : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "oleaut32" fn SafeArrayAccessData(
psa: [*c]SAFEARRAY, // SAFEARRAY*
ppvData: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i32;proc SafeArrayAccessData(
psa: ptr SAFEARRAY, # SAFEARRAY*
ppvData: pointer # void** out
): int32 {.importc: "SafeArrayAccessData", stdcall, dynlib: "OLEAUT32.dll".}pragma(lib, "oleaut32");
extern(Windows)
int SafeArrayAccessData(
SAFEARRAY* psa, // SAFEARRAY*
void** ppvData // void** out
);ccall((:SafeArrayAccessData, "OLEAUT32.dll"), stdcall, Int32,
(Ptr{SAFEARRAY}, Ptr{Cvoid}),
psa, ppvData)
# psa : SAFEARRAY* -> Ptr{SAFEARRAY}
# ppvData : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SafeArrayAccessData(
void* psa,
void** ppvData);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SafeArrayAccessData(psa, ppvData)
-- psa : SAFEARRAY*
-- ppvData : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SafeArrayAccessData = lib.func('__stdcall', 'SafeArrayAccessData', 'int32_t', ['void *', 'void *']);
// SafeArrayAccessData(psa, ppvData)
// psa : SAFEARRAY* -> 'void *'
// ppvData : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLEAUT32.dll", {
SafeArrayAccessData: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.SafeArrayAccessData(psa, ppvData)
// psa : SAFEARRAY* -> "pointer"
// ppvData : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SafeArrayAccessData(
void* psa,
void** ppvData);
C, "OLEAUT32.dll");
// $ffi->SafeArrayAccessData(psa, ppvData);
// psa : SAFEARRAY*
// 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 SafeArrayAccessData(
Pointer psa, // SAFEARRAY*
Pointer ppvData // void** out
);
}@[Link("oleaut32")]
lib LibOLEAUT32
fun SafeArrayAccessData = SafeArrayAccessData(
psa : SAFEARRAY*, # SAFEARRAY*
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 SafeArrayAccessDataNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef SafeArrayAccessDataDart = int Function(Pointer<Void>, Pointer<Void>);
final SafeArrayAccessData = DynamicLibrary.open('OLEAUT32.dll')
.lookupFunction<SafeArrayAccessDataNative, SafeArrayAccessDataDart>('SafeArrayAccessData');
// psa : SAFEARRAY* -> Pointer<Void>
// ppvData : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SafeArrayAccessData(
psa: Pointer; // SAFEARRAY*
ppvData: Pointer // void** out
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SafeArrayAccessData';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SafeArrayAccessData"
c_SafeArrayAccessData :: Ptr () -> Ptr () -> IO Int32
-- psa : SAFEARRAY* -> Ptr ()
-- ppvData : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let safearrayaccessdata =
foreign "SafeArrayAccessData"
((ptr void) @-> (ptr void) @-> returning int32_t)
(* psa : SAFEARRAY* -> (ptr void) *)
(* 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 ("SafeArrayAccessData" safe-array-access-data :convention :stdcall) :int32
(psa :pointer) ; SAFEARRAY*
(ppv-data :pointer)) ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SafeArrayAccessData = Win32::API::More->new('OLEAUT32',
'int SafeArrayAccessData(LPVOID psa, LPVOID ppvData)');
# my $ret = $SafeArrayAccessData->Call($psa, $ppvData);
# psa : SAFEARRAY* -> LPVOID
# ppvData : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
使用する型