ホーム › Globalization › MappingGetServices

MappingGetServices

関数

利用可能なELS言語サービスの一覧を取得する。

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

シグネチャ

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

HRESULT MappingGetServices(
    MAPPING_ENUM_OPTIONS* pOptions,   // optional
    MAPPING_SERVICE_INFO** prgServices,
    DWORD* pdwServicesCount
);

パラメーター

名前	型	方向	説明
pOptions	MAPPING_ENUM_OPTIONS*	inoptional	サービスの列挙時に使用する条件を含む MAPPING_ENUM_OPTIONS 構造体へのポインターです。インストールされているすべてのサービスを取得するには、アプリケーションはこのパラメーターに NULL を指定します。
prgServices	MAPPING_SERVICE_INFO**	out	pOptions パラメーターで指定した条件に一致するサービス情報を含む MAPPING_SERVICE_INFO 構造体の配列へのポインターのアドレスです。
pdwServicesCount	DWORD*	out	取得されたサービスの数をこの関数が格納する DWORD 変数へのポインターです。

戻り値の型: HRESULT

公式ドキュメント

アプリケーションが指定した条件に従って、利用可能な ELS プラットフォームでサポートされるサービスの一覧と、それに関連する情報を取得します。

戻り値

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

Note アプリケーションは、それ以降の操作を続行する前に、いかなる失敗もテストする必要があります。

解説(Remarks)

ELS アプリケーションは、すべてのサービスを取得するか、指定したオプションに従ってサービスを絞り込むことができます。関連する手順とコードサンプルについては、Enumerating and Freeing Services を参照してください。

リソースリークを回避するため、アプリケーションは MappingFreeServices を呼び出して、prgServices が指すポインターを解放する必要があります。

パフォーマンス上の理由から、サービスの取得は頻繁に行わないことを推奨します。たとえば、アプリケーションが GUID で特定のサービスを必要とする場合、必要なときに列挙し、今後の使用のためにキャッシュしておくことができます。

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

各言語での呼び出し定義

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

HRESULT MappingGetServices(
    MAPPING_ENUM_OPTIONS* pOptions,   // optional
    MAPPING_SERVICE_INFO** prgServices,
    DWORD* pdwServicesCount
);

[DllImport("elscore.dll", ExactSpelling = true)]
static extern int MappingGetServices(
    IntPtr pOptions,   // MAPPING_ENUM_OPTIONS* optional
    IntPtr prgServices,   // MAPPING_SERVICE_INFO** out
    out uint pdwServicesCount   // DWORD* out
);

<DllImport("elscore.dll", ExactSpelling:=True)>
Public Shared Function MappingGetServices(
    pOptions As IntPtr,   ' MAPPING_ENUM_OPTIONS* optional
    prgServices As IntPtr,   ' MAPPING_SERVICE_INFO** out
    <Out> ByRef pdwServicesCount As UInteger   ' DWORD* out
) As Integer
End Function

' pOptions : MAPPING_ENUM_OPTIONS* optional
' prgServices : MAPPING_SERVICE_INFO** out
' pdwServicesCount : DWORD* out
Declare PtrSafe Function MappingGetServices Lib "elscore" ( _
    ByVal pOptions As LongPtr, _
    ByVal prgServices As LongPtr, _
    ByRef pdwServicesCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MappingGetServices = ctypes.windll.elscore.MappingGetServices
MappingGetServices.restype = ctypes.c_int
MappingGetServices.argtypes = [
    ctypes.c_void_p,  # pOptions : MAPPING_ENUM_OPTIONS* optional
    ctypes.c_void_p,  # prgServices : MAPPING_SERVICE_INFO** out
    ctypes.POINTER(wintypes.DWORD),  # pdwServicesCount : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('elscore.dll')
MappingGetServices = Fiddle::Function.new(
  lib['MappingGetServices'],
  [
    Fiddle::TYPE_VOIDP,  # pOptions : MAPPING_ENUM_OPTIONS* optional
    Fiddle::TYPE_VOIDP,  # prgServices : MAPPING_SERVICE_INFO** out
    Fiddle::TYPE_VOIDP,  # pdwServicesCount : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "elscore")]
extern "system" {
    fn MappingGetServices(
        pOptions: *mut MAPPING_ENUM_OPTIONS,  // MAPPING_ENUM_OPTIONS* optional
        prgServices: *mut *mut MAPPING_SERVICE_INFO,  // MAPPING_SERVICE_INFO** out
        pdwServicesCount: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("elscore.dll")]
public static extern int MappingGetServices(IntPtr pOptions, IntPtr prgServices, out uint pdwServicesCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'elscore_MappingGetServices' -Namespace Win32 -PassThru
# $api::MappingGetServices(pOptions, prgServices, pdwServicesCount)

#uselib "elscore.dll"
#func global MappingGetServices "MappingGetServices" sptr, sptr, sptr
; MappingGetServices varptr(pOptions), varptr(prgServices), varptr(pdwServicesCount)   ; 戻り値は stat
; pOptions : MAPPING_ENUM_OPTIONS* optional -> "sptr"
; prgServices : MAPPING_SERVICE_INFO** out -> "sptr"
; pdwServicesCount : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "elscore.dll"
#cfunc global MappingGetServices "MappingGetServices" var, var, var
; res = MappingGetServices(pOptions, prgServices, pdwServicesCount)
; pOptions : MAPPING_ENUM_OPTIONS* optional -> "var"
; prgServices : MAPPING_SERVICE_INFO** out -> "var"
; pdwServicesCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "elscore.dll"
#cfunc global MappingGetServices "MappingGetServices" sptr, sptr, sptr
; res = MappingGetServices(varptr(pOptions), varptr(prgServices), varptr(pdwServicesCount))
; pOptions : MAPPING_ENUM_OPTIONS* optional -> "sptr"
; prgServices : MAPPING_SERVICE_INFO** out -> "sptr"
; pdwServicesCount : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。