getIncludePaths

Get include paths from build information

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, myBuildInfo.

myBuildInfo = RTW.BuildInfo;
addIncludePaths(myBuildInfo,{'/etc/proj/etclib' ... 
   '/etcproj/etc/etc_build' '/common/lib'}, ...
   {'etc' 'etc' 'shared'});
incpaths = getIncludePaths(myBuildInfo,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, myBuildInfo.

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

>> incpaths

incpaths = 

    '\common\lib'

Input Arguments

buildinfo — Build information object

object

RTW.BuildInfo object that contains information for compiling and linking generated code.

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

Group names of include paths to include in the return from the function, specified as a string or a cell array of character vectors. To view the group name of an include path, access the Group property of the corresponding object.

Example: ''

excludeGroups — Group names of include paths to exclude from the return from the function

cell array of character vectors | string

Group names of include paths to exclude from the return from the function, specified as a string or a cell array of character vectors. To view the group name of an include path, access the Group property of the corresponding object.

Example: ''

Output Arguments

paths — Paths of include files

cell array of character vectors

Paths of include files from the build information.

Version History

Introduced in R2006a