Simulink.data.dictionary.open

Open data dictionary for editing

collapse all in page

Syntax

dictionaryObj = Simulink.data.dictionary.open(dictionaryFile)
dictionaryObj = Simulink.data.dictionary.open(dictionaryFile,'SubdictionaryErrorAction','warn')

Description

dictionaryObj = Simulink.data.dictionary.open(dictionaryFile) opens the specified data dictionary and returns a Simulink.data.Dictionary object representing an existing data dictionary identified by its file name and, optionally, file path with dictionaryFile.

Make sure any dictionaries referenced by the target dictionary are on the MATLAB path.

example

dictionaryObj = Simulink.data.dictionary.open(dictionaryFile,'SubdictionaryErrorAction','warn') displays a warning when the function is unable to open a dictionary referenced by the target dictionary dictionaryFile, but opens the target dictionary anyway.

Examples

collapse all

Open the data dictionary myDictionary_ex_API.sldd and represent it with a Simulink.data.Dictionary object named myDictionaryObj.

myDictionaryObj = Simulink.data.dictionary.open('myDictionary_ex_API.sldd')
myDictionaryObj = 

  Dictionary with properties:

          DataSources: {'myRefDictionary_ex_API.sldd'}
    HasUnsavedChanges: 0
           NumberOfEntries: 4

Input Arguments

collapse all

Target data dictionary, specified as a character vector containing the file name and, optionally, path of the dictionary. If you do not specify a path, Simulink.data.dictionary.open searches the MATLAB path for the specified file. Simulink.data.dictionary.open also supports paths specified relative to the MATLAB working folder.

Example: 'myDictionary_ex_API.sldd'

Example: 'C:\Users\jsmith\myDictionary_ex_API.sldd'

Example: '..\myOtherDictionary.sldd'

Data Types: char

Version History

Introduced in R2015a

See Also

| |

Topics