CAPLfunctionAREthCreateProvidedServiceInstance

AREthCreateProvidedServiceInstance

Valid for: CANoe DE • CANoe4SW DE

Function Syntax

dword AREthCreateProvidedServiceInstance( dword aepHandle, dword serviceId, dword instanceId );

Description

This function creates a Provided Service Instance and adds it to an Application Endpoint which was created by AREthOpenLocalApplicationEndpoint.

Objects can be assigned to the Service Instance as follows:

• Event Groups: AREthAddProvidedEventGroup
• Events: AREthAddEvent
• Fields: AREthAddField
• Methods: AREthAddMethod

The Service Instance can be deleted again with AREthReleaseProvidedServiceInstance.

Parameters

• aepHandle: Handle of the Application Endpoint (see AREthOpenLocalApplicationEndpoint)
• serviceId: Service identifier
• instanceId: Instance identifier

Return Values

• 0: An error occurred. The error can be evaluated using the AREthGetLastError function.
• >0: Handle of the generated Provided Service Instance

Example

void Initialize()
{
  dword aep; // Application Endpoint handle
  dword psi; // provided service handle
  dword peg; // provided Eventgroup handle
  dword pev; // provided Event handle

  // open Application Endpoint
  aep = AREthOpenLocalApplicationEndpoint(17, 50002);

  // create Service Instance
  psi = AREthCreateProvidedServiceInstance(aep,10,1);

  // create Eventgroup
  peg = AREthAddProvidedEventGroup(psi,1);

  // create Event and add Event to Eventgroup
  pev = AREthAddEvent(psi, 1, "OnPrepareEvent1");
  AREthAddEventToEventgroup(peg, pev);

  // ensure that Event is sent cyclically
  AREthSetProperty(pev,"CycleTimeMs",1000);
}

void OnPrepareEvent1(dword eventHandle, dword messageHandle)
{
  // this function is called before the Event is sent. Parameters can be specified here.
}

See Also: AREthAddEvent, AREthAddEventToEventgroup, AREthAddField, AREthAddMethod, AREthReleaseProvidedServiceInstance