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

CreateStdDispatch

関数
標準のIDispatch実装を生成して二重インターフェイスを支援する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT CreateStdDispatch(
    IUnknown* punkOuter,
    void* pvThis,
    ITypeInfo* ptinfo,
    IUnknown** ppunkStdDisp
);

パラメーター

名前方向説明
punkOuterIUnknown*inオブジェクトの IUnknown 実装。
pvThisvoid*inout公開するオブジェクト。
ptinfoITypeInfo*in公開するオブジェクトを記述する型情報。
ppunkStdDispIUnknown**outIDispatch インターフェイスの QueryInterface 呼び出しを実装するオブジェクトのプライベート unknown。関数が失敗した場合、このポインターは null になります。

戻り値の型: HRESULT

公式ドキュメント

IDispatch インターフェイスの標準実装を 1 回の関数呼び出しで作成します。これにより、オブジェクトをオートメーション経由で公開する処理が簡略化されます。

戻り値

この関数は次のいずれかの値を返すことがあります。

戻り値 説明
S_OK
成功しました。
E_INVALIDARG
最初の 3 つの引数のいずれかが無効です。
E_OUTOFMEMORY
操作を完了するのに十分なメモリがありませんでした。

解説(Remarks)

オブジェクトを作成する際、そのオブジェクト用に IDispatch のメンバー関数を実装する代わりに CreateStdDispatch を使用できます。ただし、CreateStdDispatch が作成する実装には次の制限があります。

LoadTypeLibGetTypeInfoOfGuid、および CreateStdDispatch は、型ライブラリを使用してオブジェクトを公開するために呼び出す必要のある最小限の関数セットを構成します。LoadTypeLibGetTypeInfoOfGuid の詳細については、Type Description Interfaces を参照してください。

CreateDispTypeInfoCreateStdDispatch は、INTERFACEDATA 構造体が提供する型情報を使用してオブジェクトを公開するために呼び出す必要のある最小限の dispatch コンポーネントセットを構成します。

次のコードは、CreateStdDispatch を使用して CCalc クラスの IDispatch インターフェイスを実装します。

CCalc FAR*
CCalc::Create()
{
   HRESULT hresult;
   CCalc * pcalc;
   CArith * parith;
   ITypeInfo* ptinfo;
   IUnknown * punkStdDisp;
extern INTERFACEDATA NEARDATA g_idataCCalc;

   if((pcalc = new FAR CCalc()) == NULL)
      return NULL;
   pcalc->AddRef();

   parith = &(pcalc->m_arith);

   // Build type information for the functionality on this object that
   // is being exposed for external programmability.
   hresult = CreateDispTypeInfo(
      &g_idataCCalc, LOCALE_SYSTEM_DEFAULT, &ptinfo);
   if(hresult != NOERROR)
      goto LError0;

   // Create an aggregate with an instance of the default
   // implementation of IDispatch that is initialized with
   // type information.
   hresult = CreateStdDispatch(
      pcalc,            // Controlling unknown.
      parith,            // Instance to dispatch on.
      ptinfo,            // Type information describing the instance.
      &punkStdDisp);

   ptinfo-&>Release();

   if(hresult != NOERROR)
      goto LError0;

   pcalc->m_punkStdDisp = punkStdDisp;

   return pcalc;

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

各言語での呼び出し定義

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

HRESULT CreateStdDispatch(
    IUnknown* punkOuter,
    void* pvThis,
    ITypeInfo* ptinfo,
    IUnknown** ppunkStdDisp
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int CreateStdDispatch(
    IntPtr punkOuter,   // IUnknown*
    IntPtr pvThis,   // void* in/out
    IntPtr ptinfo,   // ITypeInfo*
    IntPtr ppunkStdDisp   // IUnknown** out
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function CreateStdDispatch(
    punkOuter As IntPtr,   ' IUnknown*
    pvThis As IntPtr,   ' void* in/out
    ptinfo As IntPtr,   ' ITypeInfo*
    ppunkStdDisp As IntPtr   ' IUnknown** out
) As Integer
End Function
' punkOuter : IUnknown*
' pvThis : void* in/out
' ptinfo : ITypeInfo*
' ppunkStdDisp : IUnknown** out
Declare PtrSafe Function CreateStdDispatch Lib "oleaut32" ( _
    ByVal punkOuter As LongPtr, _
    ByVal pvThis As LongPtr, _
    ByVal ptinfo As LongPtr, _
    ByVal ppunkStdDisp As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateStdDispatch = ctypes.windll.oleaut32.CreateStdDispatch
CreateStdDispatch.restype = ctypes.c_int
CreateStdDispatch.argtypes = [
    ctypes.c_void_p,  # punkOuter : IUnknown*
    ctypes.POINTER(None),  # pvThis : void* in/out
    ctypes.c_void_p,  # ptinfo : ITypeInfo*
    ctypes.c_void_p,  # ppunkStdDisp : IUnknown** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procCreateStdDispatch = oleaut32.NewProc("CreateStdDispatch")
)

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

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

typedef CreateStdDispatchNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef CreateStdDispatchDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final CreateStdDispatch = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<CreateStdDispatchNative, CreateStdDispatchDart>('CreateStdDispatch');
// punkOuter : IUnknown* -> Pointer<Void>
// pvThis : void* in/out -> Pointer<Void>
// ptinfo : ITypeInfo* -> Pointer<Void>
// ppunkStdDisp : IUnknown** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateStdDispatch(
  punkOuter: Pointer;   // IUnknown*
  pvThis: Pointer;   // void* in/out
  ptinfo: Pointer;   // ITypeInfo*
  ppunkStdDisp: Pointer   // IUnknown** out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'CreateStdDispatch';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateStdDispatch"
  c_CreateStdDispatch :: Ptr () -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- punkOuter : IUnknown* -> Ptr ()
-- pvThis : void* in/out -> Ptr ()
-- ptinfo : ITypeInfo* -> Ptr ()
-- ppunkStdDisp : IUnknown** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createstddispatch =
  foreign "CreateStdDispatch"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* punkOuter : IUnknown* -> (ptr void) *)
(* pvThis : void* in/out -> (ptr void) *)
(* ptinfo : ITypeInfo* -> (ptr void) *)
(* ppunkStdDisp : IUnknown** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("CreateStdDispatch" create-std-dispatch :convention :stdcall) :int32
  (punk-outer :pointer)   ; IUnknown*
  (pv-this :pointer)   ; void* in/out
  (ptinfo :pointer)   ; ITypeInfo*
  (ppunk-std-disp :pointer))   ; IUnknown** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateStdDispatch = Win32::API::More->new('OLEAUT32',
    'int CreateStdDispatch(LPVOID punkOuter, LPVOID pvThis, LPVOID ptinfo, LPVOID ppunkStdDisp)');
# my $ret = $CreateStdDispatch->Call($punkOuter, $pvThis, $ptinfo, $ppunkStdDisp);
# punkOuter : IUnknown* -> LPVOID
# pvThis : void* in/out -> LPVOID
# ptinfo : ITypeInfo* -> LPVOID
# ppunkStdDisp : IUnknown** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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