Win32 API 日本語リファレンス
ホームSystem.Rpc › RpcServerUseAllProtseqsIfEx

RpcServerUseAllProtseqsIfEx

関数
ポリシーとインターフェイス指定で全プロトコルを登録する。
DLLRPCRT4.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

RPC_STATUS RpcServerUseAllProtseqsIfEx(
    DWORD MaxCalls,
    void* IfSpec,
    void* SecurityDescriptor,   // optional
    RPC_POLICY* Policy
);

パラメーター

名前方向説明
MaxCallsDWORDinncacn_ip_tcp プロトコル シーケンスのバックログ キューの長さ。他のすべてのプロトコル シーケンスでは、このパラメーターは無視されます。既定値を指定するには RPC_C_PROTSEQ_MAX_REQS_DEFAULT を使用します。「解説」を参照してください。
IfSpecvoid*inバインディング ハンドルの作成に使用する、プロトコル シーケンスと対応するエンドポイント情報を含むインターフェイス。
SecurityDescriptorvoid*inoptionalセキュリティ サブシステム用に提供される省略可能なパラメーターへのポインター。ncacn_np および ncalrpc プロトコル シーケンスでのみ使用されます。他のすべてのプロトコル シーケンスでは、このパラメーターは無視されます。サーバーを保護する目的でエンドポイントにセキュリティ記述子を使用することは推奨されません。このパラメーターは、この API の DCE 仕様には存在しません。
PolicyRPC_POLICY*inRPC_POLICY 構造体へのポインター。この構造体には、動的ポートのポート割り当てを制限し、マルチホーム コンピューターがネットワーク インターフェイス カードに選択的にバインドできるようにするためのフラグが含まれます。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcServerUseAllProtseqsIfEx 関数は、リモート プロシージャ コールを受信するために、インターフェイス仕様に含まれるすべてのプロトコル シーケンスとエンドポイントを使用するよう RPC ランタイム ライブラリに指示します。

戻り値

意味
RPC_S_OK
呼び出しが成功しました。
RPC_S_NO_PROTSEQS
サポートされているプロトコル シーケンスがありません。
RPC_S_INVALID_ENDPOINT_FORMAT
エンドポイントの形式が無効です。
RPC_S_OUT_OF_MEMORY
システムのメモリが不足しています。
RPC_S_DUPLICATE_ENDPOINT
エンドポイントが重複しています。
RPC_S_INVALID_SECURITY_DESC
セキュリティ記述子が無効です。
RPC_S_INVALID_RPC_PROTSEQ
RPC プロトコル シーケンスが無効です。
メモ 有効なエラー コードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

メモ サポートされているすべてのプロトコル シーケンスでリッスンすることは推奨されません。主流ではないプロトコル シーケンスも含め、すべてのプロトコル シーケンスでサーバーがリッスンすることになるためです。サーバーは 主流の プロトコル シーケンスのみでリッスンすることをお勧めします。
RpcServerUseAllProtseqsIfEx のパラメーターと効果は、 RpcServerUseAllProtseqsIf のものを包含します。異なるのは Policy フィールドで、これにより動的ポートのポート割り当てを制限し、マルチホーム コンピューターがネットワーク インターフェイス カードに選択的にバインドできるようになります。

RPC_POLICY 構造体の NICFlags フィールドを 0 に設定すると、この拡張関数は元の RpcServerUseAllProtseqsIfEx と機能的に同等になり、サーバーはシステム レジストリの設定に基づいて NIC にバインドします。レジストリ設定によってインターネットおよびイントラネットで使用可能なポートがどのように定義されるかについては、 Configuring the Registry for Port Allocations and Selective Binding を参照してください。

メモ Policy フィールドのフラグ設定は、ncacn_ip_tcp または ncadg_ip_udp プロトコル シーケンスを使用している場合にのみ有効です。他のすべてのプロトコル シーケンスでは、RPC ランタイムはこれらの値を無視します。
サーバー アプリケーションは RpcServerUseAllProtseqsIfEx を呼び出して、IDL ファイルで指定されたすべてのプロトコル シーケンスと、それに関連付けられたエンドポイント アドレス情報を RPC ランタイム ライブラリに登録します。

