Real-Time Workshop®

addNonBuildFiles - Add nonbuild-related files to model's build information

Syntax

addNonBuildFiles(buildinfo, filenames, paths, groups)

paths and groups are optional.

Arguments

buildinfo

Build information returned by RTW.BuildInfo.

filenames

A character array or cell array of character arrays that specifies names of nonbuild-related files to be added to the build information.

The filename strings can include wildcard characters, provided that the dot delimiter (.) is present. Examples are '*.*', '*.DLL', and '*.D*'.

The function adds the filenames to the end of a vector in the order that you specify them.

The function removes duplicate nonbuild file entries that

• Already exist in the nonbuild file vector

• Have a path that matches the path of a matching filename

A duplicate entry consists of an exact match of a path string and corresponding filename.

paths (optional)

A character array or cell array of character arrays that specifies paths to the nonbuild files. The function adds the paths to the end of a vector in the order that you specify them. If you specify a single path as a character array, the function uses that path for all files.

groups (optional)

A character array or cell array of character arrays that groups specified nonbuild files. You can use groups to

• Document the use of specific nonbuild files

• Retrieve or apply groups of nonbuild files

You can apply

• A single group name to a nonbuild file

• A single group name to multiple nonbuild files

• Multiple group names to collections of multiple nonbuild files

To...	Specify groups as a...
Apply one group name to all nonbuild files	Character array.
Apply different group names to nonbuild files	Cell array of character arrays such that the number of group names that you specify matches the number of elements you specify for filenames.

Description

The addNonBuildFiles function adds specified nonbuild-related files, such as DLL files required for a final executable, or a README file, to the model's build information. The Real-Time Workshop^® software stores the nonbuild files in a vector. The function adds the filenames to the end of the vector in the order that you specify them.

In addition to the required buildinfo and filenames arguments, you can specify optional paths and groups arguments. You can specify each optional argument as a character array or a cell array of character arrays.

If you choose to specify groups, but omit paths, specify a null string ('') for paths.

Examples

• Add the nonbuild file readme.txt to build information myModelBuildInfo and place the file in the group DocFiles.

  myModelBuildInfo = RTW.BuildInfo;
  addNonBuildFiles(myModelBuildInfo, ... 
  'readme.txt', '/pathto/mydocs', 'DocFiles');

• Add the nonbuild files myutility1.dll and myutility2.dll to build information myModelBuildInfo and place the files in the group DLLFiles.

  myModelBuildInfo = RTW.BuildInfo;
  addNonBuildFiles(myModelBuildInfo, ... 
  {'myutility1.dll' 'myutility2.dll'}, ...
  '/pathto/mydlls', 'DLLFiles');

• Add all of the DLL files in a specified directory to build information myModelBuildInfo and place the files in the group DLLFiles.

  myModelBuildInfo = RTW.BuildInfo;
  addNonBuildFiles(myModelBuildInfo, ... 
  '*.dll', '/pathto/mydlls', 'DLLFiles');

See Also

getNonBuildFiles

addLinkObjects

addSourceFiles