ホーム › Globalization › MappingRecognizeText

MappingRecognizeText

関数

ELSサービスを用いてテキストを解析・認識する。

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

シグネチャ

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

HRESULT MappingRecognizeText(
    MAPPING_SERVICE_INFO* pServiceInfo,
    LPCWSTR pszText,
    DWORD dwLength,
    DWORD dwIndex,
    MAPPING_OPTIONS* pOptions,   // optional
    MAPPING_PROPERTY_BAG* pbag
);

パラメーター

名前	型	方向	説明
pServiceInfo	MAPPING_SERVICE_INFO*	in	テキスト認識に使用するサービスに関する情報を含む MAPPING_SERVICE_INFO 構造体へのポインターです。この構造体は、以前に呼び出した MappingGetServices によって取得した構造体のいずれかである必要があります。このパラメーターを NULL に設定することはできません。
pszText	LPCWSTR	in	認識するテキストへのポインターです。テキストは UTF-16 である必要がありますが、一部のサービスには入力形式に関する追加の要件があります。このパラメーターを NULL に設定することはできません。
dwLength	DWORD	in	pszText で指定したテキストの長さ(文字数)です。
dwIndex	DWORD	in	サービスが使用する、指定したテキスト内のインデックスです。この値は 0 から dwLength-1 の範囲である必要があります。アプリケーションがテキスト全体を処理する場合は、このパラメーターを 0 に設定します。
pOptions	MAPPING_OPTIONS*	inoptional	テキスト認識の結果と動作に影響するオプションを含む MAPPING_OPTIONS 構造体へのポインターです。アプリケーションは、すべての構造体メンバーに値を指定する必要はありません。このパラメーターを NULL に設定すると、既定のマッピングオプションが使用されます。
pbag	MAPPING_PROPERTY_BAG*	inout	サービスが結果を格納する MAPPING_PROPERTY_BAG 構造体へのポインターです。入力時には、アプリケーションはサイズのみを設定し、他のメンバーを 0 に設定した構造体を渡します。出力時には、テキスト認識中にサービスが生成した情報が構造体に格納されます。このパラメーターを NULL に設定することはできません。

戻り値の型: HRESULT

公式ドキュメント

ELS サービスを呼び出してテキストを認識します。たとえば、Microsoft Language Detection サービスは、入力テキストが記述されている言語を認識しようとします。

戻り値

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

解説(Remarks)

認識するテキストの種類は、アプリケーションが使用するサービスの種類によって異なります。詳細については、Requesting Text Recognition を参照してください。

Warning 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 MappingRecognizeText(
    MAPPING_SERVICE_INFO* pServiceInfo,
    LPCWSTR pszText,
    DWORD dwLength,
    DWORD dwIndex,
    MAPPING_OPTIONS* pOptions,   // optional
    MAPPING_PROPERTY_BAG* pbag
);

[DllImport("elscore.dll", ExactSpelling = true)]
static extern int MappingRecognizeText(
    IntPtr pServiceInfo,   // MAPPING_SERVICE_INFO*
    [MarshalAs(UnmanagedType.LPWStr)] string pszText,   // LPCWSTR
    uint dwLength,   // DWORD
    uint dwIndex,   // DWORD
    IntPtr pOptions,   // MAPPING_OPTIONS* optional
    IntPtr pbag   // MAPPING_PROPERTY_BAG* in/out
);

<DllImport("elscore.dll", ExactSpelling:=True)>
Public Shared Function MappingRecognizeText(
    pServiceInfo As IntPtr,   ' MAPPING_SERVICE_INFO*
    <MarshalAs(UnmanagedType.LPWStr)> pszText As String,   ' LPCWSTR
    dwLength As UInteger,   ' DWORD
    dwIndex As UInteger,   ' DWORD
    pOptions As IntPtr,   ' MAPPING_OPTIONS* optional
    pbag As IntPtr   ' MAPPING_PROPERTY_BAG* in/out
) As Integer
End Function

' pServiceInfo : MAPPING_SERVICE_INFO*
' pszText : LPCWSTR
' dwLength : DWORD
' dwIndex : DWORD
' pOptions : MAPPING_OPTIONS* optional
' pbag : MAPPING_PROPERTY_BAG* in/out
Declare PtrSafe Function MappingRecognizeText Lib "elscore" ( _
    ByVal pServiceInfo As LongPtr, _
    ByVal pszText As LongPtr, _
    ByVal dwLength As Long, _
    ByVal dwIndex As Long, _
    ByVal pOptions As LongPtr, _
    ByVal pbag As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MappingRecognizeText = ctypes.windll.elscore.MappingRecognizeText
MappingRecognizeText.restype = ctypes.c_int
MappingRecognizeText.argtypes = [
    ctypes.c_void_p,  # pServiceInfo : MAPPING_SERVICE_INFO*
    wintypes.LPCWSTR,  # pszText : LPCWSTR
    wintypes.DWORD,  # dwLength : DWORD
    wintypes.DWORD,  # dwIndex : DWORD
    ctypes.c_void_p,  # pOptions : MAPPING_OPTIONS* optional
    ctypes.c_void_p,  # pbag : MAPPING_PROPERTY_BAG* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('elscore.dll')
MappingRecognizeText = Fiddle::Function.new(
  lib['MappingRecognizeText'],
  [
    Fiddle::TYPE_VOIDP,  # pServiceInfo : MAPPING_SERVICE_INFO*
    Fiddle::TYPE_VOIDP,  # pszText : LPCWSTR
    -Fiddle::TYPE_INT,  # dwLength : DWORD
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pOptions : MAPPING_OPTIONS* optional
    Fiddle::TYPE_VOIDP,  # pbag : MAPPING_PROPERTY_BAG* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "elscore")]
extern "system" {
    fn MappingRecognizeText(
        pServiceInfo: *mut MAPPING_SERVICE_INFO,  // MAPPING_SERVICE_INFO*
        pszText: *const u16,  // LPCWSTR
        dwLength: u32,  // DWORD
        dwIndex: u32,  // DWORD
        pOptions: *mut MAPPING_OPTIONS,  // MAPPING_OPTIONS* optional
        pbag: *mut MAPPING_PROPERTY_BAG  // MAPPING_PROPERTY_BAG* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("elscore.dll")]
public static extern int MappingRecognizeText(IntPtr pServiceInfo, [MarshalAs(UnmanagedType.LPWStr)] string pszText, uint dwLength, uint dwIndex, IntPtr pOptions, IntPtr pbag);
"@
$api = Add-Type -MemberDefinition $sig -Name 'elscore_MappingRecognizeText' -Namespace Win32 -PassThru
# $api::MappingRecognizeText(pServiceInfo, pszText, dwLength, dwIndex, pOptions, pbag)

#uselib "elscore.dll"
#func global MappingRecognizeText "MappingRecognizeText" sptr, sptr, sptr, sptr, sptr, sptr
; MappingRecognizeText varptr(pServiceInfo), pszText, dwLength, dwIndex, varptr(pOptions), varptr(pbag)   ; 戻り値は stat
; pServiceInfo : MAPPING_SERVICE_INFO* -> "sptr"
; pszText : LPCWSTR -> "sptr"
; dwLength : DWORD -> "sptr"
; dwIndex : DWORD -> "sptr"
; pOptions : MAPPING_OPTIONS* optional -> "sptr"
; pbag : MAPPING_PROPERTY_BAG* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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