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

OleNoteObjectVisible

関数
オブジェクトの可視状態を通知し参照ロックを管理する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT OleNoteObjectVisible(
    IUnknown* pUnknown,
    BOOL fVisible
);

パラメーター

名前方向説明
pUnknownIUnknown*inロックまたはアンロックの対象となるオブジェクト上の IUnknown インターフェイスへのポインター。
fVisibleBOOLinオブジェクトが可視かどうか。TRUE の場合、OLE は参照カウントをインクリメントし、外部または内部の IUnknown::AddRef および IUnknown::Release の操作、登録、または取り消しに関係なく、オブジェクトを可視かつ生存した状態に保ちます。FALSE の場合、OLE は保持を解放し (参照カウントをデクリメントし)、オブジェクトをクローズできるようになります。

戻り値の型: HRESULT

公式ドキュメント

オブジェクトを実行状態に保つ外部参照をインクリメントまたはデクリメントします。

戻り値

この関数は成功すると S_OK を返します。その他に返される可能性のある値には次のものがあります。

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

解説(Remarks)

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

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

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleNoteObjectVisible = ole32.NewProc("OleNoteObjectVisible")
)

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

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

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

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

関連項目

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