ホーム › System.Ole › OleSetContainedObject
OleSetContainedObject
関数オブジェクトに包含状態であることを通知する。
シグネチャ
// OLE32.dll
#include <windows.h>
HRESULT OleSetContainedObject(
IUnknown* pUnknown,
BOOL fContained
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pUnknown | IUnknown* | in | オブジェクトの IUnknown インターフェイスへのポインター。 |
| fContained | BOOL | in | オブジェクトが埋め込みオブジェクトである場合は TRUE、それ以外の場合は FALSE。 |
戻り値の型: HRESULT
公式ドキュメント
オブジェクトに対して、自身が OLE コンテナーに埋め込まれていることを通知します。これにより、埋め込みオブジェクトへのリンクをサポートするコンテナーで参照カウントが正しく行われるようになります。(OleSetContainedObject)
戻り値
この関数は成功した場合に S_OK を返します。その他に返される可能性のある値は次のとおりです。
| 戻り値 | 説明 |
|---|---|
| 操作に必要なメモリが不足しています。 | |
| 1 つ以上のパラメーターが無効です。 | |
| 予期しないエラーが発生しました。 |
解説(Remarks)
OleSetContainedObject 関数は、オブジェクトに対して自身が OLE コンテナーに埋め込まれていることを通知します。OleSetContainedObject の実装は、IRunnableObject インターフェイスの公開に合わせて OLE 2.01 で変更されました。OleSetContainedObject と IRunnableObject::SetContainedObject メソッドは互換的に使用できます。OleSetContainedObject 関数は、IRunnableObject インターフェイスへのポインターをオブジェクトに照会します。成功した場合、この関数は IRunnableObject::SetContainedObject を呼び出した結果を返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// OLE32.dll
#include <windows.h>
HRESULT OleSetContainedObject(
IUnknown* pUnknown,
BOOL fContained
);[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleSetContainedObject(
IntPtr pUnknown, // IUnknown*
bool fContained // BOOL
);<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleSetContainedObject(
pUnknown As IntPtr, ' IUnknown*
fContained As Boolean ' BOOL
) As Integer
End Function' pUnknown : IUnknown*
' fContained : BOOL
Declare PtrSafe Function OleSetContainedObject Lib "ole32" ( _
ByVal pUnknown As LongPtr, _
ByVal fContained As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
OleSetContainedObject = ctypes.windll.ole32.OleSetContainedObject
OleSetContainedObject.restype = ctypes.c_int
OleSetContainedObject.argtypes = [
ctypes.c_void_p, # pUnknown : IUnknown*
wintypes.BOOL, # fContained : BOOL
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLE32.dll')
OleSetContainedObject = Fiddle::Function.new(
lib['OleSetContainedObject'],
[
Fiddle::TYPE_VOIDP, # pUnknown : IUnknown*
Fiddle::TYPE_INT, # fContained : BOOL
],
Fiddle::TYPE_INT)#[link(name = "ole32")]
extern "system" {
fn OleSetContainedObject(
pUnknown: *mut core::ffi::c_void, // IUnknown*
fContained: i32 // BOOL
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleSetContainedObject(IntPtr pUnknown, bool fContained);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleSetContainedObject' -Namespace Win32 -PassThru
# $api::OleSetContainedObject(pUnknown, fContained)#uselib "OLE32.dll"
#func global OleSetContainedObject "OleSetContainedObject" sptr, sptr
; OleSetContainedObject pUnknown, fContained ; 戻り値は stat
; pUnknown : IUnknown* -> "sptr"
; fContained : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "OLE32.dll"
#cfunc global OleSetContainedObject "OleSetContainedObject" sptr, int
; res = OleSetContainedObject(pUnknown, fContained)
; pUnknown : IUnknown* -> "sptr"
; fContained : BOOL -> "int"; HRESULT OleSetContainedObject(IUnknown* pUnknown, BOOL fContained)
#uselib "OLE32.dll"
#cfunc global OleSetContainedObject "OleSetContainedObject" intptr, int
; res = OleSetContainedObject(pUnknown, fContained)
; pUnknown : IUnknown* -> "intptr"
; fContained : BOOL -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ole32 = windows.NewLazySystemDLL("OLE32.dll")
procOleSetContainedObject = ole32.NewProc("OleSetContainedObject")
)
// pUnknown (IUnknown*), fContained (BOOL)
r1, _, err := procOleSetContainedObject.Call(
uintptr(pUnknown),
uintptr(fContained),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction OleSetContainedObject(
pUnknown: Pointer; // IUnknown*
fContained: BOOL // BOOL
): Integer; stdcall;
external 'OLE32.dll' name 'OleSetContainedObject';result := DllCall("OLE32\OleSetContainedObject"
, "Ptr", pUnknown ; IUnknown*
, "Int", fContained ; BOOL
, "Int") ; return: HRESULT●OleSetContainedObject(pUnknown, fContained) = DLL("OLE32.dll", "int OleSetContainedObject(void*, bool)")
# 呼び出し: OleSetContainedObject(pUnknown, fContained)
# pUnknown : IUnknown* -> "void*"
# fContained : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ole32" fn OleSetContainedObject(
pUnknown: ?*anyopaque, // IUnknown*
fContained: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;proc OleSetContainedObject(
pUnknown: pointer, # IUnknown*
fContained: int32 # BOOL
): int32 {.importc: "OleSetContainedObject", stdcall, dynlib: "OLE32.dll".}pragma(lib, "ole32");
extern(Windows)
int OleSetContainedObject(
void* pUnknown, // IUnknown*
int fContained // BOOL
);ccall((:OleSetContainedObject, "OLE32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Int32),
pUnknown, fContained)
# pUnknown : IUnknown* -> Ptr{Cvoid}
# fContained : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t OleSetContainedObject(
void* pUnknown,
int32_t fContained);
]]
local ole32 = ffi.load("ole32")
-- ole32.OleSetContainedObject(pUnknown, fContained)
-- pUnknown : IUnknown*
-- fContained : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const OleSetContainedObject = lib.func('__stdcall', 'OleSetContainedObject', 'int32_t', ['void *', 'int32_t']);
// OleSetContainedObject(pUnknown, fContained)
// pUnknown : IUnknown* -> 'void *'
// fContained : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLE32.dll", {
OleSetContainedObject: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.OleSetContainedObject(pUnknown, fContained)
// pUnknown : IUnknown* -> "pointer"
// fContained : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t OleSetContainedObject(
void* pUnknown,
int32_t fContained);
C, "OLE32.dll");
// $ffi->OleSetContainedObject(pUnknown, fContained);
// pUnknown : IUnknown*
// fContained : 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 OleSetContainedObject(
Pointer pUnknown, // IUnknown*
boolean fContained // BOOL
);
}@[Link("ole32")]
lib LibOLE32
fun OleSetContainedObject = OleSetContainedObject(
pUnknown : Void*, # IUnknown*
fContained : 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 OleSetContainedObjectNative = Int32 Function(Pointer<Void>, Int32);
typedef OleSetContainedObjectDart = int Function(Pointer<Void>, int);
final OleSetContainedObject = DynamicLibrary.open('OLE32.dll')
.lookupFunction<OleSetContainedObjectNative, OleSetContainedObjectDart>('OleSetContainedObject');
// pUnknown : IUnknown* -> Pointer<Void>
// fContained : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function OleSetContainedObject(
pUnknown: Pointer; // IUnknown*
fContained: BOOL // BOOL
): Integer; stdcall;
external 'OLE32.dll' name 'OleSetContainedObject';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "OleSetContainedObject"
c_OleSetContainedObject :: Ptr () -> CInt -> IO Int32
-- pUnknown : IUnknown* -> Ptr ()
-- fContained : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let olesetcontainedobject =
foreign "OleSetContainedObject"
((ptr void) @-> int32_t @-> returning int32_t)
(* pUnknown : IUnknown* -> (ptr void) *)
(* fContained : 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 ("OleSetContainedObject" ole-set-contained-object :convention :stdcall) :int32
(p-unknown :pointer) ; IUnknown*
(f-contained :int32)) ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $OleSetContainedObject = Win32::API::More->new('OLE32',
'int OleSetContainedObject(LPVOID pUnknown, BOOL fContained)');
# my $ret = $OleSetContainedObject->Call($pUnknown, $fContained);
# pUnknown : IUnknown* -> LPVOID
# fContained : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
使用する型