DispGetIDsOfNames

関数

タイプ情報を用いて名前に対応するディスパッチIDを取得する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT DispGetIDsOfNames(
    ITypeInfo* ptinfo,
    LPWSTR* rgszNames,
    DWORD cNames,
    INT* rgdispid
);

パラメーター

名前	型	方向	説明
ptinfo	ITypeInfo*	in	インターフェイスの型情報です。この型情報は 1 つのインターフェイスと言語コードに固有であるため、この関数にインターフェイス識別子 (IID) や LCID を渡す必要はありません。
rgszNames	LPWSTR*	in	名前文字列の配列で、DispInvoke に DISPPARAMS 構造体で渡す配列と同じものを使用できます。cNames が 1 より大きい場合、最初の名前はメソッド名として解釈され、後続の名前はそのメソッドのパラメーターとして解釈されます。
cNames	DWORD	in	rgszNames 内の要素数です。
rgdispid	INT*	out	この関数によって設定される DISPID の配列です。最初の ID はメソッド名に対応します。後続の ID はメソッドのパラメーターとして解釈されます。

戻り値の型: HRESULT

公式ドキュメント

カスタマイズした Invoke にマシン非依存性を提供する、Invoke 向けの低レベルなヘルパー関数です。(DispGetIDsOfNames)

戻り値

戻り値コード	説明
S_OK	インターフェイスがサポートされています。
E_INVALIDARG	パラメーターのいずれかが無効です。
DISP_E_UNKNOWNNAME	指定された名前の 1 つ以上が不明でした。返される DISPID の配列には、不明な名前に対応する各エントリに DISPID_UNKNOWN が格納されます。

ITypeInfo::Invoke のエラーのいずれも返される可能性があります。

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

各言語での呼び出し定義

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

HRESULT DispGetIDsOfNames(
    ITypeInfo* ptinfo,
    LPWSTR* rgszNames,
    DWORD cNames,
    INT* rgdispid
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int DispGetIDsOfNames(
    IntPtr ptinfo,   // ITypeInfo*
    IntPtr rgszNames,   // LPWSTR*
    uint cNames,   // DWORD
    out int rgdispid   // INT* out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function DispGetIDsOfNames(
    ptinfo As IntPtr,   ' ITypeInfo*
    rgszNames As IntPtr,   ' LPWSTR*
    cNames As UInteger,   ' DWORD
    <Out> ByRef rgdispid As Integer   ' INT* out
) As Integer
End Function

' ptinfo : ITypeInfo*
' rgszNames : LPWSTR*
' cNames : DWORD
' rgdispid : INT* out
Declare PtrSafe Function DispGetIDsOfNames Lib "oleaut32" ( _
    ByVal ptinfo As LongPtr, _
    ByVal rgszNames As LongPtr, _
    ByVal cNames As Long, _
    ByRef rgdispid As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DispGetIDsOfNames = ctypes.windll.oleaut32.DispGetIDsOfNames
DispGetIDsOfNames.restype = ctypes.c_int
DispGetIDsOfNames.argtypes = [
    ctypes.c_void_p,  # ptinfo : ITypeInfo*
    ctypes.c_void_p,  # rgszNames : LPWSTR*
    wintypes.DWORD,  # cNames : DWORD
    ctypes.POINTER(ctypes.c_int),  # rgdispid : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
DispGetIDsOfNames = Fiddle::Function.new(
  lib['DispGetIDsOfNames'],
  [
    Fiddle::TYPE_VOIDP,  # ptinfo : ITypeInfo*
    Fiddle::TYPE_VOIDP,  # rgszNames : LPWSTR*
    -Fiddle::TYPE_INT,  # cNames : DWORD
    Fiddle::TYPE_VOIDP,  # rgdispid : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn DispGetIDsOfNames(
        ptinfo: *mut core::ffi::c_void,  // ITypeInfo*
        rgszNames: *mut *mut u16,  // LPWSTR*
        cNames: u32,  // DWORD
        rgdispid: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int DispGetIDsOfNames(IntPtr ptinfo, IntPtr rgszNames, uint cNames, out int rgdispid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_DispGetIDsOfNames' -Namespace Win32 -PassThru
# $api::DispGetIDsOfNames(ptinfo, rgszNames, cNames, rgdispid)

#uselib "OLEAUT32.dll"
#func global DispGetIDsOfNames "DispGetIDsOfNames" sptr, sptr, sptr, sptr
; DispGetIDsOfNames ptinfo, varptr(rgszNames), cNames, varptr(rgdispid)   ; 戻り値は stat
; ptinfo : ITypeInfo* -> "sptr"
; rgszNames : LPWSTR* -> "sptr"
; cNames : DWORD -> "sptr"
; rgdispid : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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