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

CoLockObjectExternal

関数
オブジェクトを外部参照でロックまたはロック解除する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoLockObjectExternal(
    IUnknown* pUnk,
    BOOL fLock,
    BOOL fLastUnlockReleases
);

パラメーター

名前方向説明
pUnkIUnknown*inロックまたはロック解除の対象となるオブジェクトの IUnknown インターフェイスへのポインターです。
fLockBOOLinオブジェクトをロックするか解放するかを示します。このパラメーターが TRUE の場合、オブジェクトは AddRef/Release 操作、登録、または登録解除とは無関係にメモリ内に保持されます。このパラメーターが FALSE の場合、この関数の呼び出しによって以前に設定されたロックが解放されます。
fLastUnlockReleasesBOOLin

ロックがオブジェクトを存続させるための最後の参照である場合、TRUE を指定するとオブジェクトへのすべてのポインターが解放されます(オブジェクトを存続させることを目的としていない他の参照が存在する場合があります)。 それ以外の場合は FALSE を指定します。

fLockTRUE の場合、このパラメーターは無視されます。

戻り値の型: HRESULT

公式ドキュメント

オブジェクトをメモリ内に保持するためのロックを設定するか、そのようなロックを解放するために呼び出されます。

戻り値

この関数は、標準の戻り値 E_INVALIDARGE_OUTOFMEMORYE_UNEXPECTED、および S_OK を返すことができます。

解説(Remarks)

CoLockObjectExternal 関数は、オブジェクトが実際に存在するプロセス(ハンドラーが読み込まれる可能性のあるプロセスではなく、EXE プロセス)内で呼び出す必要があります。

CoLockObjectExternal 関数は、オブジェクトの参照カウントがゼロになるのを防ぎ、ロックが解放されるまでオブジェクトを存在させた状態で「ロック」します。同じ関数(パラメーターを変えて)がロックを解放します。ロックは、システムがオブジェクトに対して IUnknown::AddRef を呼び出すことによって実装されます。その後システムは、fLockFALSE に設定した CoLockObjectExternal の後続の呼び出しが行われるまで、オブジェクトに対する IUnknown::Release の呼び出しを待機します。この関数は、ユーザーと同様にオブジェクトの外側で動作するため、エンドユーザーに代わってオブジェクトの参照カウントを維持するために使用できます。

エンドユーザーは、外部ロックが存在する場合でも、アプリケーションの存続期間を明示的に制御できます。つまり、ユーザーがアプリケーションを終了することを決定した場合、アプリケーションはシャットダウンする必要があります。外部ロック(CoLockObjectExternal によって設定されたロックなど)が存在する場合、アプリケーションは CoDisconnectObject 関数を呼び出して、シャットダウン前にこれらの接続を強制的に閉じることができます。

CoLockObjectExternal を呼び出すと、オブジェクトに強いロックが設定されます。強いロックはオブジェクトをメモリ内に保持しますが、弱いロックは保持しません。強いロックは、たとえば OLE 埋め込みオブジェクトのサイレント更新中に必要です。埋め込みオブジェクトのコンテナーは、更新プロセスが完了するまでメモリ内に保持されなければなりません。また、アプリケーションがクライアントへのサービス提供を完了するまで存続することを保証するために、アプリケーションオブジェクトに対する強いロックも必要です。すべての外部参照は、オブジェクトに強い参照ロックを設定します。

CoLockObjectExternal 関数は、通常、次の状況で呼び出されます。

LockContainer の実装で CoLockObjectExternal を使用する際には、いくつか注意すべき点があります。埋め込みオブジェクトは、コンテナーを存続させる(ロックする)他の理由がない場合に、コンテナーを実行させ続けるためにコンテナーに対して LockContainer を呼び出します。埋め込みオブジェクトが表示状態になると、コンテナーは OleSetContainedObject 関数を呼び出して埋め込みオブジェクトへの接続を弱める必要があり、これにより他の接続がオブジェクトに影響を与えられるようになります。

