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

CoTaskMemAlloc

関数
COMタスクメモリヒープからメモリブロックを確保する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

void* CoTaskMemAlloc(
    UINT_PTR cb
);

パラメーター

名前方向説明
cbUINT_PTRin割り当てるメモリブロックのサイズ(バイト単位)。

戻り値の型: void*

公式ドキュメント

IMalloc::Alloc と同じ方法でタスクメモリのブロックを割り当てます。

戻り値

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

解説(Remarks)

CoTaskMemAlloc は、既定のアロケーターを使用して、IMalloc::Alloc と同じ方法でメモリブロックを割り当てます。CoTaskMemAlloc を呼び出す前に CoGetMalloc 関数を呼び出す必要はありません。

返されるメモリブロックの初期内容は未定義です。ブロックが初期化されている保証はありません。割り当てられたブロックは、アラインメントや管理情報に必要な領域のために、cb バイトより大きくなる場合があります。

cb が 0 の場合、CoTaskMemAlloc は長さ 0 の項目を割り当て、その項目への有効なポインターを返します。利用可能なメモリが不足している場合、CoTaskMemAllocNULL を返します。メモリが割り当てられる保証はないため、少量のメモリを要求する場合でも、アプリケーションは常にこの関数の戻り値を確認する必要があります。

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

各言語での呼び出し定義

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

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

CoTaskMemAlloc = ctypes.windll.ole32.CoTaskMemAlloc
CoTaskMemAlloc.restype = ctypes.c_void_p
CoTaskMemAlloc.argtypes = [
    ctypes.c_size_t,  # cb : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoTaskMemAlloc = ole32.NewProc("CoTaskMemAlloc")
)

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

extern "ole32" fn CoTaskMemAlloc(
    cb: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc CoTaskMemAlloc(
    cb: uint  # UINT_PTR
): pointer {.importc: "CoTaskMemAlloc", stdcall, dynlib: "OLE32.dll".}
pragma(lib, "ole32");
extern(Windows)
void* CoTaskMemAlloc(
    size_t cb   // UINT_PTR
);
ccall((:CoTaskMemAlloc, "OLE32.dll"), stdcall, Ptr{Cvoid},
      (Csize_t,),
      cb)
# cb : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* CoTaskMemAlloc(
    uintptr_t cb);
]]
local ole32 = ffi.load("ole32")
-- ole32.CoTaskMemAlloc(cb)
-- cb : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const CoTaskMemAlloc = lib.func('__stdcall', 'CoTaskMemAlloc', 'void *', ['uintptr_t']);
// CoTaskMemAlloc(cb)
// cb : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLE32.dll", {
  CoTaskMemAlloc: { parameters: ["usize"], result: "pointer" },
});
// lib.symbols.CoTaskMemAlloc(cb)
// cb : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* CoTaskMemAlloc(
    size_t cb);
C, "OLE32.dll");
// $ffi->CoTaskMemAlloc(cb);
// 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 CoTaskMemAlloc(
        long cb   // UINT_PTR
    );
}
@[Link("ole32")]
lib LibOLE32
  fun CoTaskMemAlloc = CoTaskMemAlloc(
    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 CoTaskMemAllocNative = Pointer<Void> Function(UintPtr);
typedef CoTaskMemAllocDart = Pointer<Void> Function(int);
final CoTaskMemAlloc = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoTaskMemAllocNative, CoTaskMemAllocDart>('CoTaskMemAlloc');
// cb : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoTaskMemAlloc(
  cb: NativeUInt   // UINT_PTR
): Pointer; stdcall;
  external 'OLE32.dll' name 'CoTaskMemAlloc';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let cotaskmemalloc =
  foreign "CoTaskMemAlloc"
    (size_t @-> returning (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 ("CoTaskMemAlloc" co-task-mem-alloc :convention :stdcall) :pointer
  (cb :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoTaskMemAlloc = Win32::API::More->new('OLE32',
    'LPVOID CoTaskMemAlloc(WPARAM cb)');
# my $ret = $CoTaskMemAlloc->Call($cb);
# cb : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目