ホーム › System.Ole › SafeArrayAllocDescriptor
SafeArrayAllocDescriptor
関数SAFEARRAYの記述子を割り当てる。
シグネチャ
// OLEAUT32.dll
#include <windows.h>
HRESULT SafeArrayAllocDescriptor(
DWORD cDims,
SAFEARRAY** ppsaOut
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| cDims | DWORD | in | 配列の次元数。 |
| ppsaOut | SAFEARRAY** | out | safe array 記述子。 |
戻り値の型: HRESULT
公式ドキュメント
safe array 記述子のためのメモリを割り当てます。
戻り値
この関数は次のいずれかの値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| 成功しました。 | |
| 引数 psa が無効でした。 | |
| 配列をロックできませんでした。 |
解説(Remarks)
この関数を使用すると、SafeArrayCreate が提供するもの以外のデータ型を持つ要素を含む safe array を作成できます。SafeArrayAllocDescriptor を使用して配列記述子を作成した後、配列記述子内の要素サイズを設定し、SafeArrayAllocData を呼び出して配列要素のためのメモリを割り当てます。
例
次の例では、SafeArrayAllocDescriptor 関数と SafeArrayAllocData 関数を使用して safe array を作成します。
SAFEARRAY *psa;
unsigned int ndim = 2;
HRESULT hresult = SafeArrayAllocDescriptor( ndim, &psa );
if( FAILED( hresult ) )
return ERR_OutOfMemory;
(psa)->rgsabound[ 0 ].lLbound = 0;
(psa)->rgsabound[ 0 ].cElements = 5;
(psa)->rgsabound[ 1 ].lLbound = 1;
(psa)->rgsabound[ 1 ].cElements = 4;
hresult = SafeArrayAllocData( psa );
if( FAILED( hresult ) ) {
SafeArrayDestroyDescriptor( psa )
return ERR_OutOfMemory;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SafeArrayAllocDescriptor(
DWORD cDims,
SAFEARRAY** ppsaOut
);[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayAllocDescriptor(
uint cDims, // DWORD
IntPtr ppsaOut // SAFEARRAY** out
);<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayAllocDescriptor(
cDims As UInteger, ' DWORD
ppsaOut As IntPtr ' SAFEARRAY** out
) As Integer
End Function' cDims : DWORD
' ppsaOut : SAFEARRAY** out
Declare PtrSafe Function SafeArrayAllocDescriptor Lib "oleaut32" ( _
ByVal cDims As Long, _
ByVal ppsaOut As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SafeArrayAllocDescriptor = ctypes.windll.oleaut32.SafeArrayAllocDescriptor
SafeArrayAllocDescriptor.restype = ctypes.c_int
SafeArrayAllocDescriptor.argtypes = [
wintypes.DWORD, # cDims : DWORD
ctypes.c_void_p, # ppsaOut : SAFEARRAY** out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayAllocDescriptor = Fiddle::Function.new(
lib['SafeArrayAllocDescriptor'],
[
-Fiddle::TYPE_INT, # cDims : DWORD
Fiddle::TYPE_VOIDP, # ppsaOut : SAFEARRAY** out
],
Fiddle::TYPE_INT)#[link(name = "oleaut32")]
extern "system" {
fn SafeArrayAllocDescriptor(
cDims: u32, // DWORD
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 SafeArrayAllocDescriptor(uint cDims, IntPtr ppsaOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayAllocDescriptor' -Namespace Win32 -PassThru
# $api::SafeArrayAllocDescriptor(cDims, ppsaOut)#uselib "OLEAUT32.dll"
#func global SafeArrayAllocDescriptor "SafeArrayAllocDescriptor" sptr, sptr
; SafeArrayAllocDescriptor cDims, varptr(ppsaOut) ; 戻り値は stat
; cDims : DWORD -> "sptr"
; ppsaOut : SAFEARRAY** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "OLEAUT32.dll" #cfunc global SafeArrayAllocDescriptor "SafeArrayAllocDescriptor" int, var ; res = SafeArrayAllocDescriptor(cDims, ppsaOut) ; cDims : DWORD -> "int" ; ppsaOut : SAFEARRAY** out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll" #cfunc global SafeArrayAllocDescriptor "SafeArrayAllocDescriptor" int, sptr ; res = SafeArrayAllocDescriptor(cDims, varptr(ppsaOut)) ; cDims : DWORD -> "int" ; ppsaOut : SAFEARRAY** out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT SafeArrayAllocDescriptor(DWORD cDims, SAFEARRAY** ppsaOut) #uselib "OLEAUT32.dll" #cfunc global SafeArrayAllocDescriptor "SafeArrayAllocDescriptor" int, var ; res = SafeArrayAllocDescriptor(cDims, ppsaOut) ; cDims : DWORD -> "int" ; ppsaOut : SAFEARRAY** out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT SafeArrayAllocDescriptor(DWORD cDims, SAFEARRAY** ppsaOut) #uselib "OLEAUT32.dll" #cfunc global SafeArrayAllocDescriptor "SafeArrayAllocDescriptor" int, intptr ; res = SafeArrayAllocDescriptor(cDims, varptr(ppsaOut)) ; cDims : DWORD -> "int" ; ppsaOut : SAFEARRAY** out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
procSafeArrayAllocDescriptor = oleaut32.NewProc("SafeArrayAllocDescriptor")
)
// cDims (DWORD), ppsaOut (SAFEARRAY** out)
r1, _, err := procSafeArrayAllocDescriptor.Call(
uintptr(cDims),
uintptr(ppsaOut),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction SafeArrayAllocDescriptor(
cDims: DWORD; // DWORD
ppsaOut: Pointer // SAFEARRAY** out
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SafeArrayAllocDescriptor';result := DllCall("OLEAUT32\SafeArrayAllocDescriptor"
, "UInt", cDims ; DWORD
, "Ptr", ppsaOut ; SAFEARRAY** out
, "Int") ; return: HRESULT●SafeArrayAllocDescriptor(cDims, ppsaOut) = DLL("OLEAUT32.dll", "int SafeArrayAllocDescriptor(dword, void*)")
# 呼び出し: SafeArrayAllocDescriptor(cDims, ppsaOut)
# cDims : DWORD -> "dword"
# ppsaOut : SAFEARRAY** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "oleaut32" fn SafeArrayAllocDescriptor(
cDims: u32, // DWORD
ppsaOut: [*c][*c]SAFEARRAY // SAFEARRAY** out
) callconv(std.os.windows.WINAPI) i32;proc SafeArrayAllocDescriptor(
cDims: uint32, # DWORD
ppsaOut: ptr SAFEARRAY # SAFEARRAY** out
): int32 {.importc: "SafeArrayAllocDescriptor", stdcall, dynlib: "OLEAUT32.dll".}pragma(lib, "oleaut32");
extern(Windows)
int SafeArrayAllocDescriptor(
uint cDims, // DWORD
SAFEARRAY** ppsaOut // SAFEARRAY** out
);ccall((:SafeArrayAllocDescriptor, "OLEAUT32.dll"), stdcall, Int32,
(UInt32, Ptr{SAFEARRAY}),
cDims, ppsaOut)
# cDims : DWORD -> UInt32
# ppsaOut : SAFEARRAY** out -> Ptr{SAFEARRAY}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SafeArrayAllocDescriptor(
uint32_t cDims,
void* ppsaOut);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SafeArrayAllocDescriptor(cDims, ppsaOut)
-- cDims : DWORD
-- ppsaOut : SAFEARRAY** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SafeArrayAllocDescriptor = lib.func('__stdcall', 'SafeArrayAllocDescriptor', 'int32_t', ['uint32_t', 'void *']);
// SafeArrayAllocDescriptor(cDims, ppsaOut)
// cDims : DWORD -> 'uint32_t'
// ppsaOut : SAFEARRAY** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLEAUT32.dll", {
SafeArrayAllocDescriptor: { parameters: ["u32", "pointer"], result: "i32" },
});
// lib.symbols.SafeArrayAllocDescriptor(cDims, ppsaOut)
// cDims : DWORD -> "u32"
// ppsaOut : SAFEARRAY** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SafeArrayAllocDescriptor(
uint32_t cDims,
void* ppsaOut);
C, "OLEAUT32.dll");
// $ffi->SafeArrayAllocDescriptor(cDims, ppsaOut);
// cDims : DWORD
// 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 SafeArrayAllocDescriptor(
int cDims, // DWORD
Pointer ppsaOut // SAFEARRAY** out
);
}@[Link("oleaut32")]
lib LibOLEAUT32
fun SafeArrayAllocDescriptor = SafeArrayAllocDescriptor(
cDims : UInt32, # DWORD
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 SafeArrayAllocDescriptorNative = Int32 Function(Uint32, Pointer<Void>);
typedef SafeArrayAllocDescriptorDart = int Function(int, Pointer<Void>);
final SafeArrayAllocDescriptor = DynamicLibrary.open('OLEAUT32.dll')
.lookupFunction<SafeArrayAllocDescriptorNative, SafeArrayAllocDescriptorDart>('SafeArrayAllocDescriptor');
// cDims : DWORD -> Uint32
// ppsaOut : SAFEARRAY** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SafeArrayAllocDescriptor(
cDims: DWORD; // DWORD
ppsaOut: Pointer // SAFEARRAY** out
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SafeArrayAllocDescriptor';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SafeArrayAllocDescriptor"
c_SafeArrayAllocDescriptor :: Word32 -> Ptr () -> IO Int32
-- cDims : DWORD -> Word32
-- ppsaOut : SAFEARRAY** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let safearrayallocdescriptor =
foreign "SafeArrayAllocDescriptor"
(uint32_t @-> (ptr void) @-> returning int32_t)
(* cDims : DWORD -> uint32_t *)
(* 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 ("SafeArrayAllocDescriptor" safe-array-alloc-descriptor :convention :stdcall) :int32
(c-dims :uint32) ; DWORD
(ppsa-out :pointer)) ; SAFEARRAY** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SafeArrayAllocDescriptor = Win32::API::More->new('OLEAUT32',
'int SafeArrayAllocDescriptor(DWORD cDims, LPVOID ppsaOut)');
# my $ret = $SafeArrayAllocDescriptor->Call($cDims, $ppsaOut);
# cDims : DWORD -> DWORD
# ppsaOut : SAFEARRAY** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
類似 API
- f SafeArrayAllocDescriptorEx — 要素型を指定してSAFEARRAYの記述子を割り当てる。
公式の関連項目
- f SafeArrayAllocData — 記述子に基づきSAFEARRAYのデータ領域を割り当てる。
- f SafeArrayDestroyData — SAFEARRAYのデータ領域を破棄する。
- f SafeArrayDestroyDescriptor — SAFEARRAYの記述子を破棄する。
使用する型