Win32 API 日本語リファレンス
ホームFoundation › SysReAllocStringLen

SysReAllocStringLen

関数
既存のBSTRを指定長の新文字列で再割り当てする。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

INT SysReAllocStringLen(
    LPWSTR* pbstr,
    LPCWSTR psz,   // optional
    DWORD len
);

パラメーター

名前方向説明
pbstrLPWSTR*inout以前に割り当てられた文字列。
pszLPCWSTRinoptionallen 文字分をコピーする元の文字列。文字列を未初期化のままにする場合は NULL を指定します。
lenDWORDinコピーする文字数。この後に null 文字が配置され、合計で len + 1 文字が割り当てられます。

戻り値の型: INT

公式ドキュメント

既存の BSTR から指定された数の文字を取り出して新しい BSTR を作成し、古い BSTR を解放します。

戻り値

戻り値 説明
TRUE
文字列の再割り当てに成功しました。
FALSE
メモリが不足しています。

解説(Remarks)

新しい文字列を割り当て、渡された文字列から len 文字をコピーした後、null 文字を追加します。現在 pbstr が参照している BSTR を解放し、pbstr が新しい BSTR を指すようにリセットします。psz が null の場合、長さ len の文字列が割り当てられますが、初期化はされません。

psz 文字列には埋め込みの null 文字を含めることができ、null で終わる必要はありません。

この関数に NULL ポインターが渡された場合、アクセス違反が発生してプログラムがクラッシュします。NULL ポインターからこの関数を保護するのは呼び出し側の責任です。

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

各言語での呼び出し定義

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

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

SysReAllocStringLen = ctypes.windll.oleaut32.SysReAllocStringLen
SysReAllocStringLen.restype = ctypes.c_int
SysReAllocStringLen.argtypes = [
    ctypes.c_void_p,  # pbstr : LPWSTR* in/out
    wintypes.LPCWSTR,  # psz : LPCWSTR optional
    wintypes.DWORD,  # len : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSysReAllocStringLen = oleaut32.NewProc("SysReAllocStringLen")
)

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

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

typedef SysReAllocStringLenNative = Int32 Function(Pointer<Pointer<Utf16>>, Pointer<Utf16>, Uint32);
typedef SysReAllocStringLenDart = int Function(Pointer<Pointer<Utf16>>, Pointer<Utf16>, int);
final SysReAllocStringLen = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SysReAllocStringLenNative, SysReAllocStringLenDart>('SysReAllocStringLen');
// pbstr : LPWSTR* in/out -> Pointer<Pointer<Utf16>>
// psz : LPCWSTR optional -> Pointer<Utf16>
// len : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SysReAllocStringLen(
  pbstr: PPWideChar;   // LPWSTR* in/out
  psz: PWideChar;   // LPCWSTR optional
  len: DWORD   // DWORD
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'SysReAllocStringLen';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SysReAllocStringLen"
  c_SysReAllocStringLen :: Ptr CWString -> CWString -> Word32 -> IO Int32
-- pbstr : LPWSTR* in/out -> Ptr CWString
-- psz : LPCWSTR optional -> CWString
-- len : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sysreallocstringlen =
  foreign "SysReAllocStringLen"
    ((ptr (ptr uint16_t)) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pbstr : LPWSTR* in/out -> (ptr (ptr uint16_t)) *)
(* psz : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("SysReAllocStringLen" sys-re-alloc-string-len :convention :stdcall) :int32
  (pbstr :pointer)   ; LPWSTR* in/out
  (psz (:string :encoding :utf-16le))   ; LPCWSTR optional
  (len :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SysReAllocStringLen = Win32::API::More->new('OLEAUT32',
    'int SysReAllocStringLen(LPVOID pbstr, LPCWSTR psz, DWORD len)');
# my $ret = $SysReAllocStringLen->Call($pbstr, $psz, $len);
# pbstr : LPWSTR* in/out -> LPVOID
# psz : LPCWSTR optional -> LPCWSTR
# len : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。