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

RpcServerUseProtseqEpA

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

シグネチャ

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

RPC_STATUS RpcServerUseProtseqEpA(
    LPSTR Protseq,
    DWORD MaxCalls,
    LPSTR Endpoint,
    void* SecurityDescriptor   // optional
);

パラメーター

名前方向説明
ProtseqLPSTRinRPC ランタイム ライブラリに登録するプロトコル シーケンスの文字列識別子へのポインター。
MaxCallsDWORDinncacn_ip_tcp プロトコル シーケンスのバックログ キューの長さ。その他のプロトコル シーケンスでは、このパラメーターは無視されます。既定値を指定するには RPC_C_PROTSEQ_MAX_REQS_DEFAULT を使用します。「解説」を参照してください。
EndpointLPSTRinProtseq パラメーターで指定されたプロトコル シーケンスのバインドを作成する際に使用する、エンドポイント アドレス情報へのポインター。
SecurityDescriptorvoid*inoptionalセキュリティ サブシステムのために用意された省略可能なパラメーターへのポインター。ncacn_np および ncalrpc プロトコル シーケンスでのみ使用されます。その他のプロトコル シーケンスでは、このパラメーターは無視されます。サーバーを保護する目的でエンドポイントにセキュリティ記述子を使用することは推奨されません。このパラメーターは、この API の DCE 仕様には存在しません。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcServerUseProtseqEp 関数は、指定されたプロトコル シーケンスと指定されたエンドポイントを組み合わせてリモート プロシージャ コールを受信するように、RPC ランタイム ライブラリに指示します。(RpcServerUseProtseqEpA)

戻り値

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

解説(Remarks)

サーバー アプリケーションは RpcServerUseProtseqEp を呼び出して、1 つのプロトコル シーケンスを RPC ランタイム ライブラリに登録します。プロトコル シーケンスを登録するたびに、 RpcServerUseProtseqEp は指定されたエンドポイント アドレス情報も併せて登録します。

リモート プロシージャ コール要求を受信するには、サーバーは少なくとも 1 つのプロトコル シーケンスを RPC ランタイム ライブラリに登録する必要があります。サーバー アプリケーションは、このルーチンを複数回呼び出して、追加のプロトコル シーケンスとエンドポイントを登録できます。サーバーが登録した各プロトコル シーケンスに対して、RPC ランタイム ライブラリは、サーバーがリモート プロシージャ コール要求を受信するためのエンドポイントを 1 つ以上作成します。RPC ランタイム ライブラリは、プロトコル シーケンスごとに異なるエンドポイントを作成します。ただし、プロセス内の各インターフェイスには、いずれのエンドポイントからでもアクセスできます。詳細については、「Writing a Secure RPC Client or Server」を参照してください。

MaxCalls についてアプリケーションが指定する値は、あくまでヒントにすぎません。RPC ランタイムまたは Windows ソケット プロバイダーがこの値を上書きすることがあります。たとえば、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 の適切な値を決定する際に、メモリ使用量とスケーラビリティ要件のバランスを取る必要があります。

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

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

メモ

