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

RpcServerUseProtseqA

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

シグネチャ

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

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

パラメーター

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

戻り値の型: RPC_STATUS

公式ドキュメント

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

戻り値

説明
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)

サーバーアプリケーションは RpcServerUseProtseq を呼び出して、1 つのプロトコルシーケンスを RPC ランタイムライブラリに登録します。リモートプロシージャ呼び出しの要求を受信するには、サーバーは少なくとも 1 つのプロトコルシーケンスを RPC ランタイムライブラリに登録する必要があります。サーバーアプリケーションは RpcServerUseProtseq を複数回呼び出して、追加のプロトコルシーケンスを登録できます。詳細については、 String Binding および Server-Side Binding を参照してください。

サーバーが登録したプロトコルシーケンスごとに、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 関数を呼び出すことで取得できます。

詳細については、 Server-Side Binding を参照してください。すべてのプロトコルシーケンスを登録するには、サーバーは RpcServerUseAllProtseqs を呼び出します。

メモ

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

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

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

var (
	rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
	procRpcServerUseProtseqA = rpcrt4.NewProc("RpcServerUseProtseqA")
)

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

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

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

let rpcserveruseprotseqa =
  foreign "RpcServerUseProtseqA"
    (string @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* Protseq : LPSTR -> string *)
(* MaxCalls : DWORD -> uint32_t *)
(* 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 ("RpcServerUseProtseqA" rpc-server-use-protseq-a :convention :stdcall) :int32
  (protseq :string)   ; LPSTR
  (max-calls :uint32)   ; DWORD
  (security-descriptor :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RpcServerUseProtseqA = Win32::API::More->new('RPCRT4',
    'int RpcServerUseProtseqA(LPCSTR Protseq, DWORD MaxCalls, LPVOID SecurityDescriptor)');
# my $ret = $RpcServerUseProtseqA->Call($Protseq, $MaxCalls, $SecurityDescriptor);
# Protseq : LPSTR -> LPCSTR
# MaxCalls : DWORD -> DWORD
# SecurityDescriptor : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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