アプリケーションが CoLockObjectExternal の呼び出しによってアプリケーションとドキュメントのシャットダウンのすべての側面を完全に管理しない限り、コンテナーは LockContainer 内でプライベートなロックカウントを保持し、ロックカウントがゼロに達してコンテナーが非表示になったときに終了するようにする必要があります。シャットダウンのすべての側面を維持し、それによってプライベートなロックカウントの保持を回避するということは、次のいずれかの条件が発生したときに常に CoLockObjectExternal を呼び出す必要があることを意味します。

デバッグの目的では、アプリケーションに設定された外部ロック(およびアンロック)の数を記録しておくと役立つ場合があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT CoLockObjectExternal(
    IUnknown* pUnk,
    BOOL fLock,
    BOOL fLastUnlockReleases
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoLockObjectExternal(
    IntPtr pUnk,   // IUnknown*
    bool fLock,   // BOOL
    bool fLastUnlockReleases   // BOOL
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoLockObjectExternal(
    pUnk As IntPtr,   ' IUnknown*
    fLock As Boolean,   ' BOOL
    fLastUnlockReleases As Boolean   ' BOOL
) As Integer
End Function
' pUnk : IUnknown*
' fLock : BOOL
' fLastUnlockReleases : BOOL
Declare PtrSafe Function CoLockObjectExternal Lib "ole32" ( _
    ByVal pUnk As LongPtr, _
    ByVal fLock As Long, _
    ByVal fLastUnlockReleases As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoLockObjectExternal = ctypes.windll.ole32.CoLockObjectExternal
CoLockObjectExternal.restype = ctypes.c_int
CoLockObjectExternal.argtypes = [
    ctypes.c_void_p,  # pUnk : IUnknown*
    wintypes.BOOL,  # fLock : BOOL
    wintypes.BOOL,  # fLastUnlockReleases : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoLockObjectExternal = ole32.NewProc("CoLockObjectExternal")
)

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

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

typedef CoLockObjectExternalNative = Int32 Function(Pointer<Void>, Int32, Int32);
typedef CoLockObjectExternalDart = int Function(Pointer<Void>, int, int);
final CoLockObjectExternal = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoLockObjectExternalNative, CoLockObjectExternalDart>('CoLockObjectExternal');
// pUnk : IUnknown* -> Pointer<Void>
// fLock : BOOL -> Int32
// fLastUnlockReleases : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoLockObjectExternal(
  pUnk: Pointer;   // IUnknown*
  fLock: BOOL;   // BOOL
  fLastUnlockReleases: BOOL   // BOOL
): Integer; stdcall;
  external 'OLE32.dll' name 'CoLockObjectExternal';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoLockObjectExternal"
  c_CoLockObjectExternal :: Ptr () -> CInt -> CInt -> IO Int32
-- pUnk : IUnknown* -> Ptr ()
-- fLock : BOOL -> CInt
-- fLastUnlockReleases : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let colockobjectexternal =
  foreign "CoLockObjectExternal"
    ((ptr void) @-> int32_t @-> int32_t @-> returning int32_t)
(* pUnk : IUnknown* -> (ptr void) *)
(* fLock : BOOL -> int32_t *)
(* fLastUnlockReleases : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoLockObjectExternal" co-lock-object-external :convention :stdcall) :int32
  (p-unk :pointer)   ; IUnknown*
  (f-lock :int32)   ; BOOL
  (f-last-unlock-releases :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoLockObjectExternal = Win32::API::More->new('OLE32',
    'int CoLockObjectExternal(LPVOID pUnk, BOOL fLock, BOOL fLastUnlockReleases)');
# my $ret = $CoLockObjectExternal->Call($pUnk, $fLock, $fLastUnlockReleases);
# pUnk : IUnknown* -> LPVOID
# fLock : BOOL -> BOOL
# fLastUnlockReleases : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型