リモート プロシージャ コール要求を受信するには、サーバーは少なくとも 1 つのプロトコル シーケンスを RPC ランタイム ライブラリに登録する必要があります。サーバーが登録した各プロトコル シーケンスについて、RPC ランタイム ライブラリは、サーバーがリモート プロシージャ コール要求を受信するための 1 つ以上のエンドポイントを作成します。RPC ランタイム ライブラリは、プロトコル シーケンスごとに異なるエンドポイントを作成します。

メモ RpcServerUseAllProtseqsIfEx 関数を使用しても、サーバーは次のプロトコル シーケンスではリッスンしません。
メモ これらのプロトコル シーケンスでリッスンするには、各シーケンスを個別に選択する必要があります。
MaxCalls については、アプリケーションが指定する値はヒントにすぎません。RPC ランタイムまたは Windows Sockets プロバイダーが値を上書きすることがあります。たとえば、Windows XP または Windows 2000 Professional では値は 5 に制限されます。5 より大きい値は無視され、代わりに 5 が使用されます。Windows Server 2003 および Windows 2000 Server では、指定した値が尊重されます。

アプリケーションは MaxCalls に妥当な値を渡すよう注意する必要があります。Server、Advanced Server、または Datacenter Server で大きな値を指定すると、大量の非ページ プール メモリが使用される可能性があります。一方、小さすぎる値も好ましくありません。バックログ キューが枯渇すると、TCP SYN パケットに対してサーバーから TCP RST が返される場合があるためです。アプリケーション開発者は、MaxCalls の適切な値を決定する際に、メモリ使用量とスケーラビリティの要件のバランスを取る必要があります。

コンピューターが選択的バインドを使用するように構成されている場合、呼び出しが成功しても、コンピューター上に存在するすべてのネットワーク インターフェイスに対してサーバーがエンドポイントを作成したことは保証されません。選択的バインドの設定によっては、RPC ランタイムが一部のネットワーク インターフェイスでリッスンしないことがあります。さらに、インターフェイスが DHCP による IP アドレスをまだ受け取っていない場合、RPC サーバーは DHCP アドレスが割り当てられるまでそのネットワーク インターフェイスでリッスンしません。呼び出しの成功は、サーバーが少なくとも 1 つのネットワーク インターフェイスでリッスンしていることを意味します。リモート プロシージャ コールを受信できるバインディング ハンドルの完全な一覧は、RpcServerInqBindings 関数を呼び出すことで取得できます。

IDL ファイルで指定されたプロトコル シーケンスのうち選択したものを登録するには、サーバーは RpcServerUseProtseqIfEx を呼び出します。詳細については、 Server-Side Binding を参照してください。

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

各言語での呼び出し定義

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

