SafeArrayCreate

関数

指定型と次元数でSAFEARRAYを作成する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

SAFEARRAY* SafeArrayCreate(
    VARENUM vt,
    DWORD cDims,
    SAFEARRAYBOUND* rgsabound
);

パラメーター

名前	型	方向	説明
vt	VARENUM	in	配列の基本型(配列の各要素の VARTYPE)。VARTYPE はバリアント型の一部に制限されます。VT_ARRAY フラグも VT_BYREF フラグも設定できません。VT_EMPTY および VT_NULL は配列の基本型としては無効です。それ以外のすべての型は使用できます。
cDims	DWORD	in	配列の次元数。この数は配列の作成後に変更できません。
rgsabound	SAFEARRAYBOUND*	in	配列に割り当てる境界のベクター(各次元に 1 つ)。

戻り値の型: SAFEARRAY*

公式ドキュメント

新しい配列ディスクリプターを作成し、配列のデータを割り当てて初期化し、新しい配列ディスクリプターへのポインターを返します。

戻り値

安全な配列ディスクリプター。配列を作成できなかった場合は null。

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

各言語での呼び出し定義

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

SAFEARRAY* SafeArrayCreate(
    VARENUM vt,
    DWORD cDims,
    SAFEARRAYBOUND* rgsabound
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern IntPtr SafeArrayCreate(
    ushort vt,   // VARENUM
    uint cDims,   // DWORD
    IntPtr rgsabound   // SAFEARRAYBOUND*
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayCreate(
    vt As UShort,   ' VARENUM
    cDims As UInteger,   ' DWORD
    rgsabound As IntPtr   ' SAFEARRAYBOUND*
) As IntPtr
End Function

' vt : VARENUM
' cDims : DWORD
' rgsabound : SAFEARRAYBOUND*
Declare PtrSafe Function SafeArrayCreate Lib "oleaut32" ( _
    ByVal vt As Integer, _
    ByVal cDims As Long, _
    ByVal rgsabound As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SafeArrayCreate = ctypes.windll.oleaut32.SafeArrayCreate
SafeArrayCreate.restype = ctypes.c_void_p
SafeArrayCreate.argtypes = [
    ctypes.c_ushort,  # vt : VARENUM
    wintypes.DWORD,  # cDims : DWORD
    ctypes.c_void_p,  # rgsabound : SAFEARRAYBOUND*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayCreate = Fiddle::Function.new(
  lib['SafeArrayCreate'],
  [
    -Fiddle::TYPE_SHORT,  # vt : VARENUM
    -Fiddle::TYPE_INT,  # cDims : DWORD
    Fiddle::TYPE_VOIDP,  # rgsabound : SAFEARRAYBOUND*
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "oleaut32")]
extern "system" {
    fn SafeArrayCreate(
        vt: u16,  // VARENUM
        cDims: u32,  // DWORD
        rgsabound: *mut SAFEARRAYBOUND  // SAFEARRAYBOUND*
    ) -> *mut SAFEARRAY;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern IntPtr SafeArrayCreate(ushort vt, uint cDims, IntPtr rgsabound);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayCreate' -Namespace Win32 -PassThru
# $api::SafeArrayCreate(vt, cDims, rgsabound)

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

出力引数:

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