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

VarUI1FromStr

関数
文字列をロケールに従ってBYTE(符号なし1バイト)に変換する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VarUI1FromStr(
    LPCWSTR strIn,
    DWORD lcid,
    DWORD dwFlags,
    BYTE* pbOut
);

パラメーター

名前方向説明
strInLPCWSTRin変換する値。
lcidDWORDinロケール識別子。
dwFlagsDWORDin

次のフラグの 1 つ以上。

意味
LOCALE_NOUSEROVERRIDE
カスタムのロケール設定ではなく、システム既定のロケール設定を使用します。
pbOutBYTE*out結果の値。

戻り値の型: HRESULT

公式ドキュメント

OLECHAR 文字列を unsigned char 文字列に変換します。

戻り値

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

戻り値 説明
S_OK
成功しました。
DISP_E_BADVARTYPE
入力パラメーターが有効な variant の型ではありません。
DISP_E_OVERFLOW
出力パラメーターが指す値が、変換先の型に収まりません。
DISP_E_TYPEMISMATCH
指定された型に引数を変換できませんでした。
E_INVALIDARG
引数の 1 つが有効ではありません。
E_OUTOFMEMORY
操作を完了するためのメモリが不足しています。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

VarUI1FromStr = ctypes.windll.oleaut32.VarUI1FromStr
VarUI1FromStr.restype = ctypes.c_int
VarUI1FromStr.argtypes = [
    wintypes.LPCWSTR,  # strIn : LPCWSTR
    wintypes.DWORD,  # lcid : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbOut : BYTE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procVarUI1FromStr = oleaut32.NewProc("VarUI1FromStr")
)

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

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

typedef VarUI1FromStrNative = Int32 Function(Pointer<Utf16>, Uint32, Uint32, Pointer<Uint8>);
typedef VarUI1FromStrDart = int Function(Pointer<Utf16>, int, int, Pointer<Uint8>);
final VarUI1FromStr = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<VarUI1FromStrNative, VarUI1FromStrDart>('VarUI1FromStr');
// strIn : LPCWSTR -> Pointer<Utf16>
// lcid : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// pbOut : BYTE* out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VarUI1FromStr(
  strIn: PWideChar;   // LPCWSTR
  lcid: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  pbOut: Pointer   // BYTE* out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'VarUI1FromStr';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VarUI1FromStr"
  c_VarUI1FromStr :: CWString -> Word32 -> Word32 -> Ptr Word8 -> IO Int32
-- strIn : LPCWSTR -> CWString
-- lcid : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- pbOut : BYTE* out -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let varui1fromstr =
  foreign "VarUI1FromStr"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr uint8_t) @-> returning int32_t)
(* strIn : LPCWSTR -> (ptr uint16_t) *)
(* lcid : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* pbOut : BYTE* out -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("VarUI1FromStr" var-ui1-from-str :convention :stdcall) :int32
  (str-in (:string :encoding :utf-16le))   ; LPCWSTR
  (lcid :uint32)   ; DWORD
  (dw-flags :uint32)   ; DWORD
  (pb-out :pointer))   ; BYTE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $VarUI1FromStr = Win32::API::More->new('OLEAUT32',
    'int VarUI1FromStr(LPCWSTR strIn, DWORD lcid, DWORD dwFlags, LPVOID pbOut)');
# my $ret = $VarUI1FromStr->Call($strIn, $lcid, $dwFlags, $pbOut);
# strIn : LPCWSTR -> LPCWSTR
# lcid : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# pbOut : BYTE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。