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

CoFreeUnusedLibrariesEx

関数
遅延時間を指定し不要なCOMサーバーDLLを解放する。
DLLOLE32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

void CoFreeUnusedLibrariesEx(
    DWORD dwUnloadDelay,
    DWORD dwReserved
);

パラメーター

名前方向説明
dwUnloadDelayDWORDinDLL がアンロード可能であると表明してから、アンロードの候補になるまでの遅延時間(ミリ秒単位)。このパラメーターに INFINITE を設定すると、システム既定の遅延(10 分)が使用されます。0 を設定すると、遅延なしで DLL が強制的にアンロードされます。
dwReservedDWORDinこのパラメーターは予約されており、0 を指定する必要があります。

戻り値の型: void

公式ドキュメント

使用されなくなり、かつアンロード遅延が経過した DLL をアンロードします。

解説(Remarks)

COM は、コンポーネントを含む DLL が保持しているメモリを解放するための関数を提供します。最もよく使用されるのは CoFreeUnusedLibraries です。CoFreeUnusedLibraries は、アクティブなオブジェクトを持たない DLL を即座に解放するわけではありません。マルチスレッドアパートメント(MTA)およびニュートラルアパートメント(NA)では 10 分の遅延があります。シングルスレッドアパートメント(STA)では遅延はありません。

CoFreeUnusedLibraries の 10 分の遅延は、コンポーネント DLL のアンロードによって生じるマルチスレッドの競合状態を回避するためのものです。この既定の遅延は、多くのアプリケーションにとって長すぎる場合があります。

COM は、この関数が呼び出されたスレッド上でホストできるアパートメントに対してコンポーネントが読み込まれた、アクティブな DLL の一覧を保持しています。CoFreeUnusedLibrariesEx が呼び出されると、その一覧上の各 DLL の DllCanUnloadNow 関数が呼び出されます。DllCanUnloadNowS_FALSE を返す(またはエクスポートされていない)場合、その DLL はアンロードする準備ができていません。DllCanUnloadNowS_OK を返す場合、その DLL はアクティブな一覧から「アンロード候補」の一覧へ移されます。

DLL をアンロード候補の一覧に追加すると、その移動が行われた時点から dwUnloadDelay ミリ秒のタイムスタンプが DLL に付与されます。DLL がアンロード候補の一覧へ移されてから少なくとも dwUnloadDelay ミリ秒が経過した後に CoFreeUnusedLibrariesEx(または CoFreeUnusedLibraries)が再度呼び出されると、その DLL は実際にメモリから解放されます。DLL がアンロード候補の一覧にある間に COM がそのコンポーネント DLL を使用した場合、その DLL はアクティブな一覧に戻されます。

dwUnloadDelay に 0 を設定すると、予期しない結果を招くことがあります。コンポーネント DLL は、DllCanUnloadNow 関数から戻った後にクリーンアップのための時間を必要とする場合があります。たとえば、DLL が独自のワーカースレッドを持っていた場合、0 を使用すると問題が生じる可能性が高くなります。ワーカースレッドが終了する前に DLL がアンロードされ、それらのスレッド上で実行されているコードがアンマップされてしまうためです。また、dwUnloadDelay に短すぎる値を使用すると、DLL をページアウトさせる場合よりも再読み込みのオーバーヘッドが大きいため、パフォーマンスの問題につながることがあります。

この動作は、スレッドモデルが Free、Neutral、または Both に設定されたコンポーネントを提供する DLL によって引き起こされます。スレッドモデルが Apartment に設定されている場合(またはスレッドモデルが指定されていない場合)、これらのコンポーネントはアパートメントをホストする単一のスレッドに結び付けられているため、dwUnloadDelay は 0 として扱われます。

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

各言語での呼び出し定義

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

