findEntryByName

Get corresponding object for specified entry name in interface dictionary

Since R2023a

Syntax

entryObj = findEntryByName(dictObj,entryName)

Description

entryObj = findEntryByName(dictObj,entryName) returns the object that corresponds to the specified entry name, entryName, in the interface dictionary. If the entry does not exist in the dictionary, an empty value is returned.

Examples

Get Interface Object by Specified Name

Get object for structure type named myStructType1 from the interface dictionary MyInterfaces.sldd.

dictAPI = Simulink.interface.dictionary.open('MyInterfaces.sldd');
structObj = findEntryByName(dictAPI,'myStructType1')

structObj = 
  StructType with properties:
           Name: 'myStructType1'
    Description: ''
       Elements: [1×2 Simulink.interface.dictionary.StructElement]
          Owner: [1×1 Simulink.interface.Dictionary]

Input Arguments

dictObj — Interface dictionary

Simulink.interface.Dictionary object

Interface dictionary, specified as a Simulink.interface.Dictionary object. Before you use this function, create or open dictObj by using Simulink.interface.dictionary.create or Simulink.interface.dictionary.open.

entryName — Interface or data type name

character vector | string scalar

Interface or data type name, specified as a character vector or a string scalar.

Example: 'DataInterface'

Output Arguments

entryObj — Interface or data type object

DataInterface object | ServiceInterface object | AliasType object | EnumType object | NumericType object | StructType object | ValueType object

Interface or data type object, returned as the object type of the corresponding entry in the interface dictionary.

Version History

Introduced in R2023a