CAPL Script

SDRemoveConsumer

This reference collection includes Vector documentation reproduced with permission. Snippets may require configuration-specific symbols and are not all standalone programs. Sources and validation limits.

Source-version conflict

The CANoe 12 help prints a void signature but also lists numeric return codes on this page. These two descriptions conflict. The extract is retained below as versioned reference evidence, not a confirmed return-value contract. Check the function signature in your installed help/compiler before using it; do not add a return-value assignment based on the table alone.

Syntax

void SD_RemoveConsumer(serviceConsumerRef * consumer)

Function

Removes a consumer endpoint from a service. You may call this to react to timeouts, or unannouncements from a real consumer, or to remove a simulated consumer endpoint.

Parameters

consumer Consumer endpoint.

Return Values

0: Success

1: The service does not allow dynamic endpoint changes

< 0: Other error, e.g. variable not initialized

SD_RemoveConsumer(newConsumer);

SD_RemoveProvider | SD_AddConsumer