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

VariantToStringArrayAlloc

関数
VARIANTをワイド文字列配列へ変換し領域を確保して返す。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT VariantToStringArrayAlloc(
    const VARIANT* var,
    LPWSTR** pprgsz,
    DWORD* pcElem
);

パラメーター

名前方向説明
varVARIANT*in変換元のVARIANT構造体へのポインタ。文字列配列を想定する。
pprgszLPWSTR**out確保された文字列ポインタ配列へのポインタを受け取る出力。各要素ともCoTaskMemFreeで解放する。
pcElemDWORD*out確保された配列の要素数を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT VariantToStringArrayAlloc(
    const VARIANT* var,
    LPWSTR** pprgsz,
    DWORD* pcElem
);
[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int VariantToStringArrayAlloc(
    IntPtr var,   // VARIANT*
    IntPtr pprgsz,   // LPWSTR** out
    out uint pcElem   // DWORD* out
);
<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function VariantToStringArrayAlloc(
    var As IntPtr,   ' VARIANT*
    pprgsz As IntPtr,   ' LPWSTR** out
    <Out> ByRef pcElem As UInteger   ' DWORD* out
) As Integer
End Function
' var : VARIANT*
' pprgsz : LPWSTR** out
' pcElem : DWORD* out
Declare PtrSafe Function VariantToStringArrayAlloc Lib "propsys" ( _
    ByVal var As LongPtr, _
    ByVal pprgsz As LongPtr, _
    ByRef pcElem As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

VariantToStringArrayAlloc = ctypes.windll.propsys.VariantToStringArrayAlloc
VariantToStringArrayAlloc.restype = ctypes.c_int
VariantToStringArrayAlloc.argtypes = [
    ctypes.c_void_p,  # var : VARIANT*
    ctypes.c_void_p,  # pprgsz : LPWSTR** out
    ctypes.POINTER(wintypes.DWORD),  # pcElem : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procVariantToStringArrayAlloc = propsys.NewProc("VariantToStringArrayAlloc")
)

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

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

typedef VariantToStringArrayAllocNative = Int32 Function(Pointer<Void>, Pointer<Pointer<Utf16>>, Pointer<Uint32>);
typedef VariantToStringArrayAllocDart = int Function(Pointer<Void>, Pointer<Pointer<Utf16>>, Pointer<Uint32>);
final VariantToStringArrayAlloc = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<VariantToStringArrayAllocNative, VariantToStringArrayAllocDart>('VariantToStringArrayAlloc');
// var : VARIANT* -> Pointer<Void>
// pprgsz : LPWSTR** out -> Pointer<Pointer<Utf16>>
// pcElem : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VariantToStringArrayAlloc(
  var: Pointer;   // VARIANT*
  pprgsz: PPWideChar;   // LPWSTR** out
  pcElem: Pointer   // DWORD* out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'VariantToStringArrayAlloc';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VariantToStringArrayAlloc"
  c_VariantToStringArrayAlloc :: Ptr () -> Ptr CWString -> Ptr Word32 -> IO Int32
-- var : VARIANT* -> Ptr ()
-- pprgsz : LPWSTR** out -> Ptr CWString
-- pcElem : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let varianttostringarrayalloc =
  foreign "VariantToStringArrayAlloc"
    ((ptr void) @-> (ptr (ptr uint16_t)) @-> (ptr uint32_t) @-> returning int32_t)
(* var : VARIANT* -> (ptr void) *)
(* pprgsz : LPWSTR** out -> (ptr (ptr uint16_t)) *)
(* pcElem : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

(cffi:defcfun ("VariantToStringArrayAlloc" variant-to-string-array-alloc :convention :stdcall) :int32
  (var :pointer)   ; VARIANT*
  (pprgsz :pointer)   ; LPWSTR** out
  (pc-elem :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $VariantToStringArrayAlloc = Win32::API::More->new('PROPSYS',
    'int VariantToStringArrayAlloc(LPVOID var, LPVOID pprgsz, LPVOID pcElem)');
# my $ret = $VariantToStringArrayAlloc->Call($var, $pprgsz, $pcElem);
# var : VARIANT* -> LPVOID
# pprgsz : LPWSTR** out -> LPVOID
# pcElem : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型