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

RpcServerUseProtseqExA

関数
ポリシー指定でプロトコルシーケンスを登録する(ANSI版)。
DLLRPCRT4.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

RPC_STATUS RpcServerUseProtseqExA(
    LPSTR Protseq,
    DWORD MaxCalls,
    void* SecurityDescriptor,   // optional
    RPC_POLICY* Policy
);

パラメーター

名前方向説明
ProtseqLPSTRinRPC ランタイムライブラリに登録するプロトコルシーケンスの文字列識別子へのポインター。
MaxCallsDWORDinncacn_ip_tcp プロトコルシーケンスのバックログキューの長さ。他のすべてのプロトコルシーケンスでは、このパラメーターは無視されます。既定値を指定するには RPC_C_PROTSEQ_MAX_REQS_DEFAULT を使用します。「解説」を参照してください。
SecurityDescriptorvoid*inoptionalWindows XP/2000/NT のセキュリティサブシステム向けに用意された省略可能なパラメーターへのポインター。ncacn_np および ncalrpc プロトコルシーケンスでのみ使用されます。他のすべてのプロトコルシーケンスでは、このパラメーターは無視されます。サーバーをセキュリティで保護する目的でエンドポイントにセキュリティ記述子を使用することは推奨されません。このパラメーターは、この API の DCE 仕様には含まれていません。
PolicyRPC_POLICY*inRPC_POLICY 構造体へのポインター。この構造体には、動的ポートのポート割り当てを制限し、マルチホームコンピューターがネットワークインターフェイスカードに選択的にバインドできるようにするためのフラグが含まれます。 RPC_POLICY 構造体を使用すると、呼び出し元は RPC ランタイムライブラリに対して、イントラネットポートとインターネットポートのどちらを使用するかなどを指示できます。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcServerUseProtseqEx 関数は、リモートプロシージャコールの受信に指定されたプロトコルシーケンスを使用するよう、RPC ランタイムライブラリに指示します。(RpcServerUseProtseqExA)

戻り値

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

解説(Remarks)

RpcServerUseProtseqEx のパラメーターと動作は、 RpcServerUseProtseq のものを包含しています。異なるのは Policy フィールドで、これにより動的ポートのポート割り当てを制限したり、マルチホームコンピューターがネットワークインターフェイスカードに選択的にバインドできるようになります。

RPC_POLICY 構造体の NICFlags フィールドを 0 に設定すると、この拡張関数は元の RpcServerUseProtseq と機能的に同等になり、サーバーはシステムレジストリの設定に基づいて NIC にバインドします。詳細については、 Configuring the Registry for Port Allocations and Selective Binding を参照してください。

メモ Policy フィールドのフラグ設定が有効になるのは、ncacn_ip_tcp または ncadg_ip_udp プロトコルシーケンスを使用している場合のみです。他のすべてのプロトコルシーケンスでは、RPC ランタイムはこれらの値を無視します。
サーバーアプリケーションは、1 つのプロトコルシーケンスを RPC ランタイムライブラリに登録するために RpcServerUseProtseqEx を呼び出します。リモートプロシージャコールの要求を受信するには、サーバーは少なくとも 1 つのプロトコルシーケンスを RPC ランタイムライブラリに登録する必要があります。サーバーアプリケーションは RpcServerUseProtseqEx を複数回呼び出して、追加のプロトコルシーケンスを登録できます。

サーバーが登録した各プロトコルシーケンスに対して、RPC ランタイムライブラリは、サーバーがリモートプロシージャコールの要求を受信するためのエンドポイントを 1 つ以上作成します。RPC ランタイムライブラリは、プロトコルシーケンスごとに異なるエンドポイントを作成します。エンドポイント名は、RPC ランタイムまたはオペレーティングシステムによって生成されます。たとえば ncacn_ip_tcp の場合、ポート番号は空き状況とレジストリの設定に応じて RPC ランタイムが動的に決定します。

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 アドレスをまだ受け取っていない場合、そのネットワークインターフェイスに DHCP アドレスが割り当てられるまで、RPC サーバーはそのインターフェイスで待ち受けを行いません。 成功した場合に保証されるのは、サーバーが少なくとも 1 つのネットワークインターフェイスで待ち受けを行っていることです。リモートプロシージャコールを受信できるバインディングハンドルの完全な一覧は、RpcServerInqBindings 関数を呼び出すことで取得できます。

すべてのプロトコルシーケンスを登録するには、サーバーは RpcServerUseAllProtseqsEx ルーチンを呼び出します。

詳細については、 Server-Side Binding を参照してください。

メモ

