DispGetParam

関数

DISPPARAMSから指定位置の引数を取得し目的の型に変換する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT DispGetParam(
    DISPPARAMS* pdispparams,
    DWORD position,
    VARENUM vtTarg,
    VARIANT* pvarResult,
    DWORD* puArgErr   // optional
);

パラメーター

名前	型	方向	説明
pdispparams	DISPPARAMS*	in	Invoke に渡されたパラメーターです。
position	DWORD	in	パラメーターリスト内でのパラメーターの位置です。DispGetParam は配列の末尾から処理を開始するため、position が 0 の場合は配列内の最後のパラメーターが返されます。
vtTarg	VARENUM	in	引数を強制変換する対象の型です。
pvarResult	VARIANT*	out	パラメーターを格納する variant です。
puArgErr	DWORD*	outoptional	戻り時に、DISP_E_TYPEMISMATCH エラーの原因となった引数のインデックスが格納されます。このポインターは Invoke に返され、エラーの原因となった引数の DISPPARAMS 内での位置を示します。

戻り値の型: HRESULT

公式ドキュメント

DISPPARAMS 構造体からパラメーターを取得します。名前付きパラメーターと位置パラメーターの両方を確認し、指定された型へパラメーターを強制変換します。

戻り値

この関数は次のいずれかの値を返します。

戻り値	説明
S_OK	成功しました。
DISP_E_BADVARTYPE	variant 型 vtTarg はサポートされていません。
DISP_E_OVERFLOW	取得したパラメーターを指定された型へ強制変換できませんでした。
DISP_E_PARAMNOTFOUND	position で示されたパラメーターが見つかりませんでした。
DISP_E_TYPEMISMATCH	引数を指定された型へ強制変換できませんでした。
E_INVALIDARG	いずれかのパラメーターが無効です。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。

解説(Remarks)

出力パラメーター pvarResult は有効な variant でなければなりません。既存の内容は標準的な方法で解放されます。variant の内容は VariantFree によって解放されます。

プロパティ設定操作の右辺を取得するために DispGetParam を使用した場合、2 番目のパラメーターには DISPID_PROPERTYPUT を指定してください。次に例を示します。

DispGetParam(&dispparams, DISPID_PROPERTYPUT, VT_BOOL, &varResult, &uiArg)

名前付きパラメーターは位置を指定してアクセスすることはできず、その逆も同様です。

例

次の例では、DispGetParam を使用して X プロパティと Y プロパティを設定します。

STDMETHODIMP
CPoint::Invoke(
   DISPID dispidMember,
   REFIID riid,
   LCID lcid,
   unsigned short wFlags,
   DISPPARAMS * pdispparams,
   VARIANT * pvarResult,
   EXCEPINFO * pExcepInfo,
   unsigned int * puArgErr)
{
   unsigned int uArgErr;
   HRESULT hresult;
   VARIANTARG varg0;
   VARIANT varResultDummy;

   // Make sure the wFlags are valid.
   if(wFlags & ~(DISPATCH_METHOD | DISPATCH_PROPERTYGET |
      DISPATCH_PROPERTYPUT | DISPATCH_PROPERTYPUTREF))
      return E_INVALIDARG;

   // This object only exposes a "default" interface.
   if(!IsEqualIID(riid, IID_NULL))
      return DISP_E_UNKNOWNINTERFACE;

   // It simplifies the following code if the caller
   // ignores the return value.
   if(puArgErr == NULL)
      puArgErr = &uArgErr;
   if(pvarResult == NULL)
      pvarResult = &varResultDummy;

   VariantInit(&varg0);

   // Assume the return type is void, unless otherwise is found.
   VariantInit(pvarResult);

   switch(dispidMember){
   case IDMEMBER_CPOINT_GETX:
      V_VT(pvarResult) = VT_I2;
      V_I2(pvarResult) = GetX();
      break;

   case IDMEMBER_CPOINT_SETX:
      hresult = DispGetParam(pdispparams, 0, VT_I2, &varg0, puArgErr);
      if(hresult != NOERROR)
         return hresult;
      SetX(V_I2(&varg0));
      break;

   case IDMEMBER_CPOINT_GETY:
      V_VT(pvarResult) = VT_I2;
      V_I2(pvarResult) = GetY();
      break;

   case IDMEMBER_CPOINT_SETY:
      hresult = DispGetParam(pdispparams, 0, VT_I2, &varg0, puArgErr);
      if(hresult != NOERROR)
         return hresult;
      SetY(V_I2(&varg0));
      break;

   default:
      return DISP_E_MEMBERNOTFOUND;
   }
   return NOERROR;
}

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

