RpcServerUseProtseqEpEx  6FS7JZ

The RpcServerUseProtseqEpEx function tells the RPC run-time library to use the specified protocol sequence combined with the specified endpoint for receiving remote procedure calls. For a list of Microsoft RPC s supported protocol sequences, see the reference topic String Binding1CPK9NH in RPC Data Types and Structures.

This function is supported only on Windows NT 4.0.

#include <rpc.h>

RPC_STATUS RPC_ENTRY RpcServerUseProtseqEpEx(

    unsigned char *  Protseq,

 

    unsigned int  MaxCalls,

 

    unsigned char *  Endpoint,

 

    void *  SecurityDescriptor,

 

    PRPC_POLICY Policy

 

   );

 

 

Parameters

Protseq

Points to a string identifier of the protocol sequence to register with the RPC run-time library.

MaxCalls

Specifies the maximum number of concurrent remote procedure call requests the server wants to handle.

The RPC run-time library guarantees that the server can accept at least this number of concurrent call requests. The actual number can be greater, depending on the selected protocol sequence. Use RPC_C_PROTSEQ_MAX_REQS_DEFAULT to specify the default value.

Endpoint

Points to the endpoint-address information to use in creating a binding for the protocol sequence specified in the Protseq argument.

SecurityDescriptor

Points to an optional parameter provided for the Microsoft Windows NT security subsystem.

Policy

Points to the RPC_POLICYBEHT1Y structure, which contains flags to restrict port allocation for dynamic ports and which allow multihomed machines to selectively bind to network interface cards.

 

Remarks

The parameters and effects of RpcServerUseProtseqEpEx subsume those of RpcServerUseProtseqEp. The difference is the Policy field, which allows you to restrict port allocation for dynamic ports and allows multihomed machines to selectively bind to network interface cards.

Setting the NICFlags field of the RPC_POLICY structure to zero makes this extended function functionally equivalent to the original RpcServerUseProtseqEp, and the server will bind to NICs based on the settings in the system registry. For information on how the registry settings define the available Internet and intranet ports, see Configuring the Windows NT Registry for Port Allocations and Selective Binding42F3.CT.

 

Note  The flag settings in the Policy field are effective only when the ncacn_ip_tcp protocol sequence is in use. For all other protocol sequences, the RPC run time ignores these values.

 

A server application calls the RpcServerUseProtseqEpEx routine to register one protocol sequence with the RPC run-time library. With each protocol sequence registration, RpcServerUseProtseqEpEx includes the specified endpoint-address information.

To receive remote procedure call requests, a server must register at least one protocol sequence with the RPC run-time library. A server application can call this routine multiple times to register additional protocol sequences and endpoints.

For each protocol sequence registered by a server, the RPC run-time library creates one or more binding handles through which the server receives remote procedure call requests.

The MaxCalls argument allows the server to specify the maximum number of concurrent remote procedure call requests the server wants to handle.

Return Values

Value

Meaning

RPC_S_OK

Success

RPC_S_PROTSEQ_NOT_SUPPORTED

Protocol sequence is not supported on this host

RPC_S_INVALID_RPC_PROTSEQ

Invalid protocol sequence

RPC_S_INVALID_ENDPOINT_FORMAT

Invalid endpoint format

RPC_S_OUT_OF_MEMORY

Out of memory

RPC_S_DUPLICATE_ENDPOINT

Endpoint is a duplicate

RPC_S_INVALID_SECURITY_DESC

Security descriptor is invalid

 

See Server Application RPC API Calls.7VGRF for a description of the routines that a server will typically call after registering protocol sequences.

See Also

Configuring the Windows NT Registry for Port Allocations and Selective Binding, RpcServerUseAllProtseqsEx, RpcServerUseAllProtseqsIfEx, RpcServerUseProtseqEx, RpcServerUseProtseqIfEx