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

VectorFromBstr

関数
BSTR文字列の各文字をUI1型の1次元セーフ配列に変換する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VectorFromBstr(
    LPWSTR bstr,
    SAFEARRAY** ppsa
);

パラメーター

名前方向説明
bstrLPWSTRinベクターに変換する BSTR。
ppsaSAFEARRAY**outBSTR 内の文字を格納した 1 次元の safearray。

戻り値の型: HRESULT

公式ドキュメント

BSTR 内の各文字をベクターの各要素に割り当て、ベクターを返します。

戻り値

この関数は次のいずれかの値を返します。

戻り値 説明
S_OK
成功しました。
E_OUTOFMEMORY
メモリが不足しています。
E_INVALIDARG
bstr パラメーターが null です。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT VectorFromBstr(
    LPWSTR bstr,
    SAFEARRAY** ppsa
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VectorFromBstr(
    [MarshalAs(UnmanagedType.LPWStr)] string bstr,   // LPWSTR
    IntPtr ppsa   // SAFEARRAY** out
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VectorFromBstr(
    <MarshalAs(UnmanagedType.LPWStr)> bstr As String,   ' LPWSTR
    ppsa As IntPtr   ' SAFEARRAY** out
) As Integer
End Function
' bstr : LPWSTR
' ppsa : SAFEARRAY** out
Declare PtrSafe Function VectorFromBstr Lib "oleaut32" ( _
    ByVal bstr As LongPtr, _
    ByVal ppsa As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

VectorFromBstr = ctypes.windll.oleaut32.VectorFromBstr
VectorFromBstr.restype = ctypes.c_int
VectorFromBstr.argtypes = [
    wintypes.LPCWSTR,  # bstr : LPWSTR
    ctypes.c_void_p,  # ppsa : SAFEARRAY** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procVectorFromBstr = oleaut32.NewProc("VectorFromBstr")
)

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

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

typedef VectorFromBstrNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef VectorFromBstrDart = int Function(Pointer<Utf16>, Pointer<Void>);
final VectorFromBstr = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<VectorFromBstrNative, VectorFromBstrDart>('VectorFromBstr');
// bstr : LPWSTR -> Pointer<Utf16>
// ppsa : SAFEARRAY** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VectorFromBstr(
  bstr: PWideChar;   // LPWSTR
  ppsa: Pointer   // SAFEARRAY** out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'VectorFromBstr';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VectorFromBstr"
  c_VectorFromBstr :: CWString -> Ptr () -> IO Int32
-- bstr : LPWSTR -> CWString
-- ppsa : SAFEARRAY** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("VectorFromBstr" vector-from-bstr :convention :stdcall) :int32
  (bstr (:string :encoding :utf-16le))   ; LPWSTR
  (ppsa :pointer))   ; SAFEARRAY** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $VectorFromBstr = Win32::API::More->new('OLEAUT32',
    'int VectorFromBstr(LPCWSTR bstr, LPVOID ppsa)');
# my $ret = $VectorFromBstr->Call($bstr, $ppsa);
# bstr : LPWSTR -> LPCWSTR
# ppsa : SAFEARRAY** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型