|NAnt Help Task Reference <sysinfo>||v0.92-rc1|
[This is preliminary documentation and subject to change.]
Sets properties with system information.
Sets a number of properties with information about the system environment. The intent of this task is for nightly build logs to have a record of system information so that the build was performed on.
||Common Language Runtime version number.|
||Environment variables (e.g., <
||Operating system platform ID.|
||Operating system version.|
||Operating system version string.|
||The directory that serves as a common repository for application-specific data for the current roaming user.|
||The directory that serves as a common repository for application-specific data that is used by all users.|
||The directory for components that are shared across applications.|
||The directory used to physically store file objects on the desktop. Do not confuse this directory with the desktop folder itself, which is a virtual folder.|
||The Program Files directory.|
||The System directory.|
||The temporary directory.|
When the name of an environment variable is not a valid property name, the task will fail. In that case, set
failonerror to true to allow that environment variable to be skipped.
Note: we advise you to use the following functions instead:
|environment::get-operating-system()||Gets a OperatingSystem object that identifies this operating system.|
|environment::get-folder-path()||Gets the path to a system special folder.|
|environment::get-variable()||Returns the value of a environment variable.|
|path::get-temp-path()||Gets the path to the temporary directory.|
|environment::get-version()||Gets the Common Language Runtime version.|
|prefix||string||The string to prefix the property names with. The default is "sys.".||False|
|failonerror||bool||Determines if task failure stops the build, or is just reported. The default is true.||False|
|if||bool||If true then the task will be executed; otherwise, skipped. The default is true.||False|
|unless||bool|| Opposite of
|verbose||bool||Determines whether the task should report detailed build log messages. The default is false.||False|
Register the properties with the default property prefix.
Register the properties without a prefix.
<sysinfo prefix="" />
Register properties and display a summary.
<sysinfo verbose="true" />