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

SafeArrayCreateVector

関数
1次元のセーフ配列(ベクター)を生成する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

SAFEARRAY* SafeArrayCreateVector(
    VARENUM vt,
    INT lLbound,
    DWORD cElements
);

パラメーター

名前方向説明
vtVARENUMin配列の基本型(配列の各要素の VARTYPE)。VARTYPE は variant 型の一部の型に限定されます。VT_ARRAY フラグと VT_BYREF フラグはどちらも設定できません。VT_EMPTY および VT_NULL は配列の基本型としては無効です。その他の型はすべて有効です。
lLboundINTin配列の下限。このパラメーターは負の値を指定できます。
cElementsDWORDin配列の要素数。

戻り値の型: SAFEARRAY*

公式ドキュメント

1 次元配列を作成します。SafeArrayCreateVector で作成した safe array はサイズが固定であるため、定数 FADF_FIXEDSIZE が常に設定されます。

戻り値

safe array 記述子。配列を作成できなかった場合は 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* SafeArrayCreateVector(
    VARENUM vt,
    INT lLbound,
    DWORD cElements
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern IntPtr SafeArrayCreateVector(
    ushort vt,   // VARENUM
    int lLbound,   // INT
    uint cElements   // DWORD
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayCreateVector(
    vt As UShort,   ' VARENUM
    lLbound As Integer,   ' INT
    cElements As UInteger   ' DWORD
) As IntPtr
End Function
' vt : VARENUM
' lLbound : INT
' cElements : DWORD
Declare PtrSafe Function SafeArrayCreateVector Lib "oleaut32" ( _
    ByVal vt As Integer, _
    ByVal lLbound As Long, _
    ByVal cElements As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SafeArrayCreateVector = ctypes.windll.oleaut32.SafeArrayCreateVector
SafeArrayCreateVector.restype = ctypes.c_void_p
SafeArrayCreateVector.argtypes = [
    ctypes.c_ushort,  # vt : VARENUM
    ctypes.c_int,  # lLbound : INT
    wintypes.DWORD,  # cElements : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayCreateVector = Fiddle::Function.new(
  lib['SafeArrayCreateVector'],
  [
    -Fiddle::TYPE_SHORT,  # vt : VARENUM
    Fiddle::TYPE_INT,  # lLbound : INT
    -Fiddle::TYPE_INT,  # cElements : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "oleaut32")]
extern "system" {
    fn SafeArrayCreateVector(
        vt: u16,  // VARENUM
        lLbound: i32,  // INT
        cElements: u32  // DWORD
    ) -> *mut SAFEARRAY;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern IntPtr SafeArrayCreateVector(ushort vt, int lLbound, uint cElements);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayCreateVector' -Namespace Win32 -PassThru
# $api::SafeArrayCreateVector(vt, lLbound, cElements)
#uselib "OLEAUT32.dll"
#func global SafeArrayCreateVector "SafeArrayCreateVector" sptr, sptr, sptr
; SafeArrayCreateVector vt, lLbound, cElements   ; 戻り値は stat
; vt : VARENUM -> "sptr"
; lLbound : INT -> "sptr"
; cElements : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLEAUT32.dll"
#cfunc global SafeArrayCreateVector "SafeArrayCreateVector" int, int, int
; res = SafeArrayCreateVector(vt, lLbound, cElements)
; vt : VARENUM -> "int"
; lLbound : INT -> "int"
; cElements : DWORD -> "int"
; SAFEARRAY* SafeArrayCreateVector(VARENUM vt, INT lLbound, DWORD cElements)
#uselib "OLEAUT32.dll"
#cfunc global SafeArrayCreateVector "SafeArrayCreateVector" int, int, int
; res = SafeArrayCreateVector(vt, lLbound, cElements)
; vt : VARENUM -> "int"
; lLbound : INT -> "int"
; cElements : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSafeArrayCreateVector = oleaut32.NewProc("SafeArrayCreateVector")
)

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

extern "oleaut32" fn SafeArrayCreateVector(
    vt: u16, // VARENUM
    lLbound: i32, // INT
    cElements: u32 // DWORD
) callconv(std.os.windows.WINAPI) [*c]SAFEARRAY;
proc SafeArrayCreateVector(
    vt: uint16,  # VARENUM
    lLbound: int32,  # INT
    cElements: uint32  # DWORD
): ptr SAFEARRAY {.importc: "SafeArrayCreateVector", stdcall, dynlib: "OLEAUT32.dll".}
pragma(lib, "oleaut32");
extern(Windows)
SAFEARRAY* SafeArrayCreateVector(
    ushort vt,   // VARENUM
    int lLbound,   // INT
    uint cElements   // DWORD
);
ccall((:SafeArrayCreateVector, "OLEAUT32.dll"), stdcall, Ptr{SAFEARRAY},
      (UInt16, Int32, UInt32),
      vt, lLbound, cElements)
# vt : VARENUM -> UInt16
# lLbound : INT -> Int32
# cElements : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* SafeArrayCreateVector(
    uint16_t vt,
    int32_t lLbound,
    uint32_t cElements);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SafeArrayCreateVector(vt, lLbound, cElements)
-- vt : VARENUM
-- lLbound : INT
-- cElements : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SafeArrayCreateVector = lib.func('__stdcall', 'SafeArrayCreateVector', 'void *', ['uint16_t', 'int32_t', 'uint32_t']);
// SafeArrayCreateVector(vt, lLbound, cElements)
// vt : VARENUM -> 'uint16_t'
// lLbound : INT -> 'int32_t'
// cElements : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLEAUT32.dll", {
  SafeArrayCreateVector: { parameters: ["u16", "i32", "u32"], result: "pointer" },
});
// lib.symbols.SafeArrayCreateVector(vt, lLbound, cElements)
// vt : VARENUM -> "u16"
// lLbound : INT -> "i32"
// cElements : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* SafeArrayCreateVector(
    uint16_t vt,
    int32_t lLbound,
    uint32_t cElements);
C, "OLEAUT32.dll");
// $ffi->SafeArrayCreateVector(vt, lLbound, cElements);
// vt : VARENUM
// lLbound : INT
// cElements : DWORD
// 構造体/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);
    Pointer SafeArrayCreateVector(
        short vt,   // VARENUM
        int lLbound,   // INT
        int cElements   // DWORD
    );
}
@[Link("oleaut32")]
lib LibOLEAUT32
  fun SafeArrayCreateVector = SafeArrayCreateVector(
    vt : UInt16,   # VARENUM
    lLbound : Int32,   # INT
    cElements : UInt32   # DWORD
  ) : SAFEARRAY*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SafeArrayCreateVectorNative = Pointer<Void> Function(Uint16, Int32, Uint32);
