MappingDoAction

関数

認識結果の指定範囲に対しELSアクションを実行する。

DLLelscore.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT MappingDoAction(
    MAPPING_PROPERTY_BAG* pBag,
    DWORD dwRangeIndex,
    LPCWSTR pszActionId
);

パラメーター

名前	型	方向	説明
pBag	MAPPING_PROPERTY_BAG*	inout	MAPPING_PROPERTY_BAG 構造体へのポインター。これには、直前に呼び出した MappingRecognizeText の結果が格納されています。このパラメーターに NULL を設定することはできません。
dwRangeIndex	DWORD	in	認識されたテキスト範囲について、テキスト認識結果内の開始インデックス。この値は 0 から範囲数までの間である必要があります。
pszActionId	LPCWSTR	in	実行するアクションの識別子へのポインター。このパラメーターに NULL を設定することはできません。

戻り値の型: HRESULT

公式ドキュメント

ELS サービスに対し、テキスト認識が行われた後にアクションを実行させます。たとえば、電話ダイヤラーサービスはまず電話番号を認識し、その後で番号にダイヤルするという「アクション」を実行できます。

戻り値

成功した場合は S_OK を返します。成功しなかった場合、この関数はエラーを示す HRESULT 値を返します。

解説(Remarks)

アプリケーションは、MappingDoAction の呼び出しの前に MappingRecognizeText を呼び出す必要があります。

警告 MappingRecognizeText に渡される pszText 引数および pOptions 引数が参照するデータは、

pBag で渡されるプロパティバッグ構造体が MappingFreePropertyBag によって解放されるまで有効なままである必要があります。

これは、MappingRecognizeText および MappingDoAction への同期呼び出しと非同期呼び出しのいずれもが、

最初の MappingRecognizeText の呼び出しに渡されたデータを使用しようとするためです。

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

各言語での呼び出し定義

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

HRESULT MappingDoAction(
    MAPPING_PROPERTY_BAG* pBag,
    DWORD dwRangeIndex,
    LPCWSTR pszActionId
);

[DllImport("elscore.dll", ExactSpelling = true)]
static extern int MappingDoAction(
    IntPtr pBag,   // MAPPING_PROPERTY_BAG* in/out
    uint dwRangeIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pszActionId   // LPCWSTR
);

<DllImport("elscore.dll", ExactSpelling:=True)>
Public Shared Function MappingDoAction(
    pBag As IntPtr,   ' MAPPING_PROPERTY_BAG* in/out
    dwRangeIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszActionId As String   ' LPCWSTR
) As Integer
End Function

' pBag : MAPPING_PROPERTY_BAG* in/out
' dwRangeIndex : DWORD
' pszActionId : LPCWSTR
Declare PtrSafe Function MappingDoAction Lib "elscore" ( _
    ByVal pBag As LongPtr, _
    ByVal dwRangeIndex As Long, _
    ByVal pszActionId As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MappingDoAction = ctypes.windll.elscore.MappingDoAction
MappingDoAction.restype = ctypes.c_int
MappingDoAction.argtypes = [
    ctypes.c_void_p,  # pBag : MAPPING_PROPERTY_BAG* in/out
    wintypes.DWORD,  # dwRangeIndex : DWORD
    wintypes.LPCWSTR,  # pszActionId : LPCWSTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('elscore.dll')
MappingDoAction = Fiddle::Function.new(
  lib['MappingDoAction'],
  [
    Fiddle::TYPE_VOIDP,  # pBag : MAPPING_PROPERTY_BAG* in/out
    -Fiddle::TYPE_INT,  # dwRangeIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pszActionId : LPCWSTR
  ],
  Fiddle::TYPE_INT)

#[link(name = "elscore")]
extern "system" {
    fn MappingDoAction(
        pBag: *mut MAPPING_PROPERTY_BAG,  // MAPPING_PROPERTY_BAG* in/out
        dwRangeIndex: u32,  // DWORD
        pszActionId: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("elscore.dll")]
public static extern int MappingDoAction(IntPtr pBag, uint dwRangeIndex, [MarshalAs(UnmanagedType.LPWStr)] string pszActionId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'elscore_MappingDoAction' -Namespace Win32 -PassThru
# $api::MappingDoAction(pBag, dwRangeIndex, pszActionId)

#uselib "elscore.dll"
#func global MappingDoAction "MappingDoAction" sptr, sptr, sptr
; MappingDoAction varptr(pBag), dwRangeIndex, pszActionId   ; 戻り値は stat
; pBag : MAPPING_PROPERTY_BAG* in/out -> "sptr"
; dwRangeIndex : DWORD -> "sptr"
; pszActionId : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "elscore.dll"
#cfunc global MappingDoAction "MappingDoAction" var, int, wstr
; res = MappingDoAction(pBag, dwRangeIndex, pszActionId)
; pBag : MAPPING_PROPERTY_BAG* in/out -> "var"
; dwRangeIndex : DWORD -> "int"
; pszActionId : LPCWSTR -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "elscore.dll"
#cfunc global MappingDoAction "MappingDoAction" sptr, int, wstr
; res = MappingDoAction(varptr(pBag), dwRangeIndex, pszActionId)
; pBag : MAPPING_PROPERTY_BAG* in/out -> "sptr"
; dwRangeIndex : DWORD -> "int"
; pszActionId : LPCWSTR -> "wstr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。