ホーム › System.Ole › SafeArrayAllocDescriptorEx

SafeArrayAllocDescriptorEx

関数

要素型を指定してSAFEARRAYの記述子を割り当てる。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT SafeArrayAllocDescriptorEx(
    VARENUM vt,
    DWORD cDims,
    SAFEARRAY** ppsaOut
);

パラメーター

名前	型	方向	説明
vt	VARENUM	in	バリアント型です。
cDims	DWORD	in	配列の次元数です。
ppsaOut	SAFEARRAY**	out	セーフ配列ディスクリプターです。

戻り値の型: HRESULT

公式ドキュメント

VT_RECORD を含む任意の有効なバリアント型の配列に対するセーフ配列ディスクリプターを、配列データを割り当てずに作成します。

戻り値

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

戻り値	説明
S_OK	成功しました。
E_INVALIDARG	引数 psa が無効でした。

解説(Remarks)

SafeArrayAllocDescriptor は VARTYPE を受け取らないため、これを使ってレコードの配列に対するセーフ配列ディスクリプターを作成することはできません。SafeArrayAllocDescriptorEx は、指定された次元数を持つレコードの配列に対するセーフ配列ディスクリプターを割り当てるために使用します。

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

各言語での呼び出し定義

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

HRESULT SafeArrayAllocDescriptorEx(
    VARENUM vt,
    DWORD cDims,
    SAFEARRAY** ppsaOut
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayAllocDescriptorEx(
    ushort vt,   // VARENUM
    uint cDims,   // DWORD
    IntPtr ppsaOut   // SAFEARRAY** out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayAllocDescriptorEx(
    vt As UShort,   ' VARENUM
    cDims As UInteger,   ' DWORD
    ppsaOut As IntPtr   ' SAFEARRAY** out
) As Integer
End Function

' vt : VARENUM
' cDims : DWORD
' ppsaOut : SAFEARRAY** out
Declare PtrSafe Function SafeArrayAllocDescriptorEx Lib "oleaut32" ( _
    ByVal vt As Integer, _
    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

SafeArrayAllocDescriptorEx = ctypes.windll.oleaut32.SafeArrayAllocDescriptorEx
SafeArrayAllocDescriptorEx.restype = ctypes.c_int
SafeArrayAllocDescriptorEx.argtypes = [
    ctypes.c_ushort,  # vt : VARENUM
    wintypes.DWORD,  # cDims : DWORD
    ctypes.c_void_p,  # ppsaOut : SAFEARRAY** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayAllocDescriptorEx = Fiddle::Function.new(
  lib['SafeArrayAllocDescriptorEx'],
  [
    -Fiddle::TYPE_SHORT,  # vt : VARENUM
    -Fiddle::TYPE_INT,  # cDims : DWORD
    Fiddle::TYPE_VOIDP,  # ppsaOut : SAFEARRAY** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn SafeArrayAllocDescriptorEx(
        vt: u16,  // VARENUM
        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 SafeArrayAllocDescriptorEx(ushort vt, uint cDims, IntPtr ppsaOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayAllocDescriptorEx' -Namespace Win32 -PassThru
# $api::SafeArrayAllocDescriptorEx(vt, cDims, ppsaOut)

#uselib "OLEAUT32.dll"
#func global SafeArrayAllocDescriptorEx "SafeArrayAllocDescriptorEx" sptr, sptr, sptr
; SafeArrayAllocDescriptorEx vt, cDims, varptr(ppsaOut)   ; 戻り値は stat
; vt : VARENUM -> "sptr"
; cDims : DWORD -> "sptr"
; ppsaOut : SAFEARRAY** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEAUT32.dll"
#cfunc global SafeArrayAllocDescriptorEx "SafeArrayAllocDescriptorEx" int, int, var
; res = SafeArrayAllocDescriptorEx(vt, cDims, ppsaOut)
; vt : VARENUM -> "int"
; cDims : DWORD -> "int"
; ppsaOut : SAFEARRAY** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll"
#cfunc global SafeArrayAllocDescriptorEx "SafeArrayAllocDescriptorEx" int, int, sptr
; res = SafeArrayAllocDescriptorEx(vt, cDims, varptr(ppsaOut))
; vt : VARENUM -> "int"
; cDims : DWORD -> "int"
; ppsaOut : SAFEARRAY** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。