wx.Build.Cxx.CollectionOfIncludePaths Class Reference

Inheritance diagram for wx.Build.Cxx.CollectionOfIncludePaths:

List of all members.

Public Member Functions
void	Add (string includePath)
void	AddRange (ICollection< string > includePaths)
void	Clear ()
	CollectionOfIncludePaths ()
bool	Contains (string includePath)
void	CopyTo (string[] array, int arrayIndex)
ContentFiles	FindFile (string additionalPath, string filename)
ContentFiles	FindFile (string filename)
IEnumerator< string >	GetEnumerator ()
ContentFiles	GetPathToIncludes (string sourceFile)
bool	Remove (string includePath)
void	SetReadOnly ()
override string	ToString ()
Properties
int	Count [get]
bool	IsReadOnly [get]

---

Detailed Description

Represents a collection of include paths and some services that depend on these paths. Use instances of this class to store the include paths. Then you may use CheckDependencies() to read paths to included sources.

---

Constructor & Destructor Documentation

wx.Build.Cxx.CollectionOfIncludePaths.CollectionOfIncludePaths

(

)

---

Member Function Documentation

void wx.Build.Cxx.CollectionOfIncludePaths.Add

(

string

includePath

)

This will add the provided includePath at the end of the current collection of paths.

void wx.Build.Cxx.CollectionOfIncludePaths.AddRange

(

ICollection< string >

includePaths

)

void wx.Build.Cxx.CollectionOfIncludePaths.Clear

(

)

bool wx.Build.Cxx.CollectionOfIncludePaths.Contains

(

string

includePath

)

void wx.Build.Cxx.CollectionOfIncludePaths.CopyTo	(	string[]	array,
		int	arrayIndex
	)

ContentFiles wx.Build.Cxx.CollectionOfIncludePaths.FindFile	(	string	additionalPath,
		string	filename
	)

This will first look for filename in additionalPath and then in the contained paths. Each match will be added to the result.

Parameters:

additionalPath

designates an additional directory that will be searched first before visiting the contained directories.

ContentFiles wx.Build.Cxx.CollectionOfIncludePaths.FindFile

(

string

filename

)

Finds file of base name filename (with extension) into one of the contained directories and returns the absolute paths.

IEnumerator<string> wx.Build.Cxx.CollectionOfIncludePaths.GetEnumerator

(

)

ContentFiles wx.Build.Cxx.CollectionOfIncludePaths.GetPathToIncludes

(

string

sourceFile

)

Returns a collection of files that are included by source file sourceFile.

This will look for the include keyword and collect all filenames of includes. These files will then be searched in the stored directories. Missing include files will be silently ignored. All found files will also be searched for includes and so on.

Parameters:

sourceFile

The source file that will be analysed.

bool wx.Build.Cxx.CollectionOfIncludePaths.Remove

(

string

includePath

)

void wx.Build.Cxx.CollectionOfIncludePaths.SetReadOnly

(

)

After calling this method, all modifiers of this instance will throw exceptions.

override string wx.Build.Cxx.CollectionOfIncludePaths.ToString

(

)

---

Property Documentation

int wx.Build.Cxx.CollectionOfIncludePaths.Count [get]

bool wx.Build.Cxx.CollectionOfIncludePaths.IsReadOnly [get]

---