Win32 API 日本語リファレンス
ホームGlobalization › MappingFreePropertyBag

MappingFreePropertyBag

関数
MappingRecognizeTextの結果プロパティバッグを解放する。
DLLelscore.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT MappingFreePropertyBag(
    MAPPING_PROPERTY_BAG* pBag
);

パラメーター

名前方向説明
pBagMAPPING_PROPERTY_BAG*inリソースを解放するプロパティを格納した MAPPING_PROPERTY_BAG 構造体へのポインターです。このパラメーターに NULL を設定することはできません。

戻り値の型: HRESULT

公式ドキュメント

ELS のテキスト認識操作中に割り当てられたメモリとリソースを解放します。

戻り値

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

解説(Remarks)

ELS サービスは、アプリケーションが MappingRecognizeText を呼び出して取得したデータのために、メモリとリソースを割り当てます。MappingFreePropertyBag 関数は、これらのリソースを解放します。

注意 サービスによって生成されたプロパティバッグを解放する前に、そのサービスを解放しないでください。
注意 アプリケーションは、プロパティバッグが不要になったときに、MappingRecognizeText の各呼び出しに対して、この関数を 1 回だけ呼び出す必要があります。MappingRecognizeText の各呼び出しの後に MappingFreePropertyBag を呼び出さないと、リソースリークが発生します。プロパティバッグのメモリ割り当ての詳細については、MAPPING_PROPERTY_BAG 構造体の注釈を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT MappingFreePropertyBag(
    MAPPING_PROPERTY_BAG* pBag
);
[DllImport("elscore.dll", ExactSpelling = true)]
static extern int MappingFreePropertyBag(
    IntPtr pBag   // MAPPING_PROPERTY_BAG*
);
<DllImport("elscore.dll", ExactSpelling:=True)>
Public Shared Function MappingFreePropertyBag(
    pBag As IntPtr   ' MAPPING_PROPERTY_BAG*
) As Integer
End Function
' pBag : MAPPING_PROPERTY_BAG*
Declare PtrSafe Function MappingFreePropertyBag Lib "elscore" ( _
    ByVal pBag As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MappingFreePropertyBag = ctypes.windll.elscore.MappingFreePropertyBag
MappingFreePropertyBag.restype = ctypes.c_int
MappingFreePropertyBag.argtypes = [
    ctypes.c_void_p,  # pBag : MAPPING_PROPERTY_BAG*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('elscore.dll')
MappingFreePropertyBag = Fiddle::Function.new(
  lib['MappingFreePropertyBag'],
  [
    Fiddle::TYPE_VOIDP,  # pBag : MAPPING_PROPERTY_BAG*
  ],
  Fiddle::TYPE_INT)
#[link(name = "elscore")]
extern "system" {
    fn MappingFreePropertyBag(
        pBag: *mut MAPPING_PROPERTY_BAG  // MAPPING_PROPERTY_BAG*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("elscore.dll")]
public static extern int MappingFreePropertyBag(IntPtr pBag);
"@
$api = Add-Type -MemberDefinition $sig -Name 'elscore_MappingFreePropertyBag' -Namespace Win32 -PassThru
# $api::MappingFreePropertyBag(pBag)
#uselib "elscore.dll"
#func global MappingFreePropertyBag "MappingFreePropertyBag" sptr
; MappingFreePropertyBag varptr(pBag)   ; 戻り値は stat
; pBag : MAPPING_PROPERTY_BAG* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "elscore.dll"
#cfunc global MappingFreePropertyBag "MappingFreePropertyBag" var
; res = MappingFreePropertyBag(pBag)
; pBag : MAPPING_PROPERTY_BAG* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT MappingFreePropertyBag(MAPPING_PROPERTY_BAG* pBag)
#uselib "elscore.dll"
#cfunc global MappingFreePropertyBag "MappingFreePropertyBag" var
; res = MappingFreePropertyBag(pBag)
; pBag : MAPPING_PROPERTY_BAG* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	elscore = windows.NewLazySystemDLL("elscore.dll")
	procMappingFreePropertyBag = elscore.NewProc("MappingFreePropertyBag")
)

// pBag (MAPPING_PROPERTY_BAG*)
r1, _, err := procMappingFreePropertyBag.Call(
	uintptr(pBag),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function MappingFreePropertyBag(
  pBag: Pointer   // MAPPING_PROPERTY_BAG*
): Integer; stdcall;
  external 'elscore.dll' name 'MappingFreePropertyBag';
result := DllCall("elscore\MappingFreePropertyBag"
    , "Ptr", pBag   ; MAPPING_PROPERTY_BAG*
    , "Int")   ; return: HRESULT
●MappingFreePropertyBag(pBag) = DLL("elscore.dll", "int MappingFreePropertyBag(void*)")
# 呼び出し: MappingFreePropertyBag(pBag)
# pBag : MAPPING_PROPERTY_BAG* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "elscore" fn MappingFreePropertyBag(
    pBag: [*c]MAPPING_PROPERTY_BAG // MAPPING_PROPERTY_BAG*
) callconv(std.os.windows.WINAPI) i32;
proc MappingFreePropertyBag(
    pBag: ptr MAPPING_PROPERTY_BAG  # MAPPING_PROPERTY_BAG*
): int32 {.importc: "MappingFreePropertyBag", stdcall, dynlib: "elscore.dll".}
pragma(lib, "elscore");
extern(Windows)
int MappingFreePropertyBag(
    MAPPING_PROPERTY_BAG* pBag   // MAPPING_PROPERTY_BAG*
);
ccall((:MappingFreePropertyBag, "elscore.dll"), stdcall, Int32,
      (Ptr{MAPPING_PROPERTY_BAG},),
      pBag)
# pBag : MAPPING_PROPERTY_BAG* -> Ptr{MAPPING_PROPERTY_BAG}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t MappingFreePropertyBag(
    void* pBag);
]]
local elscore = ffi.load("elscore")
-- elscore.MappingFreePropertyBag(pBag)
-- pBag : MAPPING_PROPERTY_BAG*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('elscore.dll');
const MappingFreePropertyBag = lib.func('__stdcall', 'MappingFreePropertyBag', 'int32_t', ['void *']);
// MappingFreePropertyBag(pBag)
// pBag : MAPPING_PROPERTY_BAG* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("elscore.dll", {
  MappingFreePropertyBag: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.MappingFreePropertyBag(pBag)
