RpcServerUseProtseqIfW
関数シグネチャ
// RPCRT4.dll (Unicode / -W)
#include <windows.h>
RPC_STATUS RpcServerUseProtseqIfW(
LPWSTR Protseq,
DWORD MaxCalls,
void* IfSpec,
void* SecurityDescriptor // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Protseq | LPWSTR | in | RPC ランタイムライブラリに登録するプロトコルシーケンスの文字列識別子へのポインター。 |
| MaxCalls | DWORD | in | ncacn_ip_tcp プロトコルシーケンスのバックログキューの長さ。他のすべてのプロトコルシーケンスでは、このパラメーターは無視されます。既定値を指定するには RPC_C_PROTSEQ_MAX_REQS_DEFAULT を使用します。「解説」を参照してください。 |
| IfSpec | void* | in | Protseq パラメーターで指定したプロトコルシーケンスのバインドを作成する際に使用する、エンドポイント情報を含むインターフェイス。 |
| SecurityDescriptor | void* | inoptional | セキュリティサブシステム向けに用意された省略可能なパラメーターへのポインター。ncacn_np および ncalrpc プロトコルシーケンスでのみ使用されます。他のすべてのプロトコルシーケンスでは、このパラメーターは無視されます。サーバーを保護する目的でエンドポイントにセキュリティ記述子を使用することは推奨されません。このパラメーターは、この API の DCE 仕様には存在しません。 |
戻り値の型: RPC_STATUS
公式ドキュメント
RpcServerUseProtseqIfW (Unicode) 関数 (rpcdce.h) は、リモートプロシージャ呼び出しを受信するために、インターフェイス仕様で指定されたプロトコルシーケンスとエンドポイントを使用するよう RPC ランタイムライブラリに指示します。
戻り値
| 値 | 意味 |
|---|---|
| 呼び出しは成功しました。 | |
| このプロトコルシーケンスのエンドポイントが IDL ファイルで指定されていません。 | |
| このホストではプロトコルシーケンスがサポートされていません。 | |
| プロトコルシーケンスが無効です。 | |
| エンドポイントの形式が無効です。 | |
| システムのメモリが不足しています。 | |
| セキュリティ記述子が無効です。 |
解説(Remarks)
サーバーアプリケーションは、1 つのプロトコルシーケンスを RPC ランタイムライブラリに登録するために RpcServerUseProtseqIf を呼び出します。プロトコルシーケンスを登録するたびに、このルーチンは IDL ファイルで提供されたエンドポイントアドレス情報を含めます。
リモートプロシージャ呼び出しの要求を受信するには、サーバーは少なくとも 1 つのプロトコルシーケンスを RPC ランタイムライブラリに登録する必要があります。サーバーアプリケーションは、この関数を複数回呼び出して追加のプロトコルシーケンスを登録できます。
サーバーが登録した各プロトコルシーケンスについて、RPC ランタイムライブラリは、サーバーがリモートプロシージャ呼び出しの要求を受信するための 1 つ以上のエンドポイントを作成します。RPC ランタイムライブラリは、プロトコルシーケンスごとに異なるエンドポイントを作成します。ただし、プロセス内の各インターフェイスは、いずれのエンドポイントからでもアクセスできます。詳細については、「Writing a Secure RPC Client or Server」を参照してください。
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 関数を呼び出すことで取得できます。
詳細については、 Server-Side Binding を参照してください。Microsoft RPC でサポートされるプロトコルシーケンスの一覧については、 String Binding を参照してください。IDL ファイル内のすべてのプロトコルシーケンスを登録するには、サーバーは RpcServerUseAllProtseqsIf を呼び出します。
rpcdce.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、RpcServerUseProtseqIf を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// RPCRT4.dll (Unicode / -W)
#include <windows.h>
RPC_STATUS RpcServerUseProtseqIfW(
LPWSTR Protseq,
DWORD MaxCalls,
void* IfSpec,
void* SecurityDescriptor // optional
);[DllImport("RPCRT4.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int RpcServerUseProtseqIfW(
[MarshalAs(UnmanagedType.LPWStr)] string Protseq, // LPWSTR
uint MaxCalls, // DWORD
IntPtr IfSpec, // void*
IntPtr SecurityDescriptor // void* optional
);<DllImport("RPCRT4.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RpcServerUseProtseqIfW(
<MarshalAs(UnmanagedType.LPWStr)> Protseq As String, ' LPWSTR
MaxCalls As UInteger, ' DWORD
IfSpec As IntPtr, ' void*
SecurityDescriptor As IntPtr ' void* optional
) As Integer
End Function' Protseq : LPWSTR
' MaxCalls : DWORD
' IfSpec : void*
' SecurityDescriptor : void* optional
Declare PtrSafe Function RpcServerUseProtseqIfW Lib "rpcrt4" ( _
ByVal Protseq As LongPtr, _
ByVal MaxCalls As Long, _
ByVal IfSpec As LongPtr, _
ByVal SecurityDescriptor As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RpcServerUseProtseqIfW = ctypes.windll.rpcrt4.RpcServerUseProtseqIfW
RpcServerUseProtseqIfW.restype = ctypes.c_int
RpcServerUseProtseqIfW.argtypes = [
wintypes.LPCWSTR, # Protseq : LPWSTR
wintypes.DWORD, # MaxCalls : DWORD
ctypes.POINTER(None), # IfSpec : void*
ctypes.POINTER(None), # SecurityDescriptor : void* optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('RPCRT4.dll')
RpcServerUseProtseqIfW = Fiddle::Function.new(
lib['RpcServerUseProtseqIfW'],
[
Fiddle::TYPE_VOIDP, # Protseq : LPWSTR
-Fiddle::TYPE_INT, # MaxCalls : DWORD
Fiddle::TYPE_VOIDP, # IfSpec : void*
Fiddle::TYPE_VOIDP, # SecurityDescriptor : void* optional
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "rpcrt4")]
extern "system" {
fn RpcServerUseProtseqIfW(
Protseq: *mut u16, // LPWSTR
MaxCalls: u32, // DWORD
IfSpec: *mut (), // void*
SecurityDescriptor: *mut () // void* optional
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("RPCRT4.dll", CharSet = CharSet.Unicode)]
public static extern int RpcServerUseProtseqIfW([MarshalAs(UnmanagedType.LPWStr)] string Protseq, uint MaxCalls, IntPtr IfSpec, IntPtr SecurityDescriptor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcServerUseProtseqIfW' -Namespace Win32 -PassThru
# $api::RpcServerUseProtseqIfW(Protseq, MaxCalls, IfSpec, SecurityDescriptor)#uselib "RPCRT4.dll"
#func global RpcServerUseProtseqIfW "RpcServerUseProtseqIfW" wptr, wptr, wptr, wptr
; RpcServerUseProtseqIfW Protseq, MaxCalls, IfSpec, SecurityDescriptor ; 戻り値は stat
; Protseq : LPWSTR -> "wptr"
; MaxCalls : DWORD -> "wptr"
; IfSpec : void* -> "wptr"
; SecurityDescriptor : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "RPCRT4.dll"
#cfunc global RpcServerUseProtseqIfW "RpcServerUseProtseqIfW" wstr, int, sptr, sptr
; res = RpcServerUseProtseqIfW(Protseq, MaxCalls, IfSpec, SecurityDescriptor)
; Protseq : LPWSTR -> "wstr"
; MaxCalls : DWORD -> "int"
; IfSpec : void* -> "sptr"
; SecurityDescriptor : void* optional -> "sptr"; RPC_STATUS RpcServerUseProtseqIfW(LPWSTR Protseq, DWORD MaxCalls, void* IfSpec, void* SecurityDescriptor)
#uselib "RPCRT4.dll"
#cfunc global RpcServerUseProtseqIfW "RpcServerUseProtseqIfW" wstr, int, intptr, intptr
; res = RpcServerUseProtseqIfW(Protseq, MaxCalls, IfSpec, SecurityDescriptor)
; Protseq : LPWSTR -> "wstr"
; MaxCalls : DWORD -> "int"
; IfSpec : void* -> "intptr"
; SecurityDescriptor : void* optional -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
procRpcServerUseProtseqIfW = rpcrt4.NewProc("RpcServerUseProtseqIfW")
)
// Protseq (LPWSTR), MaxCalls (DWORD), IfSpec (void*), SecurityDescriptor (void* optional)
r1, _, err := procRpcServerUseProtseqIfW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Protseq))),
uintptr(MaxCalls),
uintptr(IfSpec),
uintptr(SecurityDescriptor),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // RPC_STATUSfunction RpcServerUseProtseqIfW(
Protseq: PWideChar; // LPWSTR
MaxCalls: DWORD; // DWORD
IfSpec: Pointer; // void*
SecurityDescriptor: Pointer // void* optional
): Integer; stdcall;
external 'RPCRT4.dll' name 'RpcServerUseProtseqIfW';result := DllCall("RPCRT4\RpcServerUseProtseqIfW"
, "WStr", Protseq ; LPWSTR
, "UInt", MaxCalls ; DWORD
, "Ptr", IfSpec ; void*
, "Ptr", SecurityDescriptor ; void* optional
, "Int") ; return: RPC_STATUS●RpcServerUseProtseqIfW(Protseq, MaxCalls, IfSpec, SecurityDescriptor) = DLL("RPCRT4.dll", "int RpcServerUseProtseqIfW(char*, dword, void*, void*)")
# 呼び出し: RpcServerUseProtseqIfW(Protseq, MaxCalls, IfSpec, SecurityDescriptor)
# Protseq : LPWSTR -> "char*"
# MaxCalls : DWORD -> "dword"
# IfSpec : void* -> "void*"
# SecurityDescriptor : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "rpcrt4" fn RpcServerUseProtseqIfW(
Protseq: [*c]const u16, // LPWSTR
MaxCalls: u32, // DWORD
IfSpec: ?*anyopaque, // void*
SecurityDescriptor: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc RpcServerUseProtseqIfW(
Protseq: WideCString, # LPWSTR
MaxCalls: uint32, # DWORD
IfSpec: pointer, # void*
SecurityDescriptor: pointer # void* optional
): int32 {.importc: "RpcServerUseProtseqIfW", stdcall, dynlib: "RPCRT4.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "rpcrt4");
extern(Windows)
int RpcServerUseProtseqIfW(
const(wchar)* Protseq, // LPWSTR
uint MaxCalls, // DWORD
void* IfSpec, // void*
void* SecurityDescriptor // void* optional
);ccall((:RpcServerUseProtseqIfW, "RPCRT4.dll"), stdcall, Int32,
(Cwstring, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
Protseq, MaxCalls, IfSpec, SecurityDescriptor)
# Protseq : LPWSTR -> Cwstring
# MaxCalls : DWORD -> UInt32
# IfSpec : void* -> Ptr{Cvoid}
# SecurityDescriptor : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t RpcServerUseProtseqIfW(
const uint16_t* Protseq,
uint32_t MaxCalls,
void* IfSpec,
void* SecurityDescriptor);
]]
local rpcrt4 = ffi.load("rpcrt4")
-- rpcrt4.RpcServerUseProtseqIfW(Protseq, MaxCalls, IfSpec, SecurityDescriptor)
-- Protseq : LPWSTR
-- MaxCalls : DWORD
-- IfSpec : void*
-- SecurityDescriptor : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('RPCRT4.dll');
const RpcServerUseProtseqIfW = lib.func('__stdcall', 'RpcServerUseProtseqIfW', 'int32_t', ['str16', 'uint32_t', 'void *', 'void *']);
// RpcServerUseProtseqIfW(Protseq, MaxCalls, IfSpec, SecurityDescriptor)
// Protseq : LPWSTR -> 'str16'
// MaxCalls : DWORD -> 'uint32_t'
// IfSpec : void* -> 'void *'
// SecurityDescriptor : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("RPCRT4.dll", {
RpcServerUseProtseqIfW: { parameters: ["buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.RpcServerUseProtseqIfW(Protseq, MaxCalls, IfSpec, SecurityDescriptor)
// Protseq : LPWSTR -> "buffer"
// MaxCalls : DWORD -> "u32"
// IfSpec : void* -> "pointer"
// SecurityDescriptor : void* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t RpcServerUseProtseqIfW(
const uint16_t* Protseq,
uint32_t MaxCalls,
void* IfSpec,
void* SecurityDescriptor);
C, "RPCRT4.dll");
// $ffi->RpcServerUseProtseqIfW(Protseq, MaxCalls, IfSpec, SecurityDescriptor);
// Protseq : LPWSTR
// MaxCalls : DWORD
// IfSpec : void*
// 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.UNICODE_OPTIONS);
int RpcServerUseProtseqIfW(
WString Protseq, // LPWSTR
int MaxCalls, // DWORD
Pointer IfSpec, // void*
Pointer SecurityDescriptor // void* optional
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("rpcrt4")]
lib LibRPCRT4
fun RpcServerUseProtseqIfW = RpcServerUseProtseqIfW(
Protseq : UInt16*, # LPWSTR
MaxCalls : UInt32, # DWORD
IfSpec : Void*, # void*
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 RpcServerUseProtseqIfWNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Void>);
typedef RpcServerUseProtseqIfWDart = int Function(Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>);
final RpcServerUseProtseqIfW = DynamicLibrary.open('RPCRT4.dll')
.lookupFunction<RpcServerUseProtseqIfWNative, RpcServerUseProtseqIfWDart>('RpcServerUseProtseqIfW');
// Protseq : LPWSTR -> Pointer<Utf16>
// MaxCalls : DWORD -> Uint32
// IfSpec : void* -> Pointer<Void>
// SecurityDescriptor : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RpcServerUseProtseqIfW(
Protseq: PWideChar; // LPWSTR
MaxCalls: DWORD; // DWORD
IfSpec: Pointer; // void*
SecurityDescriptor: Pointer // void* optional
): Integer; stdcall;
external 'RPCRT4.dll' name 'RpcServerUseProtseqIfW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RpcServerUseProtseqIfW"
c_RpcServerUseProtseqIfW :: CWString -> Word32 -> Ptr () -> Ptr () -> IO Int32
-- Protseq : LPWSTR -> CWString
-- MaxCalls : DWORD -> Word32
-- IfSpec : void* -> Ptr ()
-- SecurityDescriptor : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let rpcserveruseprotseqifw =
foreign "RpcServerUseProtseqIfW"
((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* Protseq : LPWSTR -> (ptr uint16_t) *)
(* MaxCalls : DWORD -> uint32_t *)
(* IfSpec : void* -> (ptr void) *)
(* 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 ("RpcServerUseProtseqIfW" rpc-server-use-protseq-if-w :convention :stdcall) :int32
(protseq (:string :encoding :utf-16le)) ; LPWSTR
(max-calls :uint32) ; DWORD
(if-spec :pointer) ; void*
(security-descriptor :pointer)) ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RpcServerUseProtseqIfW = Win32::API::More->new('RPCRT4',
'int RpcServerUseProtseqIfW(LPCWSTR Protseq, DWORD MaxCalls, LPVOID IfSpec, LPVOID SecurityDescriptor)');
# my $ret = $RpcServerUseProtseqIfW->Call($Protseq, $MaxCalls, $IfSpec, $SecurityDescriptor);
# Protseq : LPWSTR -> LPCWSTR
# MaxCalls : DWORD -> DWORD
# IfSpec : void* -> LPVOID
# SecurityDescriptor : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f RpcServerUseProtseqIfA (ANSI版) — インターフェイス指定でプロトコルシーケンスを登録する(ANSI版)。
- f RpcServerUseProtseqIfExW — ポリシーとインターフェイス指定で登録する(Unicode版)。
- f RpcBindingVectorFree — バインディングベクターを解放する。
- f RpcNsBindingExportW — ネームサービスにインターフェイスのバインディングをエクスポートする(Unicode版)。
- f RpcServerInqBindings — サーバーのバインディングベクターを取得する。
- f RpcServerListen — RPCサーバーがクライアント要求の待ち受けを開始する。
- f RpcServerRegisterIf — RPCサーバーにインターフェイスを登録する。
- f RpcServerUseAllProtseqs — 利用可能な全プロトコルシーケンスを使用登録する。
- f RpcServerUseAllProtseqsIf — インターフェイス指定で全プロトコルシーケンスを登録する。