ホーム › System.Rpc › RpcServerInterfaceGroupCreateA

RpcServerInterfaceGroupCreateA

関数

複数のインターフェイスとエンドポイントをまとめたインターフェイスグループを作成する(ANSI版)。

DLLRPCRT4.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

// RPCRT4.dll  (ANSI / -A)
#include <windows.h>

RPC_STATUS RpcServerInterfaceGroupCreateA(
    RPC_INTERFACE_TEMPLATEA* Interfaces,
    DWORD NumIfs,
    RPC_ENDPOINT_TEMPLATEA* Endpoints,
    DWORD NumEndpoints,
    DWORD IdlePeriod,
    RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN IdleCallbackFn,
    void* IdleCallbackContext,
    void** IfGroup
);

パラメーター

名前	型	方向	説明
Interfaces	RPC_INTERFACE_TEMPLATEA*	in	インターフェイスグループが公開するインターフェイスを定義する RPC_INTERFACE_TEMPLATE 構造体の配列へのポインター。
NumIfs	DWORD	in	Interfaces の要素数。
Endpoints	RPC_ENDPOINT_TEMPLATEA*	in	インターフェイスグループが使用するエンドポイントを定義する RPC_ENDPOINT_TEMPLATE 構造体の配列へのポインター。
NumEndpoints	DWORD	in	Endpoints の要素数。
IdlePeriod	DWORD	in	インターフェイスグループがアイドル状態になってから、RPC ランタイムがアイドルコールバックを呼び出すまでに待機する時間 (秒単位)。0 の場合、コールバックは直ちに呼び出されます。INFINITE は、サーバーアプリケーションがインターフェイスグループのアイドル状態を考慮しないことを意味します。
IdleCallbackFn	RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN	in	IdlePeriod で指定された時間だけインターフェイスグループがアイドル状態になったときに RPC ランタイムが呼び出す RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN コールバック。NULL を指定できるのは、IdlePeriod が INFINITE の場合のみです。
IdleCallbackContext	void*	in	IdleCallbackFn のアイドルコールバックに渡される、ユーザー定義のポインター。
IfGroup	void**	out	成功した場合、新しく作成されたインターフェイスグループのハンドルを受け取る RPC_INTERFACE_GROUP バッファーへのポインター。この関数が失敗した場合、IfGroup は不定です。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcServerInterfaceGroupCreate 関数は、サーバーアプリケーション用の RPC サーバーインターフェイスグループを作成します。(RpcServerInterfaceGroupCreateA)

戻り値

値	意味
RPC_S_OK	呼び出しに成功しました。

メモ有効なエラーコードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

サーバーアプリケーションは、インターフェイスグループがアイドル状態になったときに通知を受け取ることができます (省略可能)。この機能は任意のアプリケーションで利用できますが、主にサービスをアイドル時に停止させたいサービス開発者を対象としています。

IdlePeriod は、アイドル状態が短時間で変化する場合に RPC ランタイムが大量の通知を生成することを防ぎ、トリガー起動されるサービスの場合には、サービスが不必要に開始と停止を繰り返すことを回避します。開発者はこの値を選択する際に、サービスの初期化と終了のコスト、新しい処理が発生すると予想される頻度、およびサービスをアイドル状態のまま維持するコストを考慮する必要があります。アイドル期間を短くすると、新しいクライアントの処理が発生するたびにサービスが頻繁に開始と停止を繰り返し、逆にアイドル期間を長くすると、意味のある処理を行わないままサービスがリソースを消費することになります。

インターフェイスグループ内のインターフェイスは、同じグループのエンドポイント経由でのみ呼び出すことができます。インターフェイスグループに属していないインターフェイスは、グループに属するエンドポイント経由で呼び出すことはできません。

RPC サーバーの処理は、必ずしもサーバーアプリケーションから見えるとは限りません。場合によっては、クライアントがサーバーへの接続を開いているというだけで、長時間にわたって呼び出しがディスパッチされていなくてもアクティブな状態が維持されることがあります。サーバーアプリケーションは、RPC ランタイムがグループをアイドルと判断することと、最後に呼び出しがディスパッチされてからの経過時間との間に、いかなる相関関係も想定してはなりません。