RPC_STATUS RpcServerUseAllProtseqsIfEx(
    DWORD MaxCalls,
    void* IfSpec,
    void* SecurityDescriptor,   // optional
    RPC_POLICY* Policy
);
[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern int RpcServerUseAllProtseqsIfEx(
    uint MaxCalls,   // DWORD
    IntPtr IfSpec,   // void*
    IntPtr SecurityDescriptor,   // void* optional
    IntPtr Policy   // RPC_POLICY*
);
<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Function RpcServerUseAllProtseqsIfEx(
    MaxCalls As UInteger,   ' DWORD
    IfSpec As IntPtr,   ' void*
    SecurityDescriptor As IntPtr,   ' void* optional
    Policy As IntPtr   ' RPC_POLICY*
) As Integer
End Function
' MaxCalls : DWORD
' IfSpec : void*
' SecurityDescriptor : void* optional
' Policy : RPC_POLICY*
Declare PtrSafe Function RpcServerUseAllProtseqsIfEx Lib "rpcrt4" ( _
    ByVal MaxCalls As Long, _
    ByVal IfSpec As LongPtr, _
    ByVal SecurityDescriptor As LongPtr, _
    ByVal Policy As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RpcServerUseAllProtseqsIfEx = ctypes.windll.rpcrt4.RpcServerUseAllProtseqsIfEx
RpcServerUseAllProtseqsIfEx.restype = ctypes.c_int
RpcServerUseAllProtseqsIfEx.argtypes = [
    wintypes.DWORD,  # MaxCalls : DWORD
    ctypes.POINTER(None),  # IfSpec : void*
    ctypes.POINTER(None),  # SecurityDescriptor : void* optional
    ctypes.c_void_p,  # Policy : RPC_POLICY*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
	procRpcServerUseAllProtseqsIfEx = rpcrt4.NewProc("RpcServerUseAllProtseqsIfEx")
)

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

extern "rpcrt4" fn RpcServerUseAllProtseqsIfEx(
    MaxCalls: u32, // DWORD
    IfSpec: ?*anyopaque, // void*
    SecurityDescriptor: ?*anyopaque, // void* optional
    Policy: [*c]RPC_POLICY // RPC_POLICY*
) callconv(std.os.windows.WINAPI) i32;
proc RpcServerUseAllProtseqsIfEx(
    MaxCalls: uint32,  # DWORD
    IfSpec: pointer,  # void*
    SecurityDescriptor: pointer,  # void* optional
    Policy: ptr RPC_POLICY  # RPC_POLICY*
): int32 {.importc: "RpcServerUseAllProtseqsIfEx", stdcall, dynlib: "RPCRT4.dll".}
pragma(lib, "rpcrt4");
extern(Windows)
int RpcServerUseAllProtseqsIfEx(
    uint MaxCalls,   // DWORD
    void* IfSpec,   // void*
    void* SecurityDescriptor,   // void* optional
    RPC_POLICY* Policy   // RPC_POLICY*
);
ccall((:RpcServerUseAllProtseqsIfEx, "RPCRT4.dll"), stdcall, Int32,
      (UInt32, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{RPC_POLICY}),
      MaxCalls, IfSpec, SecurityDescriptor, Policy)
# MaxCalls : DWORD -> UInt32
# IfSpec : void* -> Ptr{Cvoid}
# SecurityDescriptor : void* optional -> Ptr{Cvoid}
# Policy : RPC_POLICY* -> Ptr{RPC_POLICY}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t RpcServerUseAllProtseqsIfEx(
    uint32_t MaxCalls,
    void* IfSpec,
    void* SecurityDescriptor,
    void* Policy);
]]
local rpcrt4 = ffi.load("rpcrt4")
-- rpcrt4.RpcServerUseAllProtseqsIfEx(MaxCalls, IfSpec, SecurityDescriptor, Policy)
-- MaxCalls : DWORD
-- IfSpec : void*
-- SecurityDescriptor : void* optional
-- Policy : RPC_POLICY*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('RPCRT4.dll');
const RpcServerUseAllProtseqsIfEx = lib.func('__stdcall', 'RpcServerUseAllProtseqsIfEx', 'int32_t', ['uint32_t', 'void *', 'void *', 'void *']);
// RpcServerUseAllProtseqsIfEx(MaxCalls, IfSpec, SecurityDescriptor, Policy)
// MaxCalls : DWORD -> 'uint32_t'
// IfSpec : void* -> 'void *'
// SecurityDescriptor : void* optional -> 'void *'
// Policy : RPC_POLICY* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("RPCRT4.dll", {
  RpcServerUseAllProtseqsIfEx: { parameters: ["u32", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.RpcServerUseAllProtseqsIfEx(MaxCalls, IfSpec, SecurityDescriptor, Policy)
// MaxCalls : DWORD -> "u32"
// IfSpec : void* -> "pointer"
// SecurityDescriptor : void* optional -> "pointer"
// Policy : RPC_POLICY* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RpcServerUseAllProtseqsIfEx(
    uint32_t MaxCalls,
    void* IfSpec,
    void* SecurityDescriptor,
    void* Policy);
C, "RPCRT4.dll");
// $ffi->RpcServerUseAllProtseqsIfEx(MaxCalls, IfSpec, SecurityDescriptor, Policy);
// MaxCalls : DWORD
// IfSpec : void*
// SecurityDescriptor : void* optional
// Policy : RPC_POLICY*
// 構造体/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 Rpcrt4 extends StdCallLibrary {
    Rpcrt4 INSTANCE = Native.load("rpcrt4", Rpcrt4.class);
    int RpcServerUseAllProtseqsIfEx(
        int MaxCalls,   // DWORD
        Pointer IfSpec,   // void*
        Pointer SecurityDescriptor,   // void* optional
        Pointer Policy   // RPC_POLICY*
    );
}
@[Link("rpcrt4")]
lib LibRPCRT4
  fun RpcServerUseAllProtseqsIfEx = RpcServerUseAllProtseqsIfEx(
    MaxCalls : UInt32,   # DWORD
    IfSpec : Void*,   # void*
    SecurityDescriptor : Void*,   # void* optional
    Policy : RPC_POLICY*   # RPC_POLICY*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RpcServerUseAllProtseqsIfExNative = Int32 Function(Uint32, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef RpcServerUseAllProtseqsIfExDart = int Function(int, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final RpcServerUseAllProtseqsIfEx = DynamicLibrary.open('RPCRT4.dll')
    .lookupFunction<RpcServerUseAllProtseqsIfExNative, RpcServerUseAllProtseqsIfExDart>('RpcServerUseAllProtseqsIfEx');
// MaxCalls : DWORD -> Uint32
// IfSpec : void* -> Pointer<Void>
// SecurityDescriptor : void* optional -> Pointer<Void>
// Policy : RPC_POLICY* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RpcServerUseAllProtseqsIfEx(
  MaxCalls: DWORD;   // DWORD
  IfSpec: Pointer;   // void*
  SecurityDescriptor: Pointer;   // void* optional
  Policy: Pointer   // RPC_POLICY*
): Integer; stdcall;
  external 'RPCRT4.dll' name 'RpcServerUseAllProtseqsIfEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RpcServerUseAllProtseqsIfEx"
  c_RpcServerUseAllProtseqsIfEx :: Word32 -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- MaxCalls : DWORD -> Word32
