build.File


This function runs a build of a specified file.

[Specification format]

build.File(fileName, rebuild = False, waitBuild = True)

[Argument(s)]

Argument

Description

fileName

Specify a file to run a build.

rebuild

Specify whether to run a rebuild of a specified file.

True: Run a rebuild of a specified file.

False: Run a build of a specified file (default).

waitBuild

Specify whether to wait until completing a build.

True: Wait until completing a build (default).

False: Return a prompt without waiting to complete a build.

[Return value]

-

When waitBuild is set to "True"

If a build was completed successfully: True

If there was an error when running a build: False

 

-

When waitBuild is set to "False"

If a build successfully started execution: True

If a build failed to start execution: False

[Detailed description]

-

This function runs a build of a file specified by fileName.

-

If rebuild is set to "True", then a rebuild of a specified file is run.

-

If waitBuild is set to "False", then a prompt is returned without waiting to complete a build.

-

The build.BuildCompleted event is issued when a build completes.

[Example of use]

>>>build.File("C:/test/test.c")
True
>>>