RpcServerUseProtseqIfExW 関数 (rpcdce.h)

[アーティクル]
08/25/2023

RpcServerUseProtseqIfEx 関数は、リモートプロシージャ呼び出しを受信するために、指定されたプロトコルシーケンスとインターフェイス仕様のエンドポイントを組み合わせて使用するように RPC ランタイムライブラリに指示します。

構文

RPC_STATUS RpcServerUseProtseqIfExW(
  RPC_WSTR      Protseq,
  unsigned int  MaxCalls,
  RPC_IF_HANDLE IfSpec,
  void          *SecurityDescriptor,
  PRPC_POLICY   Policy
);

パラメーター

Protseq

RPC ランタイムライブラリに登録するプロトコルシーケンスの文字列識別子へのポインター。

MaxCalls

ncacn_ip_tcp プロトコルシーケンスのバックログキューの長さ。他のすべてのプロトコルシーケンスでは、このパラメーターは無視されます。既定値を指定するには、RPC_C_PROTSEQ_MAX_REQS_DEFAULTを使用します。「解説」を参照してください。

IfSpec

Protseq パラメーターで指定されたプロトコルシーケンスのバインディングの作成に使用するエンドポイント情報を含むインターフェイス。

SecurityDescriptor

セキュリティサブシステムに指定された省略可能なパラメーターへのポインター。 ncalrpc プロトコルシーケンスの ncacn_np とにのみ使用されます。他のすべてのプロトコルシーケンスでは、このパラメーターは無視されます。サーバーをセキュリティで保護するためにエンドポイントでセキュリティ記述子を使用することはお勧めしません。このパラメーターは、この API の DCE 仕様には含まれません。

Policy

動的ポートのポート割り当てを制限し、マルチホームコンピューターがネットワークインターフェイスカードに選択的にバインドできるようにするフラグを含む、RPC_POLICY 構造体へのポインター。

戻り値

価値	意味
RPC_S_OK	呼び出しは成功しました。
RPC_S_PROTSEQ_NOT_FOUND	このプロトコルシーケンスのエンドポイントが IDL ファイルで指定されていません。
RPC_S_PROTSEQ_NOT_SUPPORTED	プロトコルシーケンスは、このホストではサポートされていません。
RPC_S_INVALID_RPC_PROTSEQ	プロトコルシーケンスが無効です。
RPC_S_INVALID_ENDPOINT_FORMAT	エンドポイントの形式が無効です。
RPC_S_OUT_OF_MEMORY	システムがメモリ不足です。
RPC_S_INVALID_SECURITY_DESC	セキュリティ記述子が無効です。

注有効なエラーコードの一覧については、「RPC 戻り値」を参照してください。

備考

RpcServerUseProtseqIfEx のパラメーターと効果、RpcServerUseProtseqIfのパラメーターと効果を拡張します。違いは、動的ポートのポート割り当てを制限し、マルチホームコンピューターがネットワークインターフェイスカードに選択的にバインドできるようにする、Policy パラメーターです。

RPC_POLICY 構造体の NICFlags フィールドを 0 に設定すると、この拡張 API は、元の RpcServerUseProtseqIfと機能的に同等になり、サーバーはシステムレジストリの設定に基づいて NIC にバインドされます。使用可能なインターネットポートとイントラネットポートをレジストリ設定で定義する方法については、「ポート割り当てと選択的バインディングのレジストリの構成」を参照してください。

注Policy フィールドのフラグ設定は、ncacn_ip_tcp または ncadg_ip_udp プロトコルシーケンスが使用されている場合にのみ有効です。他のすべてのプロトコルシーケンスでは、RPC ランタイムはこれらの値を無視します。

サーバーアプリケーション RpcServerUseProtseqIfEx を呼び出して、1 つのプロトコルシーケンスを RPC ランタイムライブラリに登録します。プロトコルシーケンスの登録ごとに、ルーチンには IDL ファイルで提供されるエンドポイントアドレス情報が含まれます。

リモートプロシージャコール要求を受信するには、サーバーが少なくとも 1 つのプロトコルシーケンスを RPC ランタイムライブラリに登録する必要があります。サーバーアプリケーションは、このルーチンを複数回呼び出して、追加のプロトコルシーケンスを登録できます。

サーバーによって登録されたプロトコルシーケンスごとに、RPC ランタイムライブラリは、サーバーがリモートプロシージャコール要求を受信する 1 つ以上のエンドポイントを作成します。 RPC ランタイムライブラリは、プロトコルシーケンスごとに異なるエンドポイントを作成します。ただし、プロセス内の各インターフェイスには、任意のエンドポイントを介してアクセスできます。詳細については、「セキュリティで保護された RPC クライアントまたはサーバーの作成」を参照してください。

MaxCallsの場合、アプリケーションによって提供される値はヒントにすぎません。 RPC ランタイムまたは Windows ソケットプロバイダーによって値がオーバーライドされる場合があります。たとえば、Windows XP または Windows 2000 Professional では、値は 5 に制限されます。 5 より大きい値は無視され、代わりに 5 が使用されます。 Windows Server 2003 および Windows 2000 Server では、この値が使用されます。

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

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

IDL ファイルからすべてのプロトコルシーケンスを登録するために、サーバーは RpcServerUseAllProtseqsIfEx を呼び出します。詳細については、「バインドを Server-Side する」を参照してください。 Microsoft RPC でサポートされているプロトコルシーケンスの一覧については、「文字列バインディング」を参照してください。

手記

rpcdce.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RpcServerUseProtseqIfEx を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows XP [デスクトップアプリのみ]
サポートされる最小サーバー	Windows Server 2003 [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	rpcdce.h (Rpc.h を含む)
ライブラリ	Rpcrt4.lib
DLL	Rpcrt4.dll

次の方法で共有

RpcServerUseProtseqIfExW 関数 (rpcdce.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース