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

OleLockRunning

関数
OLEオブジェクトの実行状態をロックまたは解除する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT OleLockRunning(
    IUnknown* pUnknown,
    BOOL fLock,
    BOOL fLastUnlockCloses
);

パラメーター

名前方向説明
pUnknownIUnknown*inオブジェクト上の IUnknown インターフェイスへのポインター。この関数はこれを使用して IRunnableObject へのポインターを照会します。
fLockBOOLinTRUE はオブジェクトを実行状態にロックします。FALSE はオブジェクトを実行状態からロック解除します。
fLastUnlockClosesBOOLinTRUE は、解放される接続がオブジェクトに対する最後の外部ロックである場合に、オブジェクトを閉じることを指定します。FALSE は、ユーザーまたは別のプロセスによって閉じられるまでオブジェクトを開いたままにすることを指定します。

戻り値の型: HRESULT

公式ドキュメント

既に実行中のオブジェクトを実行状態にロックする、または実行状態からロック解除します。(OleLockRunning)

戻り値

この関数は成功した場合に S_OK を返します。その他に返される可能性のある値は以下のとおりです。

戻り値 説明
E_OUTOFMEMORY
この操作に必要なメモリが不足しています。
E_INVALIDARG
1 つ以上のパラメーターが無効です。
E_UNEXPECTED
予期しないエラーが発生しました。

解説(Remarks)

OleLockRunning 関数を使用すると、IRunnableObject::LockRunning メソッドを呼び出す手間を省けます。OleLockRunningIRunnableObject::LockRunning は互換的に使用できます。pUnknown パラメーターで渡された IUnknown ポインターを使用して、OleLockRunningIRunnableObject ポインターを照会します。成功した場合、IRunnableObject::LockRunning を呼び出し、その呼び出しの結果を返します。

この関数の使用方法の詳細については、IRunnableObject::LockRunning を参照してください。

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

各言語での呼び出し定義

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

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

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

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleLockRunning = ole32.NewProc("OleLockRunning")
)

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

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

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

let olelockrunning =
  foreign "OleLockRunning"
    ((ptr void) @-> int32_t @-> int32_t @-> returning int32_t)
(* pUnknown : IUnknown* -> (ptr void) *)
(* fLock : BOOL -> int32_t *)
(* fLastUnlockCloses : 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 ("OleLockRunning" ole-lock-running :convention :stdcall) :int32
  (p-unknown :pointer)   ; IUnknown*
  (f-lock :int32)   ; BOOL
  (f-last-unlock-closes :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleLockRunning = Win32::API::More->new('OLE32',
    'int OleLockRunning(LPVOID pUnknown, BOOL fLock, BOOL fLastUnlockCloses)');
# my $ret = $OleLockRunning->Call($pUnknown, $fLock, $fLastUnlockCloses);
# pUnknown : IUnknown* -> LPVOID
# fLock : BOOL -> BOOL
# fLastUnlockCloses : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型