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

CoTaskMemRealloc

関数
COMタスクメモリブロックのサイズを変更する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

void* CoTaskMemRealloc(
    void* pv,   // optional
    UINT_PTR cb
);

パラメーター

名前方向説明
pvvoid*inoptional再割り当てするメモリブロックへのポインター。このパラメーターは、「Remarks」で説明するように NULL にすることができます。
cbUINT_PTRin再割り当てするメモリブロックのサイズ(バイト単位)。このパラメーターは、「Remarks」で説明するように 0 にすることができます。

戻り値の型: void*

公式ドキュメント

以前に割り当てられたタスクメモリのブロックのサイズを変更します。

戻り値

関数が成功した場合は、再割り当てされたメモリブロックを返します。それ以外の場合は NULL を返します。

解説(Remarks)

この関数は、IMalloc::Realloc と同じ方法で、以前に割り当てられたメモリブロックのサイズを変更します。CoTaskMemRealloc を呼び出す前に、CoGetMalloc 関数を呼び出して OLE アロケーターへのポインターを取得する必要はありません。

pv パラメーターはメモリブロックの先頭を指します。pvNULL の場合、CoTaskMemReallocCoTaskMemAlloc 関数と同じ方法で新しいメモリブロックを割り当てます。pvNULL でない場合は、それより前の CoTaskMemAlloc の呼び出しによって返されたポインターである必要があります。

cb パラメーターは新しいブロックのサイズを指定します。ブロックの内容は、新旧いずれか小さい方のサイズまでは変更されませんが、新しいブロックは異なる場所に配置される場合があります。新しいブロックは異なるメモリ位置に配置される可能性があるため、CoTaskMemRealloc が返すポインターが pv 引数で渡したポインターと一致するとは限りません。pvNULL でなく、かつ cb が 0 の場合、pv が指すメモリは解放されます。

CoTaskMemRealloc は、再割り当てされた(場合によっては移動された)メモリブロックへの void ポインターを返します。サイズが 0 でバッファー引数が NULL でない場合、または指定したサイズにブロックを拡張するのに十分なメモリがない場合、戻り値は NULL になります。前者の場合、元のブロックは解放されます。後者の場合、元のブロックは変更されません。

戻り値が指すストレージ領域は、あらゆる型のオブジェクトの格納に適した形でアラインメントされていることが保証されます。void 以外の型へのポインターを取得するには、戻り値に型キャストを使用してください。

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

各言語での呼び出し定義

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

void* CoTaskMemRealloc(
    void* pv,   // optional
    UINT_PTR cb
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern IntPtr CoTaskMemRealloc(
    IntPtr pv,   // void* optional
    UIntPtr cb   // UINT_PTR
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoTaskMemRealloc(
    pv As IntPtr,   ' void* optional
    cb As UIntPtr   ' UINT_PTR
) As IntPtr
End Function
' pv : void* optional
' cb : UINT_PTR
Declare PtrSafe Function CoTaskMemRealloc Lib "ole32" ( _
    ByVal pv As LongPtr, _
    ByVal cb As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoTaskMemRealloc = ctypes.windll.ole32.CoTaskMemRealloc
CoTaskMemRealloc.restype = ctypes.c_void_p
CoTaskMemRealloc.argtypes = [
    ctypes.POINTER(None),  # pv : void* optional
    ctypes.c_size_t,  # cb : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoTaskMemRealloc = Fiddle::Function.new(
  lib['CoTaskMemRealloc'],
  [
    Fiddle::TYPE_VOIDP,  # pv : void* optional
    Fiddle::TYPE_UINTPTR_T,  # cb : UINT_PTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "ole32")]
extern "system" {
    fn CoTaskMemRealloc(
        pv: *mut (),  // void* optional
        cb: usize  // UINT_PTR
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern IntPtr CoTaskMemRealloc(IntPtr pv, UIntPtr cb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoTaskMemRealloc' -Namespace Win32 -PassThru
# $api::CoTaskMemRealloc(pv, cb)
#uselib "OLE32.dll"
#func global CoTaskMemRealloc "CoTaskMemRealloc" sptr, sptr
; CoTaskMemRealloc pv, cb   ; 戻り値は stat
; pv : void* optional -> "sptr"
; cb : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLE32.dll"
#cfunc global CoTaskMemRealloc "CoTaskMemRealloc" sptr, sptr
; res = CoTaskMemRealloc(pv, cb)
; pv : void* optional -> "sptr"
; cb : UINT_PTR -> "sptr"
; void* CoTaskMemRealloc(void* pv, UINT_PTR cb)
#uselib "OLE32.dll"
#cfunc global CoTaskMemRealloc "CoTaskMemRealloc" intptr, intptr
; res = CoTaskMemRealloc(pv, cb)
; pv : void* optional -> "intptr"
; cb : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoTaskMemRealloc = ole32.NewProc("CoTaskMemRealloc")
)

// pv (void* optional), cb (UINT_PTR)
r1, _, err := procCoTaskMemRealloc.Call(
	uintptr(pv),
	uintptr(cb),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void*
function CoTaskMemRealloc(
  pv: Pointer;   // void* optional
  cb: NativeUInt   // UINT_PTR
): Pointer; stdcall;
  external 'OLE32.dll' name 'CoTaskMemRealloc';
result := DllCall("OLE32\CoTaskMemRealloc"
    , "Ptr", pv   ; void* optional
    , "UPtr", cb   ; UINT_PTR
    , "Ptr")   ; return: void*
●CoTaskMemRealloc(pv, cb) = DLL("OLE32.dll", "void* CoTaskMemRealloc(void*, int)")
# 呼び出し: CoTaskMemRealloc(pv, cb)
# pv : void* optional -> "void*"
# cb : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CoTaskMemReallocNative = Pointer<Void> Function(Pointer<Void>, UintPtr);
typedef CoTaskMemReallocDart = Pointer<Void> Function(Pointer<Void>, int);
final CoTaskMemRealloc = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoTaskMemReallocNative, CoTaskMemReallocDart>('CoTaskMemRealloc');
// pv : void* optional -> Pointer<Void>
// cb : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoTaskMemRealloc(
  pv: Pointer;   // void* optional
  cb: NativeUInt   // UINT_PTR
): Pointer; stdcall;
  external 'OLE32.dll' name 'CoTaskMemRealloc';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoTaskMemRealloc"
  c_CoTaskMemRealloc :: Ptr () -> CUIntPtr -> IO (Ptr ())
-- pv : void* optional -> Ptr ()
-- cb : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cotaskmemrealloc =
  foreign "CoTaskMemRealloc"
    ((ptr void) @-> size_t @-> returning (ptr void))
(* pv : void* optional -> (ptr void) *)
(* cb : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoTaskMemRealloc" co-task-mem-realloc :convention :stdcall) :pointer
  (pv :pointer)   ; void* optional
  (cb :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoTaskMemRealloc = Win32::API::More->new('OLE32',
    'LPVOID CoTaskMemRealloc(LPVOID pv, WPARAM cb)');
# my $ret = $CoTaskMemRealloc->Call($pv, $cb);
# pv : void* optional -> LPVOID
# cb : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目