RpcServerUseProtseqIfA 関数 (rpcdce.h)

[アーティクル]
03/15/2023

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

構文

RPC_STATUS RpcServerUseProtseqIfA(
  RPC_CSTR      Protseq,
  unsigned int  MaxCalls,
  RPC_IF_HANDLE IfSpec,
  void          *SecurityDescriptor
);

パラメーター

Protseq

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

MaxCalls

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

IfSpec

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

SecurityDescriptor

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

戻り値

値	意味
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 戻り値」を参照してください。

注釈

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

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

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

メモRpcServerUseProtseqIf の Microsoft RPC 実装には、DCE 仕様に記載されていない新しい追加パラメーター SecurityDescriptor が含まれています。

注意

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

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	rpcdce.h (Rpc.h を含む)
Library	Rpcrt4.lib
[DLL]	Rpcrt4.dll