CoAddRefServerProcess
関数シグネチャ
// OLE32.dll
#include <windows.h>
DWORD CoAddRefServerProcess(void);パラメーターなし。戻り値: DWORD
公式ドキュメント
プロセスごとのグローバルな参照カウントをインクリメントします。
戻り値
現在の参照カウント。
解説(Remarks)
サーバーは CoAddRefServerProcess を呼び出して、プロセスごとのグローバルな参照カウントをインクリメントできます。この関数は、マルチアパートメントまたはフリースレッドのいずれかで複数のスレッドを使用して実装されたサーバーにとって特に役立ちます。この種のサーバーは、複数のスレッドにまたがるアクティベーション要求とシャットダウンの判断を調整する必要があります。CoAddRefServerProcess を呼び出すとプロセスごとのグローバルな参照カウントがインクリメントされ、CoReleaseServerProcess を呼び出すとそのカウントがデクリメントされます。
このカウントが 0 に達すると、OLE は自動的に CoSuspendClassObjects を呼び出し、新たなアクティベーション要求の受け付けを防ぎます。これにより、サーバーは別のアクティベーション要求が入ってくる心配なく、各スレッドからクラスオブジェクトの登録を解除できます。新たなアクティベーション要求は、ローカルサーバープロセスの新しいインスタンスの起動につながります。
ローカルサーバーアプリケーションがこれらの関数を利用する最も簡単な方法は、各インスタンスオブジェクトのコンストラクターと、各 IClassFactory::LockServer メソッドで fLock パラメーターが TRUE の場合に CoAddRefServerProcess を呼び出すことです。サーバーアプリケーションはまた、各インスタンスオブジェクトの破棄時と、各 LockServer メソッドで fLock パラメーターが FALSE の場合に CoReleaseServerProcess を呼び出す必要があります。最後に、サーバーアプリケーションは CoReleaseServerProcess の戻り値に注意し、それが 0 を返した場合はクリーンアップを開始する必要があります。複数のスレッドを持つサーバーの場合、これは通常、各スレッドにメッセージループの終了を通知し、CoRevokeClassObject と CoUninitialize を呼び出すことを意味します。
これらの関数を使用する場合は、オブジェクトインスタンスと LockServer メソッドの両方で呼び出す必要があります。そうしないと、サーバーアプリケーションが早期にシャットダウンされる可能性があります。通常、インプロセスサーバーは CoAddRefServerProcess や CoReleaseServerProcess を呼び出すべきではありません。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// OLE32.dll
#include <windows.h>
DWORD CoAddRefServerProcess(void);[DllImport("OLE32.dll", ExactSpelling = true)]
static extern uint CoAddRefServerProcess();<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoAddRefServerProcess() As UInteger
End FunctionDeclare PtrSafe Function CoAddRefServerProcess Lib "ole32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CoAddRefServerProcess = ctypes.windll.ole32.CoAddRefServerProcess
CoAddRefServerProcess.restype = wintypes.DWORD
CoAddRefServerProcess.argtypes = []require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLE32.dll')
CoAddRefServerProcess = Fiddle::Function.new(
lib['CoAddRefServerProcess'],
[],
-Fiddle::TYPE_INT)#[link(name = "ole32")]
extern "system" {
fn CoAddRefServerProcess() -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLE32.dll")]
public static extern uint CoAddRefServerProcess();
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoAddRefServerProcess' -Namespace Win32 -PassThru
# $api::CoAddRefServerProcess()#uselib "OLE32.dll"
#func global CoAddRefServerProcess "CoAddRefServerProcess"
; CoAddRefServerProcess ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "OLE32.dll"
#cfunc global CoAddRefServerProcess "CoAddRefServerProcess"
; res = CoAddRefServerProcess(); DWORD CoAddRefServerProcess()
#uselib "OLE32.dll"
#cfunc global CoAddRefServerProcess "CoAddRefServerProcess"
; res = CoAddRefServerProcess()import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ole32 = windows.NewLazySystemDLL("OLE32.dll")
procCoAddRefServerProcess = ole32.NewProc("CoAddRefServerProcess")
)
r1, _, err := procCoAddRefServerProcess.Call()
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction CoAddRefServerProcess: DWORD; stdcall;
external 'OLE32.dll' name 'CoAddRefServerProcess';result := DllCall("OLE32\CoAddRefServerProcess", "UInt")●CoAddRefServerProcess() = DLL("OLE32.dll", "dword CoAddRefServerProcess()")
# 呼び出し: CoAddRefServerProcess()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ole32" fn CoAddRefServerProcess() callconv(std.os.windows.WINAPI) u32;proc CoAddRefServerProcess(): uint32 {.importc: "CoAddRefServerProcess", stdcall, dynlib: "OLE32.dll".}pragma(lib, "ole32");
extern(Windows)
uint CoAddRefServerProcess();ccall((:CoAddRefServerProcess, "OLE32.dll"), stdcall, UInt32,
(),
)
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t CoAddRefServerProcess(void);
]]
local ole32 = ffi.load("ole32")
-- ole32.CoAddRefServerProcess()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const CoAddRefServerProcess = lib.func('__stdcall', 'CoAddRefServerProcess', 'uint32_t', []);
// CoAddRefServerProcess()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLE32.dll", {
CoAddRefServerProcess: { parameters: [], result: "u32" },
});
// lib.symbols.CoAddRefServerProcess()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t CoAddRefServerProcess(void);
C, "OLE32.dll");
// $ffi->CoAddRefServerProcess();
// 構造体/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);
int CoAddRefServerProcess();
}@[Link("ole32")]
lib LibOLE32
fun CoAddRefServerProcess = CoAddRefServerProcess() : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CoAddRefServerProcessNative = Uint32 Function();
typedef CoAddRefServerProcessDart = int Function();
final CoAddRefServerProcess = DynamicLibrary.open('OLE32.dll')
.lookupFunction<CoAddRefServerProcessNative, CoAddRefServerProcessDart>('CoAddRefServerProcess');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CoAddRefServerProcess: DWORD; stdcall;
external 'OLE32.dll' name 'CoAddRefServerProcess';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CoAddRefServerProcess"
c_CoAddRefServerProcess :: IO Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let coaddrefserverprocess =
foreign "CoAddRefServerProcess"
(void @-> returning uint32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)
(cffi:defcfun ("CoAddRefServerProcess" co-add-ref-server-process :convention :stdcall) :uint32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CoAddRefServerProcess = Win32::API::More->new('OLE32',
'DWORD CoAddRefServerProcess()');
# my $ret = $CoAddRefServerProcess->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CoReleaseServerProcess — サーバープロセスのグローバル参照カウントを減少させる。