各言語での呼び出し定義

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

HRESULT DispGetParam(
    DISPPARAMS* pdispparams,
    DWORD position,
    VARENUM vtTarg,
    VARIANT* pvarResult,
    DWORD* puArgErr   // optional
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int DispGetParam(
    IntPtr pdispparams,   // DISPPARAMS*
    uint position,   // DWORD
    ushort vtTarg,   // VARENUM
    IntPtr pvarResult,   // VARIANT* out
    IntPtr puArgErr   // DWORD* optional, out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function DispGetParam(
    pdispparams As IntPtr,   ' DISPPARAMS*
    position As UInteger,   ' DWORD
    vtTarg As UShort,   ' VARENUM
    pvarResult As IntPtr,   ' VARIANT* out
    puArgErr As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' pdispparams : DISPPARAMS*
' position : DWORD
' vtTarg : VARENUM
' pvarResult : VARIANT* out
' puArgErr : DWORD* optional, out
Declare PtrSafe Function DispGetParam Lib "oleaut32" ( _
    ByVal pdispparams As LongPtr, _
    ByVal position As Long, _
    ByVal vtTarg As Integer, _
    ByVal pvarResult As LongPtr, _
    ByVal puArgErr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DispGetParam = ctypes.windll.oleaut32.DispGetParam
DispGetParam.restype = ctypes.c_int
DispGetParam.argtypes = [
    ctypes.c_void_p,  # pdispparams : DISPPARAMS*
    wintypes.DWORD,  # position : DWORD
    ctypes.c_ushort,  # vtTarg : VARENUM
    ctypes.c_void_p,  # pvarResult : VARIANT* out
    ctypes.POINTER(wintypes.DWORD),  # puArgErr : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
DispGetParam = Fiddle::Function.new(
  lib['DispGetParam'],
  [
    Fiddle::TYPE_VOIDP,  # pdispparams : DISPPARAMS*
    -Fiddle::TYPE_INT,  # position : DWORD
    -Fiddle::TYPE_SHORT,  # vtTarg : VARENUM
    Fiddle::TYPE_VOIDP,  # pvarResult : VARIANT* out
    Fiddle::TYPE_VOIDP,  # puArgErr : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn DispGetParam(
        pdispparams: *mut DISPPARAMS,  // DISPPARAMS*
        position: u32,  // DWORD
        vtTarg: u16,  // VARENUM
        pvarResult: *mut VARIANT,  // VARIANT* out
        puArgErr: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int DispGetParam(IntPtr pdispparams, uint position, ushort vtTarg, IntPtr pvarResult, IntPtr puArgErr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_DispGetParam' -Namespace Win32 -PassThru
# $api::DispGetParam(pdispparams, position, vtTarg, pvarResult, puArgErr)

#uselib "OLEAUT32.dll"
#func global DispGetParam "DispGetParam" sptr, sptr, sptr, sptr, sptr
; DispGetParam varptr(pdispparams), position, vtTarg, varptr(pvarResult), varptr(puArgErr)   ; 戻り値は stat
; pdispparams : DISPPARAMS* -> "sptr"
; position : DWORD -> "sptr"
; vtTarg : VARENUM -> "sptr"
; pvarResult : VARIANT* out -> "sptr"
; puArgErr : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEAUT32.dll"
#cfunc global DispGetParam "DispGetParam" var, int, int, var, var
; res = DispGetParam(pdispparams, position, vtTarg, pvarResult, puArgErr)
; pdispparams : DISPPARAMS* -> "var"
; position : DWORD -> "int"
; vtTarg : VARENUM -> "int"
; pvarResult : VARIANT* out -> "var"
; puArgErr : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll"
#cfunc global DispGetParam "DispGetParam" sptr, int, int, sptr, sptr
; res = DispGetParam(varptr(pdispparams), position, vtTarg, varptr(pvarResult), varptr(puArgErr))
; pdispparams : DISPPARAMS* -> "sptr"
; position : DWORD -> "int"
; vtTarg : VARENUM -> "int"
; pvarResult : VARIANT* out -> "sptr"
; puArgErr : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。