rpcdce.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RpcServerUseProtseqEp を定義しています。このエンコード中立のエイリアスを、エンコード中立でないコードと混在させて使用すると、不一致が生じてコンパイル エラーや実行時エラーの原因となることがあります。詳細については、「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 RpcServerUseProtseqEpA(
    LPSTR Protseq,
    DWORD MaxCalls,
    LPSTR Endpoint,
    void* SecurityDescriptor   // optional
);
[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RpcServerUseProtseqEpA(
    [MarshalAs(UnmanagedType.LPStr)] string Protseq,   // LPSTR
    uint MaxCalls,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string Endpoint,   // LPSTR
    IntPtr SecurityDescriptor   // void* optional
);
<DllImport("RPCRT4.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RpcServerUseProtseqEpA(
    <MarshalAs(UnmanagedType.LPStr)> Protseq As String,   ' LPSTR
    MaxCalls As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> Endpoint As String,   ' LPSTR
    SecurityDescriptor As IntPtr   ' void* optional
) As Integer
End Function
' Protseq : LPSTR
' MaxCalls : DWORD
' Endpoint : LPSTR
' SecurityDescriptor : void* optional
Declare PtrSafe Function RpcServerUseProtseqEpA Lib "rpcrt4" ( _
    ByVal Protseq As String, _
    ByVal MaxCalls As Long, _
    ByVal Endpoint As String, _
    ByVal SecurityDescriptor As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('RPCRT4.dll')
RpcServerUseProtseqEpA = Fiddle::Function.new(
  lib['RpcServerUseProtseqEpA'],
  [
    Fiddle::TYPE_VOIDP,  # Protseq : LPSTR
    -Fiddle::TYPE_INT,  # MaxCalls : DWORD
    Fiddle::TYPE_VOIDP,  # Endpoint : LPSTR
    Fiddle::TYPE_VOIDP,  # SecurityDescriptor : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "rpcrt4")]
extern "system" {
    fn RpcServerUseProtseqEpA(
        Protseq: *mut u8,  // LPSTR
        MaxCalls: u32,  // DWORD
        Endpoint: *mut u8,  // LPSTR
        SecurityDescriptor: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi)]
public static extern int RpcServerUseProtseqEpA([MarshalAs(UnmanagedType.LPStr)] string Protseq, uint MaxCalls, [MarshalAs(UnmanagedType.LPStr)] string Endpoint, IntPtr SecurityDescriptor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcServerUseProtseqEpA' -Namespace Win32 -PassThru
# $api::RpcServerUseProtseqEpA(Protseq, MaxCalls, Endpoint, SecurityDescriptor)
#uselib "RPCRT4.dll"
#func global RpcServerUseProtseqEpA "RpcServerUseProtseqEpA" sptr, sptr, sptr, sptr
; RpcServerUseProtseqEpA Protseq, MaxCalls, Endpoint, SecurityDescriptor   ; 戻り値は stat
; Protseq : LPSTR -> "sptr"
; MaxCalls : DWORD -> "sptr"
; Endpoint : LPSTR -> "sptr"
; SecurityDescriptor : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RPCRT4.dll"
#cfunc global RpcServerUseProtseqEpA "RpcServerUseProtseqEpA" str, int, str, sptr
; res = RpcServerUseProtseqEpA(Protseq, MaxCalls, Endpoint, SecurityDescriptor)
; Protseq : LPSTR -> "str"
; MaxCalls : DWORD -> "int"
; Endpoint : LPSTR -> "str"
; SecurityDescriptor : void* optional -> "sptr"
; RPC_STATUS RpcServerUseProtseqEpA(LPSTR Protseq, DWORD MaxCalls, LPSTR Endpoint, void* SecurityDescriptor)
#uselib "RPCRT4.dll"
#cfunc global RpcServerUseProtseqEpA "RpcServerUseProtseqEpA" str, int, str, intptr
; res = RpcServerUseProtseqEpA(Protseq, MaxCalls, Endpoint, SecurityDescriptor)
; Protseq : LPSTR -> "str"
; MaxCalls : DWORD -> "int"
; Endpoint : LPSTR -> "str"
; SecurityDescriptor : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
	procRpcServerUseProtseqEpA = rpcrt4.NewProc("RpcServerUseProtseqEpA")
)

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

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

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

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

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

(cffi:defcfun ("RpcServerUseProtseqEpA" rpc-server-use-protseq-ep-a :convention :stdcall) :int32
  (protseq :string)   ; LPSTR
  (max-calls :uint32)   ; DWORD
  (endpoint :string)   ; LPSTR
  (security-descriptor :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RpcServerUseProtseqEpA = Win32::API::More->new('RPCRT4',
    'int RpcServerUseProtseqEpA(LPCSTR Protseq, DWORD MaxCalls, LPCSTR Endpoint, LPVOID SecurityDescriptor)');
# my $ret = $RpcServerUseProtseqEpA->Call($Protseq, $MaxCalls, $Endpoint, $SecurityDescriptor);
# Protseq : LPSTR -> LPCSTR
# MaxCalls : DWORD -> DWORD
# Endpoint : LPSTR -> LPCSTR
# SecurityDescriptor : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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