ホーム › Foundation › SysAllocStringByteLen
SysAllocStringByteLen
関数指定バイト長のBSTR文字列を割り当ててコピーする。
シグネチャ
// OLEAUT32.dll
#include <windows.h>
LPWSTR SysAllocStringByteLen(
LPCSTR psz, // optional
DWORD len
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| psz | LPCSTR | inoptional | コピーする文字列。文字列を未初期化のままにする場合は NULL を指定します。 |
| len | DWORD | in | コピーするバイト数。その後に null 文字が配置され、合計で len に OLECHAR のサイズを加えたバイト数が割り当てられます。 |
戻り値の型: LPWSTR
公式ドキュメント
ANSI 文字列を入力として受け取り、ANSI 文字列を格納した BSTR を返します。ANSI から Unicode への変換は一切行いません。
戻り値
文字列のコピー。操作を完了するのに十分なメモリがない場合は NULL を返します。
解説(Remarks)
この関数は、バイナリ データを格納する BSTR を作成するために提供されています。この種の BSTR は、ANSI から Unicode へ(またはその逆へ)変換されない状況でのみ使用できます。
たとえば、32 ビット Windows システム上で実行される 16 ビット アプリケーションと 32 ビット アプリケーションの間でこれらの BSTR を使用しないでください。OLE の 16 ビットと 32 ビット間(および 32 ビットと 16 ビット間)の相互運用レイヤーが BSTR を変換し、バイナリ データを破損させてしまいます。バイナリ データを渡す推奨される方法は、OLE によって変換されない VT_UI1 の SAFEARRAY を使用することです。
psz が Null の場合、要求された長さの文字列が割り当てられますが、初期化はされません。文字列 psz には埋め込みの null 文字を含めることができ、Null で終わる必要はありません。返された文字列は、後で SysFreeString で解放してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// OLEAUT32.dll
#include <windows.h>
LPWSTR SysAllocStringByteLen(
LPCSTR psz, // optional
DWORD len
);[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern IntPtr SysAllocStringByteLen(
[MarshalAs(UnmanagedType.LPStr)] string psz, // LPCSTR optional
uint len // DWORD
);<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SysAllocStringByteLen(
<MarshalAs(UnmanagedType.LPStr)> psz As String, ' LPCSTR optional
len As UInteger ' DWORD
) As IntPtr
End Function' psz : LPCSTR optional
' len : DWORD
Declare PtrSafe Function SysAllocStringByteLen Lib "oleaut32" ( _
ByVal psz As String, _
ByVal len As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SysAllocStringByteLen = ctypes.windll.oleaut32.SysAllocStringByteLen
SysAllocStringByteLen.restype = wintypes.LPWSTR
SysAllocStringByteLen.argtypes = [
wintypes.LPCSTR, # psz : LPCSTR optional
wintypes.DWORD, # len : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLEAUT32.dll')
SysAllocStringByteLen = Fiddle::Function.new(
lib['SysAllocStringByteLen'],
[
Fiddle::TYPE_VOIDP, # psz : LPCSTR optional
-Fiddle::TYPE_INT, # len : DWORD
],
Fiddle::TYPE_VOIDP)#[link(name = "oleaut32")]
extern "system" {
fn SysAllocStringByteLen(
psz: *const u8, // LPCSTR optional
len: u32 // DWORD
) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern IntPtr SysAllocStringByteLen([MarshalAs(UnmanagedType.LPStr)] string psz, uint len);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SysAllocStringByteLen' -Namespace Win32 -PassThru
# $api::SysAllocStringByteLen(psz, len)#uselib "OLEAUT32.dll"
#func global SysAllocStringByteLen "SysAllocStringByteLen" sptr, sptr
; SysAllocStringByteLen psz, len ; 戻り値は stat
; psz : LPCSTR optional -> "sptr"
; len : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "OLEAUT32.dll"
#cfunc global SysAllocStringByteLen "SysAllocStringByteLen" str, int
; res = SysAllocStringByteLen(psz, len)
; psz : LPCSTR optional -> "str"
; len : DWORD -> "int"; LPWSTR SysAllocStringByteLen(LPCSTR psz, DWORD len)
#uselib "OLEAUT32.dll"
#cfunc global SysAllocStringByteLen "SysAllocStringByteLen" str, int
; res = SysAllocStringByteLen(psz, len)
; psz : LPCSTR optional -> "str"
; len : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
procSysAllocStringByteLen = oleaut32.NewProc("SysAllocStringByteLen")
)
// psz (LPCSTR optional), len (DWORD)
r1, _, err := procSysAllocStringByteLen.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(psz))),
uintptr(len),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // LPWSTRfunction SysAllocStringByteLen(
psz: PAnsiChar; // LPCSTR optional
len: DWORD // DWORD
): PWideChar; stdcall;
external 'OLEAUT32.dll' name 'SysAllocStringByteLen';result := DllCall("OLEAUT32\SysAllocStringByteLen"
, "AStr", psz ; LPCSTR optional
, "UInt", len ; DWORD
, "Ptr") ; return: LPWSTR●SysAllocStringByteLen(psz, len) = DLL("OLEAUT32.dll", "char* SysAllocStringByteLen(char*, dword)")
# 呼び出し: SysAllocStringByteLen(psz, len)
# psz : LPCSTR optional -> "char*"
# len : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "oleaut32" fn SysAllocStringByteLen(
psz: [*c]const u8, // LPCSTR optional
len: u32 // DWORD
) callconv(std.os.windows.WINAPI) [*c]const u16;proc SysAllocStringByteLen(
psz: cstring, # LPCSTR optional
len: uint32 # DWORD
): WideCString {.importc: "SysAllocStringByteLen", stdcall, dynlib: "OLEAUT32.dll".}pragma(lib, "oleaut32");
extern(Windows)
const(wchar)* SysAllocStringByteLen(
const(char)* psz, // LPCSTR optional
uint len // DWORD
);ccall((:SysAllocStringByteLen, "OLEAUT32.dll"), stdcall, Cwstring,
(Cstring, UInt32),
psz, len)
# psz : LPCSTR optional -> Cstring
# len : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
const uint16_t* SysAllocStringByteLen(
const char* psz,
uint32_t len);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SysAllocStringByteLen(psz, len)
-- psz : LPCSTR optional
-- len : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SysAllocStringByteLen = lib.func('__stdcall', 'SysAllocStringByteLen', 'void *', ['str', 'uint32_t']);
// SysAllocStringByteLen(psz, len)
// psz : LPCSTR optional -> 'str'
// len : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLEAUT32.dll", {
SysAllocStringByteLen: { parameters: ["buffer", "u32"], result: "pointer" },
});
// lib.symbols.SysAllocStringByteLen(psz, len)
// psz : LPCSTR optional -> "buffer"
// len : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
const uint16_t* SysAllocStringByteLen(
const char* psz,
uint32_t len);
C, "OLEAUT32.dll");
// $ffi->SysAllocStringByteLen(psz, len);
// psz : LPCSTR optional
// len : DWORD
// 構造体/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);
Pointer SysAllocStringByteLen(
String psz, // LPCSTR optional
int len // DWORD
);
}@[Link("oleaut32")]
lib LibOLEAUT32
fun SysAllocStringByteLen = SysAllocStringByteLen(
psz : UInt8*, # LPCSTR optional
len : UInt32 # DWORD
) : UInt16*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SysAllocStringByteLenNative = Pointer<Utf16> Function(Pointer<Utf8>, Uint32);
typedef SysAllocStringByteLenDart = Pointer<Utf16> Function(Pointer<Utf8>, int);
final SysAllocStringByteLen = DynamicLibrary.open('OLEAUT32.dll')
.lookupFunction<SysAllocStringByteLenNative, SysAllocStringByteLenDart>('SysAllocStringByteLen');
// psz : LPCSTR optional -> Pointer<Utf8>
// len : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SysAllocStringByteLen(
psz: PAnsiChar; // LPCSTR optional
len: DWORD // DWORD
): PWideChar; stdcall;
external 'OLEAUT32.dll' name 'SysAllocStringByteLen';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SysAllocStringByteLen"
c_SysAllocStringByteLen :: CString -> Word32 -> IO CWString
-- psz : LPCSTR optional -> CString
-- len : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let sysallocstringbytelen =
foreign "SysAllocStringByteLen"
(string @-> uint32_t @-> returning (ptr uint16_t))
(* psz : LPCSTR optional -> string *)
(* len : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)
(cffi:defcfun ("SysAllocStringByteLen" sys-alloc-string-byte-len :convention :stdcall) (:string :encoding :utf-16le)
(psz :string) ; LPCSTR optional
(len :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SysAllocStringByteLen = Win32::API::More->new('OLEAUT32',
'LPWSTR SysAllocStringByteLen(LPCSTR psz, DWORD len)');
# my $ret = $SysAllocStringByteLen->Call($psz, $len);
# psz : LPCSTR optional -> LPCSTR
# len : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。