Skip to main content
Open topic with navigation

​
SomeIpProvidedEventAddConsumer

CAPL Functions » Ethernet » SOME/IP IL » SomeIpProvidedEventAddConsumer Valid for: CANoe DE • CANoe4SW DE

​
Function Syntax

  • long SomeIpProvidedEventAddConsumer(dword pevHandle, dword remoteIPv4Address, dword remoteUDPPort, dword remoteTCPPort); // form 1
  • long SomeIpProvidedEventAddConsumer(dword pevHandle, byte remoteIPv6Address[], dword remoteUDPPort, dword remoteTCPPort); // form 2
  • long SomeIpProvidedEventAddConsumer(dword pevHandle, IP_Endpoint remoteIPEndpoint); // form 3

​
Description

Adds a consumer to a provided event. Afterwards the event notifications will be sent to this consumer.

​
Parameters

  • pevHandle: Provided event handle (may be retrieved by SomeIpGetProvidedObjectHandle)
  • remoteIPv4Address: IPv4 address of the consumer. In network byte order.
  • remoteIPv6Address: IPv6 address of the consumer
  • remoteUDPPort: An UDP port number of the consumer or zero if there is none
  • remoteTCPPort: A TCP port number of the consumer or zero if there is none
  • remoteIPEndpoint: Object of type IP_Endpoint that contains the address/port of the consumer.

​
Return Values

  • 0: The function was successfully executed
  • >0: Error code

​
Example

—