Edit

Share via

RpcServerInterfaceGroupActivate function (rpcdce.h)

  • Article

The RpcServerInterfaceGroupActivate function tells the RPC server runtime to register the interface group’s interfaces and endpoints and begin listening for calls.

Syntax

RPC_STATUS RpcServerInterfaceGroupActivate(
  [in] RPC_INTERFACE_GROUP IfGroup
);

Parameters

[in] IfGroup

A RPC_INTERFACE_GROUP from RpcServerInterfaceGroupCreate that defines the interface group to activate.

Return value

Value Meaning
RPC_S_OK
 The call succeeded.
RPC_S_PROTSEQ_NOT_SUPPORTED
 The protocol sequence is not supported on this host.
RPC_S_INVALID_RPC_PROTSEQ
 The protocol sequence is invalid.
RPC_S_INVALID_ENDPOINT_FORMAT
 The endpoint format is invalid.
RPC_S_OUT_OF_MEMORY
 The system is out of memory.
RPC_S_INVALID_SECURITY_DESC
 The security descriptor for an endpoint or interface is invalid.
 
Note  For a list of valid error codes, see RPC Return Values.
 

Remarks

RpcServerInterfaceGroupActivate does the bulk of the initialization work that the RPC server applications need to do. It performs the following operations:

  • Instructs the RPC runtime to begin listening for calls.
  • Registers the endpoints with the server runtime.
  • Registers the interfaces with the server runtime.
  • Registers the endpoints and interfaces with the RPC endpoint mapper.

RpcServerInterfaceGroupActivate is atomic. If at any point the operation fails, any items that were previously registered are undone.

Calls may be dispatched to the server application before this function returns.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header rpcdce.h (include Rpc.h)
Library Rpcrt4.lib
DLL Rpcrt4.dll

See also

RpcServerInterfaceGroupClose

RpcServerInterfaceGroupCreate

RpcServerInterfaceGroupDeactivate

RpcServerInterfaceGroupInqBindings