ssDisableSystemWithTid

Disable a function-call subsystem connected to this S-Function block

Syntax

int_T ssDisableSystemWithTid(SimStruct *S, int_T element, int_T tid)

Arguments

S

SimStruct that represents an S-Function block.

element

Index of the output port element corresponding to the function-call subsystem.

tid

Task ID.

Returns

An int_T 1 if successful; otherwise, 0.

Description

Use in mdlOutputs to disable a function-call subsystem connected to the S-function. The invoking syntax is

if (!ssDisableSystemWithTid(S, element, tid)) {
  /* Error occurred which will be reported by the Simulink engine*/
  return;
}

Note

Before invoking this function, the S-function must have specified that it explicitly enables and disables the function-call subsystems that it calls. See ssSetExplicitFCSSCtrl and ssEnableSystemWithTid for more information. If the S-function has not done this, invoking ssDisableSystemWithTid results in an error.

This function resets the outputs of any Outport blocks in the function-call subsystem whose Outputs when disabled parameter is set to reset.

Languages

C, C++

Examples

See the example in the reference page for ssEnableSystemWithTid.