// pBag : MAPPING_PROPERTY_BAG* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t MappingFreePropertyBag(
    void* pBag);
C, "elscore.dll");
// $ffi->MappingFreePropertyBag(pBag);
// pBag : MAPPING_PROPERTY_BAG*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Elscore extends StdCallLibrary {
    Elscore INSTANCE = Native.load("elscore", Elscore.class);
    int MappingFreePropertyBag(
        Pointer pBag   // MAPPING_PROPERTY_BAG*
    );
}
@[Link("elscore")]
lib Libelscore
  fun MappingFreePropertyBag = MappingFreePropertyBag(
    pBag : MAPPING_PROPERTY_BAG*   # MAPPING_PROPERTY_BAG*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MappingFreePropertyBagNative = Int32 Function(Pointer<Void>);
typedef MappingFreePropertyBagDart = int Function(Pointer<Void>);
final MappingFreePropertyBag = DynamicLibrary.open('elscore.dll')
    .lookupFunction<MappingFreePropertyBagNative, MappingFreePropertyBagDart>('MappingFreePropertyBag');
// pBag : MAPPING_PROPERTY_BAG* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MappingFreePropertyBag(
  pBag: Pointer   // MAPPING_PROPERTY_BAG*
): Integer; stdcall;
  external 'elscore.dll' name 'MappingFreePropertyBag';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MappingFreePropertyBag"
  c_MappingFreePropertyBag :: Ptr () -> IO Int32
-- pBag : MAPPING_PROPERTY_BAG* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mappingfreepropertybag =
  foreign "MappingFreePropertyBag"
    ((ptr void) @-> returning int32_t)
(* pBag : MAPPING_PROPERTY_BAG* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library elscore (t "elscore.dll"))
(cffi:use-foreign-library elscore)

(cffi:defcfun ("MappingFreePropertyBag" mapping-free-property-bag :convention :stdcall) :int32
  (p-bag :pointer))   ; MAPPING_PROPERTY_BAG*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MappingFreePropertyBag = Win32::API::More->new('elscore',
    'int MappingFreePropertyBag(LPVOID pBag)');
# my $ret = $MappingFreePropertyBag->Call($pBag);
# pBag : MAPPING_PROPERTY_BAG* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型