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

CreateOleAdviseHolder

関数
アドバイズ接続を管理するOLEアドバイズホルダを作成する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CreateOleAdviseHolder(
    IOleAdviseHolder** ppOAHolder
);

パラメーター

名前方向説明
ppOAHolderIOleAdviseHolder**out新しいアドバイスホルダーオブジェクトへのインターフェイスポインターを受け取る IOleAdviseHolder ポインター変数のアドレスです。

戻り値の型: HRESULT

公式ドキュメント

複合ドキュメントの通知を管理するためのアドバイスホルダーオブジェクトを作成します。このオブジェクトの IOleAdviseHolder インターフェイスの OLE 実装へのポインターを返します。

戻り値

この関数は成功時に S_OK を返し、標準の戻り値 E_OUTOFMEMORY をサポートします。

解説(Remarks)

CreateOleAdviseHolder 関数は、IOleAdviseHolder インターフェイスの OLE 実装をサポートするアドバイスホルダーのインスタンスを作成します。このインターフェイスのメソッドは、IOleObject のアドバイザリメソッドを実装するために使用されることを意図しており、アドバイザリシンクをサポートするオブジェクトとアドバイザリ接続が確立されている場合には、オブジェクトの変更通知をアドバイザリシンクに送信するために使用されます。CreateOleAdviseHolder が返すアドバイスホルダーは、大半のアプリケーションにとって十分です。ただし、OLE が提供する実装は IOleAdviseHolder::EnumAdvise をサポートしていないため、このメソッドを使用する必要がある場合は、独自のアドバイスホルダーを実装する必要があります。

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

各言語での呼び出し定義

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

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

CreateOleAdviseHolder = ctypes.windll.ole32.CreateOleAdviseHolder
CreateOleAdviseHolder.restype = ctypes.c_int
CreateOleAdviseHolder.argtypes = [
    ctypes.c_void_p,  # ppOAHolder : IOleAdviseHolder** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCreateOleAdviseHolder = ole32.NewProc("CreateOleAdviseHolder")
)

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

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

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

foreign import stdcall safe "CreateOleAdviseHolder"
  c_CreateOleAdviseHolder :: Ptr () -> IO Int32
-- ppOAHolder : IOleAdviseHolder** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createoleadviseholder =
  foreign "CreateOleAdviseHolder"
    ((ptr void) @-> returning int32_t)
(* ppOAHolder : IOleAdviseHolder** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CreateOleAdviseHolder" create-ole-advise-holder :convention :stdcall) :int32
  (pp-oaholder :pointer))   ; IOleAdviseHolder** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateOleAdviseHolder = Win32::API::More->new('OLE32',
    'int CreateOleAdviseHolder(LPVOID ppOAHolder)');
# my $ret = $CreateOleAdviseHolder->Call($ppOAHolder);
# ppOAHolder : IOleAdviseHolder** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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