rpcdce.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RpcServerUseProtseqEx を定義しています。エンコード中立のエイリアスの使用と、エンコード中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因になる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RpcServerUseProtseqExA(
    LPSTR Protseq,
    DWORD MaxCalls,
    void* SecurityDescriptor,   // optional
    RPC_POLICY* Policy
);
[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RpcServerUseProtseqExA(
    [MarshalAs(UnmanagedType.LPStr)] string Protseq,   // LPSTR
    uint MaxCalls,   // DWORD
    IntPtr SecurityDescriptor,   // void* optional
    IntPtr Policy   // RPC_POLICY*
);
<DllImport("RPCRT4.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RpcServerUseProtseqExA(
    <MarshalAs(UnmanagedType.LPStr)> Protseq As String,   ' LPSTR
    MaxCalls As UInteger,   ' DWORD
    SecurityDescriptor As IntPtr,   ' void* optional
    Policy As IntPtr   ' RPC_POLICY*
) As Integer
End Function
' Protseq : LPSTR
' MaxCalls : DWORD
' SecurityDescriptor : void* optional
' Policy : RPC_POLICY*
Declare PtrSafe Function RpcServerUseProtseqExA Lib "rpcrt4" ( _
    ByVal Protseq As String, _
    ByVal MaxCalls As Long, _
    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

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

lib = Fiddle.dlopen('RPCRT4.dll')
RpcServerUseProtseqExA = Fiddle::Function.new(
  lib['RpcServerUseProtseqExA'],
  [
    Fiddle::TYPE_VOIDP,  # Protseq : LPSTR
    -Fiddle::TYPE_INT,  # MaxCalls : DWORD
    Fiddle::TYPE_VOIDP,  # SecurityDescriptor : void* optional
    Fiddle::TYPE_VOIDP,  # Policy : RPC_POLICY*
  ],
  Fiddle::TYPE_INT)
#[link(name = "rpcrt4")]
extern "system" {
    fn RpcServerUseProtseqExA(
        Protseq: *mut u8,  // LPSTR
        MaxCalls: u32,  // DWORD
        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", CharSet = CharSet.Ansi)]
public static extern int RpcServerUseProtseqExA([MarshalAs(UnmanagedType.LPStr)] string Protseq, uint MaxCalls, IntPtr SecurityDescriptor, IntPtr Policy);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcServerUseProtseqExA' -Namespace Win32 -PassThru
# $api::RpcServerUseProtseqExA(Protseq, MaxCalls, SecurityDescriptor, Policy)
#uselib "RPCRT4.dll"
#func global RpcServerUseProtseqExA "RpcServerUseProtseqExA" sptr, sptr, sptr, sptr
; RpcServerUseProtseqExA Protseq, MaxCalls, SecurityDescriptor, varptr(Policy)   ; 戻り値は stat
; Protseq : LPSTR -> "sptr"
; MaxCalls : DWORD -> "sptr"
; SecurityDescriptor : void* optional -> "sptr"
; Policy : RPC_POLICY* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "RPCRT4.dll"
#cfunc global RpcServerUseProtseqExA "RpcServerUseProtseqExA" str, int, sptr, var
; res = RpcServerUseProtseqExA(Protseq, MaxCalls, SecurityDescriptor, Policy)
; Protseq : LPSTR -> "str"
; MaxCalls : DWORD -> "int"
; SecurityDescriptor : void* optional -> "sptr"
; Policy : RPC_POLICY* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; RPC_STATUS RpcServerUseProtseqExA(LPSTR Protseq, DWORD MaxCalls, void* SecurityDescriptor, RPC_POLICY* Policy)
#uselib "RPCRT4.dll"
#cfunc global RpcServerUseProtseqExA "RpcServerUseProtseqExA" str, int, intptr, var
; res = RpcServerUseProtseqExA(Protseq, MaxCalls, SecurityDescriptor, Policy)
; Protseq : LPSTR -> "str"
; MaxCalls : DWORD -> "int"
; SecurityDescriptor : void* optional -> "intptr"
; Policy : RPC_POLICY* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
	procRpcServerUseProtseqExA = rpcrt4.NewProc("RpcServerUseProtseqExA")
)

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

extern "rpcrt4" fn RpcServerUseProtseqExA(
    Protseq: [*c]const u8, // LPSTR
    MaxCalls: u32, // DWORD
    SecurityDescriptor: ?*anyopaque, // void* optional
    Policy: [*c]RPC_POLICY // RPC_POLICY*
) callconv(std.os.windows.WINAPI) i32;
proc RpcServerUseProtseqExA(
    Protseq: cstring,  # LPSTR
    MaxCalls: uint32,  # DWORD
    SecurityDescriptor: pointer,  # void* optional
    Policy: ptr RPC_POLICY  # RPC_POLICY*
): int32 {.importc: "RpcServerUseProtseqExA", stdcall, dynlib: "RPCRT4.dll".}
pragma(lib, "rpcrt4");
extern(Windows)
int RpcServerUseProtseqExA(
    const(char)* Protseq,   // LPSTR
    uint MaxCalls,   // DWORD
    void* SecurityDescriptor,   // void* optional
    RPC_POLICY* Policy   // RPC_POLICY*
);
ccall((:RpcServerUseProtseqExA, "RPCRT4.dll"), stdcall, Int32,
      (Cstring, UInt32, Ptr{Cvoid}, Ptr{RPC_POLICY}),
      Protseq, MaxCalls, SecurityDescriptor, Policy)
# Protseq : LPSTR -> Cstring
# MaxCalls : DWORD -> UInt32
# SecurityDescriptor : void* optional -> Ptr{Cvoid}
# Policy : RPC_POLICY* -> Ptr{RPC_POLICY}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t RpcServerUseProtseqExA(
    const char* Protseq,
    uint32_t MaxCalls,
    void* SecurityDescriptor,
    void* Policy);
]]
local rpcrt4 = ffi.load("rpcrt4")
-- rpcrt4.RpcServerUseProtseqExA(Protseq, MaxCalls, SecurityDescriptor, Policy)
-- Protseq : LPSTR
-- MaxCalls : DWORD
-- SecurityDescriptor : void* optional
-- Policy : RPC_POLICY*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('RPCRT4.dll');
const RpcServerUseProtseqExA = lib.func('__stdcall', 'RpcServerUseProtseqExA', 'int32_t', ['str', 'uint32_t', 'void *', 'void *']);
// RpcServerUseProtseqExA(Protseq, MaxCalls, SecurityDescriptor, Policy)
// Protseq : LPSTR -> 'str'
// MaxCalls : DWORD -> 'uint32_t'
// SecurityDescriptor : void* optional -> 'void *'
// Policy : RPC_POLICY* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("RPCRT4.dll", {
  RpcServerUseProtseqExA: { parameters: ["buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.RpcServerUseProtseqExA(Protseq, MaxCalls, SecurityDescriptor, Policy)
// Protseq : LPSTR -> "buffer"
// MaxCalls : DWORD -> "u32"
// SecurityDescriptor : void* optional -> "pointer"
// Policy : RPC_POLICY* -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RpcServerUseProtseqExA(
    const char* Protseq,
    uint32_t MaxCalls,
    void* SecurityDescriptor,
    void* Policy);
C, "RPCRT4.dll");
// $ffi->RpcServerUseProtseqExA(Protseq, MaxCalls, SecurityDescriptor, Policy);
// Protseq : LPSTR
// MaxCalls : DWORD
// 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, W32APIOptions.ASCII_OPTIONS);
    int RpcServerUseProtseqExA(
        String Protseq,   // LPSTR
        int MaxCalls,   // DWORD
        Pointer SecurityDescriptor,   // void* optional
        Pointer Policy   // RPC_POLICY*
    );
}
@[Link("rpcrt4")]
lib LibRPCRT4
  fun RpcServerUseProtseqExA = RpcServerUseProtseqExA(
    Protseq : UInt8*,   # LPSTR
    MaxCalls : UInt32,   # DWORD
    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 RpcServerUseProtseqExANative = Int32 Function(Pointer<Utf8>, Uint32, Pointer<Void>, Pointer<Void>);
typedef RpcServerUseProtseqExADart = int Function(Pointer<Utf8>, int, Pointer<Void>, Pointer<Void>);
final RpcServerUseProtseqExA = DynamicLibrary.open('RPCRT4.dll')
    .lookupFunction<RpcServerUseProtseqExANative, RpcServerUseProtseqExADart>('RpcServerUseProtseqExA');
// Protseq : LPSTR -> Pointer<Utf8>
// MaxCalls : DWORD -> Uint32
// SecurityDescriptor : void* optional -> Pointer<Void>
// Policy : RPC_POLICY* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RpcServerUseProtseqExA(
  Protseq: PAnsiChar;   // LPSTR
  MaxCalls: DWORD;   // DWORD
  SecurityDescriptor: Pointer;   // void* optional
  Policy: Pointer   // RPC_POLICY*
): Integer; stdcall;
  external 'RPCRT4.dll' name 'RpcServerUseProtseqExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let rpcserveruseprotseqexa =
  foreign "RpcServerUseProtseqExA"
    (string @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* Protseq : LPSTR -> string *)
(* MaxCalls : DWORD -> uint32_t *)
(* 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 ("RpcServerUseProtseqExA" rpc-server-use-protseq-ex-a :convention :stdcall) :int32
  (protseq :string)   ; LPSTR
  (max-calls :uint32)   ; DWORD
  (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 $RpcServerUseProtseqExA = Win32::API::More->new('RPCRT4',
    'int RpcServerUseProtseqExA(LPCSTR Protseq, DWORD MaxCalls, LPVOID SecurityDescriptor, LPVOID Policy)');
# my $ret = $RpcServerUseProtseqExA->Call($Protseq, $MaxCalls, $SecurityDescriptor, $Policy);
# Protseq : LPSTR -> LPCSTR
# MaxCalls : DWORD -> DWORD
# SecurityDescriptor : void* optional -> LPVOID
# Policy : RPC_POLICY* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型