メモ

rpcdce.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RpcServerInterfaceGroupCreate を定義しています。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// RPCRT4.dll  (ANSI / -A)
#include <windows.h>

RPC_STATUS RpcServerInterfaceGroupCreateA(
    RPC_INTERFACE_TEMPLATEA* Interfaces,
    DWORD NumIfs,
    RPC_ENDPOINT_TEMPLATEA* Endpoints,
    DWORD NumEndpoints,
    DWORD IdlePeriod,
    RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN IdleCallbackFn,
    void* IdleCallbackContext,
    void** IfGroup
);

[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RpcServerInterfaceGroupCreateA(
    IntPtr Interfaces,   // RPC_INTERFACE_TEMPLATEA*
    uint NumIfs,   // DWORD
    IntPtr Endpoints,   // RPC_ENDPOINT_TEMPLATEA*
    uint NumEndpoints,   // DWORD
    uint IdlePeriod,   // DWORD
    IntPtr IdleCallbackFn,   // RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN
    IntPtr IdleCallbackContext,   // void*
    IntPtr IfGroup   // void** out
);

<DllImport("RPCRT4.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RpcServerInterfaceGroupCreateA(
    Interfaces As IntPtr,   ' RPC_INTERFACE_TEMPLATEA*
    NumIfs As UInteger,   ' DWORD
    Endpoints As IntPtr,   ' RPC_ENDPOINT_TEMPLATEA*
    NumEndpoints As UInteger,   ' DWORD
    IdlePeriod As UInteger,   ' DWORD
    IdleCallbackFn As IntPtr,   ' RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN
    IdleCallbackContext As IntPtr,   ' void*
    IfGroup As IntPtr   ' void** out
) As Integer
End Function

' Interfaces : RPC_INTERFACE_TEMPLATEA*
' NumIfs : DWORD
' Endpoints : RPC_ENDPOINT_TEMPLATEA*
' NumEndpoints : DWORD
' IdlePeriod : DWORD
' IdleCallbackFn : RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN
' IdleCallbackContext : void*
' IfGroup : void** out
Declare PtrSafe Function RpcServerInterfaceGroupCreateA Lib "rpcrt4" ( _
    ByVal Interfaces As LongPtr, _
    ByVal NumIfs As Long, _
    ByVal Endpoints As LongPtr, _
    ByVal NumEndpoints As Long, _
    ByVal IdlePeriod As Long, _
    ByVal IdleCallbackFn As LongPtr, _
    ByVal IdleCallbackContext As LongPtr, _
    ByVal IfGroup As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcServerInterfaceGroupCreateA = ctypes.windll.rpcrt4.RpcServerInterfaceGroupCreateA
RpcServerInterfaceGroupCreateA.restype = ctypes.c_int
RpcServerInterfaceGroupCreateA.argtypes = [
    ctypes.c_void_p,  # Interfaces : RPC_INTERFACE_TEMPLATEA*
    wintypes.DWORD,  # NumIfs : DWORD
    ctypes.c_void_p,  # Endpoints : RPC_ENDPOINT_TEMPLATEA*
    wintypes.DWORD,  # NumEndpoints : DWORD
    wintypes.DWORD,  # IdlePeriod : DWORD
    ctypes.c_void_p,  # IdleCallbackFn : RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN
    ctypes.POINTER(None),  # IdleCallbackContext : void*
    ctypes.c_void_p,  # IfGroup : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcServerInterfaceGroupCreateA = Fiddle::Function.new(
  lib['RpcServerInterfaceGroupCreateA'],
  [
    Fiddle::TYPE_VOIDP,  # Interfaces : RPC_INTERFACE_TEMPLATEA*
    -Fiddle::TYPE_INT,  # NumIfs : DWORD
    Fiddle::TYPE_VOIDP,  # Endpoints : RPC_ENDPOINT_TEMPLATEA*
    -Fiddle::TYPE_INT,  # NumEndpoints : DWORD
    -Fiddle::TYPE_INT,  # IdlePeriod : DWORD
    Fiddle::TYPE_VOIDP,  # IdleCallbackFn : RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN
    Fiddle::TYPE_VOIDP,  # IdleCallbackContext : void*
    Fiddle::TYPE_VOIDP,  # IfGroup : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcrt4")]
extern "system" {
    fn RpcServerInterfaceGroupCreateA(
        Interfaces: *mut RPC_INTERFACE_TEMPLATEA,  // RPC_INTERFACE_TEMPLATEA*
        NumIfs: u32,  // DWORD
        Endpoints: *mut RPC_ENDPOINT_TEMPLATEA,  // RPC_ENDPOINT_TEMPLATEA*
        NumEndpoints: u32,  // DWORD
        IdlePeriod: u32,  // DWORD
        IdleCallbackFn: *const core::ffi::c_void,  // RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN
        IdleCallbackContext: *mut (),  // void*
        IfGroup: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi)]
public static extern int RpcServerInterfaceGroupCreateA(IntPtr Interfaces, uint NumIfs, IntPtr Endpoints, uint NumEndpoints, uint IdlePeriod, IntPtr IdleCallbackFn, IntPtr IdleCallbackContext, IntPtr IfGroup);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcServerInterfaceGroupCreateA' -Namespace Win32 -PassThru
# $api::RpcServerInterfaceGroupCreateA(Interfaces, NumIfs, Endpoints, NumEndpoints, IdlePeriod, IdleCallbackFn, IdleCallbackContext, IfGroup)

#uselib "RPCRT4.dll"
#func global RpcServerInterfaceGroupCreateA "RpcServerInterfaceGroupCreateA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; RpcServerInterfaceGroupCreateA varptr(Interfaces), NumIfs, varptr(Endpoints), NumEndpoints, IdlePeriod, IdleCallbackFn, IdleCallbackContext, IfGroup   ; 戻り値は stat
; Interfaces : RPC_INTERFACE_TEMPLATEA* -> "sptr"
; NumIfs : DWORD -> "sptr"
; Endpoints : RPC_ENDPOINT_TEMPLATEA* -> "sptr"
; NumEndpoints : DWORD -> "sptr"
; IdlePeriod : DWORD -> "sptr"
; IdleCallbackFn : RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN -> "sptr"
; IdleCallbackContext : void* -> "sptr"
; IfGroup : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCRT4.dll"
#cfunc global RpcServerInterfaceGroupCreateA "RpcServerInterfaceGroupCreateA" var, int, var, int, int, sptr, sptr, sptr
; res = RpcServerInterfaceGroupCreateA(Interfaces, NumIfs, Endpoints, NumEndpoints, IdlePeriod, IdleCallbackFn, IdleCallbackContext, IfGroup)
; Interfaces : RPC_INTERFACE_TEMPLATEA* -> "var"
; NumIfs : DWORD -> "int"
; Endpoints : RPC_ENDPOINT_TEMPLATEA* -> "var"
; NumEndpoints : DWORD -> "int"
; IdlePeriod : DWORD -> "int"
; IdleCallbackFn : RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN -> "sptr"
; IdleCallbackContext : void* -> "sptr"
; IfGroup : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCRT4.dll"
#cfunc global RpcServerInterfaceGroupCreateA "RpcServerInterfaceGroupCreateA" sptr, int, sptr, int, int, sptr, sptr, sptr
; res = RpcServerInterfaceGroupCreateA(varptr(Interfaces), NumIfs, varptr(Endpoints), NumEndpoints, IdlePeriod, IdleCallbackFn, IdleCallbackContext, IfGroup)
; Interfaces : RPC_INTERFACE_TEMPLATEA* -> "sptr"
; NumIfs : DWORD -> "int"
; Endpoints : RPC_ENDPOINT_TEMPLATEA* -> "sptr"
; NumEndpoints : DWORD -> "int"
; IdlePeriod : DWORD -> "int"
; IdleCallbackFn : RPC_INTERFACE_GROUP_IDLE_CALLBACK_FN -> "sptr"
; IdleCallbackContext : void* -> "sptr"
; IfGroup : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。