Win32 API 日本語リファレンス
ホームUI.Shell › VariantToStrRet

VariantToStrRet

関数
VARIANTをSTRRET構造体に変換する。
DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT VariantToStrRet(
    const VARIANT* varIn,
    STRRET* pstrret
);

パラメーター

名前方向説明
varInVARIANT*inソースのバリアント構造体への参照。
pstrretSTRRET*out文字列が存在する場合、抽出された文字列へのポインター。

戻り値の型: HRESULT

公式ドキュメント

ソースのバリアントが VT_BSTR である場合、文字列を抽出して STRRET 構造体に格納します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

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

各言語での呼び出し定義

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

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

VariantToStrRet = ctypes.windll.propsys.VariantToStrRet
VariantToStrRet.restype = ctypes.c_int
VariantToStrRet.argtypes = [
    ctypes.c_void_p,  # varIn : VARIANT*
    ctypes.c_void_p,  # pstrret : STRRET* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procVariantToStrRet = propsys.NewProc("VariantToStrRet")
)

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

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

typedef VariantToStrRetNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef VariantToStrRetDart = int Function(Pointer<Void>, Pointer<Void>);
final VariantToStrRet = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<VariantToStrRetNative, VariantToStrRetDart>('VariantToStrRet');
// varIn : VARIANT* -> Pointer<Void>
// pstrret : STRRET* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VariantToStrRet(
  varIn: Pointer;   // VARIANT*
  pstrret: Pointer   // STRRET* out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'VariantToStrRet';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VariantToStrRet"
  c_VariantToStrRet :: Ptr () -> Ptr () -> IO Int32
-- varIn : VARIANT* -> Ptr ()
-- pstrret : STRRET* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let varianttostrret =
  foreign "VariantToStrRet"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* varIn : VARIANT* -> (ptr void) *)
(* pstrret : STRRET* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

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

関連項目

使用する型