Functions for Separating Directory and File Data

Functions for Separating Directory and File Data

GetDirectory Function

GetDirectorySubtree Function

GetAllFiles Function

GetFile Function

GetFileDependencies Function

GetFileMessages Function

GetFileVCSData Function

GetDirectory Function

The GetDirectory function separates data on the content of the directory specified.

Declarations:

GetDirectory( TDirectory DirectoryData, string DirectoryPath )

Parameters:

DirectoryData - variable in which data on one or more directories are stored

DirectoryPath - variable in which data on one or more directories are stored

Examples:

#{ GetDirectory( DirectoryData, "Mat\Pol" ) }#

GetDirectorySubtree Function

The GetDirectorySubtree function separates data on the content of the directory specified and all its subdirectories (the order of the generated data in the collection corresponds to the preorder order of the tree tour).

Declaration:

GetDirectorySubtree( TCollection<TDirectory> DirectoryData, string DirectoryPath )

Parameters:

DirectoryData - variable in which data on a directory or several directories are stored

DirectoryPath - DA-C path of the directory specified

Example:

#{ GetDirectorySubtree( DirectoryData, "Mat\Pol" ) }#

GetAllFiles Function

The GetAllFiles function separates data on all project files.

Declaration:

GetAllFiles( TCollection<TFile> FileData )

Parameter:

FileData - variable in which data on one or more files are stored,

Example:

#{ GetAllFiles( FileData ) }#

GetFile Function

The GetFile function separates data on the file specified.

Declaration:

GetFile( TFile FileData, string FilePath )

Parameters:

FileData - variable in which data on one or more files are stored,

FilePath - the DA-C path of the file specified.

Example:

#{ GetFile( FileData, "MatFun\Interpolations.c" ) }#

GetFileDependencies Function

The GetFileDependencies function separates the names of all files on which the specified file is dependent, that is, of all files included in the file specified.

Declaration:

GetFileDependencies( TCollection<string> FileDependencies, string FilePath )

Parameters:

FileDependencies - variable in which data on files included in the file specified are stored,

FilePath - DA-C path of the file specified.

Example:

#{ GetFileDependencies( FileDependenceisData, "MatFun\Interpolations.c" ) }#

GetFileMessages Function

The GetFileMessages function separates data on messages pertaining to the file specified.

Declaration:

GetFileMessages ( TCollection<TMessage> FileMessages, string FilePath, string Category )

Parameters:

FileMessages - variable in which data on messages pertaining to the file specified are stored,

FilePath - DA-C path of the file specified,

Category - message category - the possible values of this argument are: "Static Code Analysis", "Source Code Metrics", "Makefile generator", "Naming Convention" or User-Defined tab name.

Example:

#{ GetFileMessages( FileMessagesData, "MatFun\Interpolations.c", "Static Code Analysis" ) }#

GetFileVCSData Function

The GetFileVCSData function separates data on the file specified from the Version Control System.

Declaration:

GetFileVCSData( TFileVCSData FileVCSData, string FilePath )

Parameters:

FileVCSData - variable in which VCS file data are stored,

FilePath - the DA-C path of the file specified.

Example:

#{ GetFileVCSData( FileVCSData, "MatFun\Interpolations.c" ) }#