Documentation

getIncludePaths

Get include paths from model build information

collapse all in page

Syntax

paths = getIncludePaths(buildinfo,replaceMatlabroot,includeGroups,excludeGroups)

Description

paths = getIncludePaths(buildinfo,replaceMatlabroot,includeGroups,excludeGroups) returns the names of include file paths from the build information.

The function requires the buildinfo and replaceMatlabroot arguments. You can use optional includeGroups and excludeGroups arguments. These optional arguments let you include or exclude groups selectively from the include paths returned by the function.

If you choose to specify excludeGroups and omit includeGroups, specify a null character vector ('') for includeGroups.

Examples

Get Include Paths from Build Information

Get the include paths from the build information, myModelBuildInfo.

myModelBuildInfo = RTW.BuildInfo;
addIncludePaths(myModelBuildInfo,{'/etc/proj/etclib' ... 
   '/etcproj/etc/etc_build' '/common/lib'}, ...
   {'etc' 'etc' 'shared'});
incpaths = getIncludePaths(myModelBuildInfo,false);

>> incpaths

incpaths = 

    '\etc\proj\etclib'   [1x22 char]    '\common\lib'

Get Include Paths with Include Group Argument

Get the paths in group shared from the build information, myModelBuildInfo.

myModelBuildInfo = RTW.BuildInfo;
addIncludePaths(myModelBuildInfo,{'/etc/proj/etclib' ...
   '/etcproj/etc/etc_build' '/common/lib'}, ...
   {'etc' 'etc' 'shared'});
incpaths = getIncludePaths(myModelBuildInfo,false,'shared');

>> incpaths

incpaths = 

    '\common\lib'

Input Arguments

`buildinfo` — Name of the build information object returned by `RTW.BuildInfo`
object

`replaceMatlabroot` — Choice of whether to replace the `$(MATLAB_ROOT)` token with absolute paths in return from the function
`false` | `true`

Use the replaceMatlabroot argument to control whether the function includes the MATLAB^® root definition in the output that it returns.

Specify	Function Action
`true`	Replaces the token `$(MATLAB_ROOT)` with the absolute path for your MATLAB installation folder.
`false`	Does not replace the token `$(MATLAB_ROOT)`.

Example: true

`includeGroups` — Group names of include paths to include in the return from the function
cell array of character vectors | string

To use the includeGroups argument, view available groups by using myGroups = getGroups(buildInfo).

Example: ''

`excludeGroups` — Group names of include paths to exclude from the return from the function
cell array of character vectors | string

To use the excludeGroups argument, view available groups by using myGroups = getGroups(buildInfo).

Example: ''

Output Arguments

`paths` — Paths of include files from the build information
cell array of character vectors

See Also

addIncludePaths | getIncludeFiles | getSourceFiles | getSourcePaths

Topics

Customize Post-Code-Generation Build Processing

Introduced in R2006a

Embedded Coder Documentation

Support