typedef SafeArrayCreateVectorDart = Pointer<Void> Function(int, int, int);
final SafeArrayCreateVector = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SafeArrayCreateVectorNative, SafeArrayCreateVectorDart>('SafeArrayCreateVector');
// vt : VARENUM -> Uint16
// lLbound : INT -> Int32
// cElements : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SafeArrayCreateVector(
  vt: Word;   // VARENUM
  lLbound: Integer;   // INT
  cElements: DWORD   // DWORD
): Pointer; stdcall;
  external 'OLEAUT32.dll' name 'SafeArrayCreateVector';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SafeArrayCreateVector"
  c_SafeArrayCreateVector :: Word16 -> Int32 -> Word32 -> IO (Ptr ())
-- vt : VARENUM -> Word16
-- lLbound : INT -> Int32
-- cElements : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let safearraycreatevector =
  foreign "SafeArrayCreateVector"
    (uint16_t @-> int32_t @-> uint32_t @-> returning (ptr void))
(* vt : VARENUM -> uint16_t *)
(* lLbound : INT -> int32_t *)
(* cElements : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("SafeArrayCreateVector" safe-array-create-vector :convention :stdcall) :pointer
  (vt :uint16)   ; VARENUM
  (l-lbound :int32)   ; INT
  (c-elements :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SafeArrayCreateVector = Win32::API::More->new('OLEAUT32',
    'LPVOID SafeArrayCreateVector(WORD vt, int lLbound, DWORD cElements)');
# my $ret = $SafeArrayCreateVector->Call($vt, $lLbound, $cElements);
# vt : VARENUM -> WORD
# lLbound : INT -> int
# cElements : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型