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

SafeArrayGetVartype

関数
セーフ配列に格納された要素のVARTYPE型を取得する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT SafeArrayGetVartype(
    SAFEARRAY* psa,
    VARENUM* pvt
);

パラメーター

名前方向説明
psaSAFEARRAY*inSafeArrayCreate によって作成された配列記述子です。
pvtVARENUM*outVARTYPE です。

戻り値の型: HRESULT

公式ドキュメント

指定したセーフ配列に格納されている VARTYPE を取得します。

戻り値

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

戻り値 説明
S_OK
成功しました。
E_INVALIDARG
引数のいずれかが無効です。

解説(Remarks)

FADF_HAVEVARTYPE が設定されている場合、SafeArrayGetVartype は配列記述子に格納されている VARTYPE を返します。FADF_RECORD が設定されている場合は VT_RECORD を返し、FADF_DISPATCH が設定されている場合は VT_DISPATCH を返し、FADF_UNKNOWN が設定されている場合は VT_UNKNOWN を返します。

SafeArrayGetVartype は、IUnknown に基づく SAFEARRAY 型に対して VT_UNKNOWN を返すことに失敗する場合があります。呼び出し元は、SAFEARRAY 型の fFeatures フィールドに FADF_UNKNOWN フラグが設定されているかどうかも併せて確認する必要があります。

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

各言語での呼び出し定義

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

HRESULT SafeArrayGetVartype(
    SAFEARRAY* psa,
    VARENUM* pvt
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayGetVartype(
    IntPtr psa,   // SAFEARRAY*
    out ushort pvt   // VARENUM* out
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayGetVartype(
    psa As IntPtr,   ' SAFEARRAY*
    <Out> ByRef pvt As UShort   ' VARENUM* out
) As Integer
End Function
' psa : SAFEARRAY*
' pvt : VARENUM* out
Declare PtrSafe Function SafeArrayGetVartype Lib "oleaut32" ( _
    ByVal psa As LongPtr, _
    ByRef pvt As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SafeArrayGetVartype = ctypes.windll.oleaut32.SafeArrayGetVartype
SafeArrayGetVartype.restype = ctypes.c_int
SafeArrayGetVartype.argtypes = [
    ctypes.c_void_p,  # psa : SAFEARRAY*
    ctypes.c_void_p,  # pvt : VARENUM* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayGetVartype = Fiddle::Function.new(
  lib['SafeArrayGetVartype'],
  [
    Fiddle::TYPE_VOIDP,  # psa : SAFEARRAY*
    Fiddle::TYPE_VOIDP,  # pvt : VARENUM* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "oleaut32")]
extern "system" {
    fn SafeArrayGetVartype(
        psa: *mut SAFEARRAY,  // SAFEARRAY*
        pvt: *mut u16  // VARENUM* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int SafeArrayGetVartype(IntPtr psa, out ushort pvt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayGetVartype' -Namespace Win32 -PassThru
# $api::SafeArrayGetVartype(psa, pvt)
#uselib "OLEAUT32.dll"
#func global SafeArrayGetVartype "SafeArrayGetVartype" sptr, sptr
; SafeArrayGetVartype varptr(psa), varptr(pvt)   ; 戻り値は stat
; psa : SAFEARRAY* -> "sptr"
; pvt : VARENUM* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLEAUT32.dll"
#cfunc global SafeArrayGetVartype "SafeArrayGetVartype" var, var
; res = SafeArrayGetVartype(psa, pvt)
; psa : SAFEARRAY* -> "var"
; pvt : VARENUM* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SafeArrayGetVartype(SAFEARRAY* psa, VARENUM* pvt)
#uselib "OLEAUT32.dll"
#cfunc global SafeArrayGetVartype "SafeArrayGetVartype" var, var
; res = SafeArrayGetVartype(psa, pvt)
; psa : SAFEARRAY* -> "var"
; pvt : VARENUM* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSafeArrayGetVartype = oleaut32.NewProc("SafeArrayGetVartype")
)

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

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

typedef SafeArrayGetVartypeNative = Int32 Function(Pointer<Void>, Pointer<Uint16>);
typedef SafeArrayGetVartypeDart = int Function(Pointer<Void>, Pointer<Uint16>);
final SafeArrayGetVartype = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SafeArrayGetVartypeNative, SafeArrayGetVartypeDart>('SafeArrayGetVartype');
// psa : SAFEARRAY* -> Pointer<Void>
// pvt : VARENUM* out -> Pointer<Uint16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SafeArrayGetVartype(
  psa: Pointer;   // SAFEARRAY*
  pvt: Pointer   // VARENUM* out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'SafeArrayGetVartype';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SafeArrayGetVartype"
  c_SafeArrayGetVartype :: Ptr () -> Ptr Word16 -> IO Int32
-- psa : SAFEARRAY* -> Ptr ()
-- pvt : VARENUM* out -> Ptr Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let safearraygetvartype =
  foreign "SafeArrayGetVartype"
    ((ptr void) @-> (ptr uint16_t) @-> returning int32_t)
(* psa : SAFEARRAY* -> (ptr void) *)
(* pvt : VARENUM* out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("SafeArrayGetVartype" safe-array-get-vartype :convention :stdcall) :int32
  (psa :pointer)   ; SAFEARRAY*
  (pvt :pointer))   ; VARENUM* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SafeArrayGetVartype = Win32::API::More->new('OLEAUT32',
    'int SafeArrayGetVartype(LPVOID psa, LPVOID pvt)');
# my $ret = $SafeArrayGetVartype->Call($psa, $pvt);
# psa : SAFEARRAY* -> LPVOID
# pvt : VARENUM* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型