void CoFreeUnusedLibrariesEx(
    DWORD dwUnloadDelay,
    DWORD dwReserved
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern void CoFreeUnusedLibrariesEx(
    uint dwUnloadDelay,   // DWORD
    uint dwReserved   // DWORD
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Sub CoFreeUnusedLibrariesEx(
    dwUnloadDelay As UInteger,   ' DWORD
    dwReserved As UInteger   ' DWORD
)
End Sub
' dwUnloadDelay : DWORD
' dwReserved : DWORD
Declare PtrSafe Sub CoFreeUnusedLibrariesEx Lib "ole32" ( _
    ByVal dwUnloadDelay As Long, _
    ByVal dwReserved As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoFreeUnusedLibrariesEx = ctypes.windll.ole32.CoFreeUnusedLibrariesEx
CoFreeUnusedLibrariesEx.restype = None
CoFreeUnusedLibrariesEx.argtypes = [
    wintypes.DWORD,  # dwUnloadDelay : DWORD
    wintypes.DWORD,  # dwReserved : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoFreeUnusedLibrariesEx = Fiddle::Function.new(
  lib['CoFreeUnusedLibrariesEx'],
  [
    -Fiddle::TYPE_INT,  # dwUnloadDelay : DWORD
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
  ],
  Fiddle::TYPE_VOID)
#[link(name = "ole32")]
extern "system" {
    fn CoFreeUnusedLibrariesEx(
        dwUnloadDelay: u32,  // DWORD
        dwReserved: u32  // DWORD
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern void CoFreeUnusedLibrariesEx(uint dwUnloadDelay, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoFreeUnusedLibrariesEx' -Namespace Win32 -PassThru
# $api::CoFreeUnusedLibrariesEx(dwUnloadDelay, dwReserved)
#uselib "OLE32.dll"
#func global CoFreeUnusedLibrariesEx "CoFreeUnusedLibrariesEx" sptr, sptr
; CoFreeUnusedLibrariesEx dwUnloadDelay, dwReserved
; dwUnloadDelay : DWORD -> "sptr"
; dwReserved : DWORD -> "sptr"
#uselib "OLE32.dll"
#func global CoFreeUnusedLibrariesEx "CoFreeUnusedLibrariesEx" int, int
; CoFreeUnusedLibrariesEx dwUnloadDelay, dwReserved
; dwUnloadDelay : DWORD -> "int"
; dwReserved : DWORD -> "int"
; void CoFreeUnusedLibrariesEx(DWORD dwUnloadDelay, DWORD dwReserved)
#uselib "OLE32.dll"
#func global CoFreeUnusedLibrariesEx "CoFreeUnusedLibrariesEx" int, int
; CoFreeUnusedLibrariesEx dwUnloadDelay, dwReserved
; dwUnloadDelay : DWORD -> "int"
; dwReserved : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoFreeUnusedLibrariesEx = ole32.NewProc("CoFreeUnusedLibrariesEx")
)

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

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

typedef CoFreeUnusedLibrariesExNative = Void Function(Uint32, Uint32);
typedef CoFreeUnusedLibrariesExDart = void Function(int, int);
final CoFreeUnusedLibrariesEx = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoFreeUnusedLibrariesExNative, CoFreeUnusedLibrariesExDart>('CoFreeUnusedLibrariesEx');
// dwUnloadDelay : DWORD -> Uint32
// dwReserved : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure CoFreeUnusedLibrariesEx(
  dwUnloadDelay: DWORD;   // DWORD
  dwReserved: DWORD   // DWORD
); stdcall;
  external 'OLE32.dll' name 'CoFreeUnusedLibrariesEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoFreeUnusedLibrariesEx"
  c_CoFreeUnusedLibrariesEx :: Word32 -> Word32 -> IO ()
-- dwUnloadDelay : DWORD -> Word32
-- dwReserved : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cofreeunusedlibrariesex =
  foreign "CoFreeUnusedLibrariesEx"
    (uint32_t @-> uint32_t @-> returning void)
(* dwUnloadDelay : DWORD -> uint32_t *)
(* dwReserved : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoFreeUnusedLibrariesEx" co-free-unused-libraries-ex :convention :stdcall) :void
  (dw-unload-delay :uint32)   ; DWORD
  (dw-reserved :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoFreeUnusedLibrariesEx = Win32::API::More->new('OLE32',
    'void CoFreeUnusedLibrariesEx(DWORD dwUnloadDelay, DWORD dwReserved)');
# my $ret = $CoFreeUnusedLibrariesEx->Call($dwUnloadDelay, $dwReserved);
# dwUnloadDelay : DWORD -> DWORD
# dwReserved : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目