CreateDispTypeInfo

関数

インターフェイス記述からディスパッチ用タイプ情報を生成する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT CreateDispTypeInfo(
    INTERFACEDATA* pidata,
    DWORD lcid,
    ITypeInfo** pptinfo
);

パラメーター

名前	型	方向	説明
pidata	INTERFACEDATA*	inout	この型情報が記述するインターフェイスの記述です。
lcid	DWORD	in	型情報で使用される名前に対するロケール識別子です。
pptinfo	ITypeInfo**	out	戻り値として、DispGetIDsOfNames および DispInvoke で使用する型情報実装へのポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

IDispatch の実装で使用する簡易型情報を作成します。

戻り値

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

戻り値	説明
S_OK	インターフェイスがサポートされています。
E_INVALIDARG	インターフェイスの記述または LCID のいずれかが無効です。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。

解説(Remarks)

CreateDispTypeInfo と、公開対象のオブジェクトを記述する INTERFACEDATA 構造体を使用することで、実行時に型情報を構築できます。

この関数が返す型情報は、主に IDispatch の実装を自動化するために設計されています。CreateDispTypeInfo は、Type Description Interfaces で説明されているすべての型情報を返すわけではありません。引数 pidata はインターフェイスの完全な記述ではありません。ヘルプ情報、コメント、省略可能なパラメーター、およびさまざまなコンテキストで有用なその他の型情報は含まれません。

したがって、オブジェクトに関する型情報を提供するための推奨される方法は、Object Description Language (ODL) を使用してオブジェクトを記述し、Microsoft Interface Definition Language (MIDL) コンパイラーでそのオブジェクト記述を型ライブラリにコンパイルすることです。

型ライブラリの型情報を使用するには、CreateDispTypeInfo ではなく LoadTypeLib 関数および GetTypeInfoOfGuid 関数を使用します。詳細については、Type Description Interfaces を参照してください。

例

次のコードは、INTERFACEDATA から型情報を作成して CCalc オブジェクトを公開します。

static METHODDATA NEARDATA rgmdataCCalc[] =
{
      PROPERTY(VALUE,  IMETH_ACCUM,    IDMEMBER_ACCUM,    VT_I4),
      PROPERTY(ACCUM,  IMETH_ACCUM,    IDMEMBER_ACCUM,    VT_I4),
      PROPERTY(OPND,   IMETH_OPERAND,  IDMEMBER_OPERAND,  VT_I4),
      PROPERTY(OP,     IMETH_OPERATOR, IDMEMBER_OPERATOR, VT_I2),
      METHOD0(EVAL,    IMETH_EVAL,     IDMEMBER_EVAL,     VT_BOOL),
      METHOD0(CLEAR,   IMETH_CLEAR,    IDMEMBER_CLEAR,    VT_EMPTY),
      METHOD0(DISPLAY, IMETH_DISPLAY,  IDMEMBER_DISPLAY,  VT_EMPTY),
      METHOD0(QUIT,    IMETH_QUIT,     IDMEMBER_QUIT,     VT_EMPTY),
      METHOD1(BUTTON,  IMETH_BUTTON,   IDMEMBER_BUTTON,   VT_BOOL),
};

INTERFACEDATA NEARDATA g_idataCCalc =
{
   rgmdataCCalc, DIM(rgmdataCCalc)
};

// Use Dispatch interface API functions to implement IDispatch.
CCalc *
CCalc::Create()
{
   HRESULT hresult;
   CCalc * pcalc;
   CArith * parith;
   ITypeInfo * ptinfo;
   IUnknown * punkStdDisp;
   extern INTERFACEDATA NEARDATA g_idataCCalc;

   if((pcalc = new 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 CreateDispTypeInfo(
    INTERFACEDATA* pidata,
    DWORD lcid,
    ITypeInfo** pptinfo
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int CreateDispTypeInfo(
    IntPtr pidata,   // INTERFACEDATA* in/out
    uint lcid,   // DWORD
    IntPtr pptinfo   // ITypeInfo** out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function CreateDispTypeInfo(
    pidata As IntPtr,   ' INTERFACEDATA* in/out
    lcid As UInteger,   ' DWORD
    pptinfo As IntPtr   ' ITypeInfo** out
) As Integer
End Function

' pidata : INTERFACEDATA* in/out
' lcid : DWORD
' pptinfo : ITypeInfo** out
Declare PtrSafe Function CreateDispTypeInfo Lib "oleaut32" ( _
    ByVal pidata As LongPtr, _
    ByVal lcid As Long, _
    ByVal pptinfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateDispTypeInfo = ctypes.windll.oleaut32.CreateDispTypeInfo
CreateDispTypeInfo.restype = ctypes.c_int
CreateDispTypeInfo.argtypes = [
    ctypes.c_void_p,  # pidata : INTERFACEDATA* in/out
    wintypes.DWORD,  # lcid : DWORD
    ctypes.c_void_p,  # pptinfo : ITypeInfo** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
CreateDispTypeInfo = Fiddle::Function.new(
  lib['CreateDispTypeInfo'],
  [
    Fiddle::TYPE_VOIDP,  # pidata : INTERFACEDATA* in/out
    -Fiddle::TYPE_INT,  # lcid : DWORD
    Fiddle::TYPE_VOIDP,  # pptinfo : ITypeInfo** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn CreateDispTypeInfo(
        pidata: *mut INTERFACEDATA,  // INTERFACEDATA* in/out
        lcid: u32,  // DWORD
        pptinfo: *mut *mut core::ffi::c_void  // ITypeInfo** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int CreateDispTypeInfo(IntPtr pidata, uint lcid, IntPtr pptinfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_CreateDispTypeInfo' -Namespace Win32 -PassThru
# $api::CreateDispTypeInfo(pidata, lcid, pptinfo)

#uselib "OLEAUT32.dll"
#func global CreateDispTypeInfo "CreateDispTypeInfo" sptr, sptr, sptr
; CreateDispTypeInfo varptr(pidata), lcid, pptinfo   ; 戻り値は stat
; pidata : INTERFACEDATA* in/out -> "sptr"
; lcid : DWORD -> "sptr"
; pptinfo : ITypeInfo** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEAUT32.dll"
#cfunc global CreateDispTypeInfo "CreateDispTypeInfo" var, int, sptr
; res = CreateDispTypeInfo(pidata, lcid, pptinfo)
; pidata : INTERFACEDATA* in/out -> "var"
; lcid : DWORD -> "int"
; pptinfo : ITypeInfo** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll"
#cfunc global CreateDispTypeInfo "CreateDispTypeInfo" sptr, int, sptr
; res = CreateDispTypeInfo(varptr(pidata), lcid, pptinfo)
; pidata : INTERFACEDATA* in/out -> "sptr"
; lcid : DWORD -> "int"
; pptinfo : ITypeInfo** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。