Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

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 representing 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++

Example

See the example in the reference page for ssEnableSystemWithTid.

Introduced before R2006a

Was this topic helpful?