-- IfSpec : void* -> Ptr ()
-- SecurityDescriptor : void* optional -> Ptr ()
-- Policy : RPC_POLICY* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rpcserveruseallprotseqsifex =
  foreign "RpcServerUseAllProtseqsIfEx"
    (uint32_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* MaxCalls : DWORD -> uint32_t *)
(* IfSpec : void* -> (ptr void) *)
(* SecurityDescriptor : void* optional -> (ptr void) *)
(* Policy : RPC_POLICY* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rpcrt4 (t "RPCRT4.dll"))
(cffi:use-foreign-library rpcrt4)

(cffi:defcfun ("RpcServerUseAllProtseqsIfEx" rpc-server-use-all-protseqs-if-ex :convention :stdcall) :int32
  (max-calls :uint32)   ; DWORD
  (if-spec :pointer)   ; void*
  (security-descriptor :pointer)   ; void* optional
  (policy :pointer))   ; RPC_POLICY*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RpcServerUseAllProtseqsIfEx = Win32::API::More->new('RPCRT4',
    'int RpcServerUseAllProtseqsIfEx(DWORD MaxCalls, LPVOID IfSpec, LPVOID SecurityDescriptor, LPVOID Policy)');
# my $ret = $RpcServerUseAllProtseqsIfEx->Call($MaxCalls, $IfSpec, $SecurityDescriptor, $Policy);
# MaxCalls : DWORD -> DWORD
# IfSpec : void* -> LPVOID
# SecurityDescriptor : void* optional -> LPVOID
# Policy : RPC_POLICY* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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