Simulink.ID.getHandle

(Not recommended) Get handle of object associated with Simulink Identifier

Simulink.ID.getHandle is not recommended. Use alternative functions instead.

• For blocks, use getSimulinkBlockHandle.

• For annotations, use find_system or getCurrentAnnotation.

• For Stateflow^® objects, use find (Stateflow).

For more information, see Version History.

Syntax

handle = Simulink.ID.getHandle(SID)

Description

handle = Simulink.ID.getHandle(SID) returns the handle of the object for the specified Simulink^® Identifier SID.

Examples

Get Handle of Block

Open the model vdp.

openExample('simulink_general/VanDerPolOscillatorExample')

Get the Simulink Identifier (SID) of the Sum block.

SID = Simulink.ID.getSID('vdp/Sum');

Get the handle of the Sum block using the SID.

handle = Simulink.ID.getHandle(SID)

Input Arguments

SID — Simulink Identifier

character vector | string scalar

Simulink Identifier (SID), specified as a character vector or string scalar.

To get the SID for an object, use the Simulink.ID.getSID function.

Example: 'vdp:4'

Data Types: char | string

Output Arguments

handle — Object handle

numeric scalar

Object handle, returned as a numeric scalar.

Data Types: double

Version History

Introduced in R2009b

R2020a: Not recommended

Simulink.ID.getHandle is not recommended. Use alternative functions instead.

• For blocks, use the getSimulinkBlockHandle function.

• For annotations, use the find_system or getCurrentAnnotation functions.

• For Stateflow objects, use find (Stateflow).

This table shows some typical usages of Simulink.ID.getHandle and how to update your code.

Handle Type	Not Recommended	Recommended
Block	SID = Simulink.ID.getSID('vdp/Sum'); handle = Simulink.ID.getHandle(SID)	handle = getSimulinkBlockHandle('vdp/Sum')
Annotation	object = getCurrentAnnotation; SID = Simulink.ID.getSID(object) handle = Simulink.ID.getHandle(SID)	object = getCurrentAnnotation; handle = object.Handle
Stateflow object	chart = find(slroot, '-isa',... 'Stateflow.Chart','Name','shift_logic'); SID = Simulink.ID.getSID(chart); Simulink.ID.getHandle(SID)	chart = find(slroot, '-isa',... 'Stateflow.Chart','Name','shift_logic'); The Stateflow handle is equivalent to the Stateflow object.