| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE html |
| PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html lang="en-us" xml:lang="en-us"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <!-- /******************************************************************************* |
| * Copyright (c) 2000, 2005 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ --> |
| <link rel="stylesheet" type="text/css" href="../../org.eclipse.wtp.doc.user/common.css" /> |
| |
| <title>workspacePreferenceGet</title> |
| </head> |
| <body id="tantworkspacepreferenceget"><a name="tantworkspacepreferenceget"><!-- --></a> |
| <h1 class="topictitle1">workspacePreferenceGet</h1> |
| <div><p>This task gets Eclipse workspace preferences.</p> |
| <div class="section"><p><span class="uicontrol">Parameters</span></p> |
| |
| <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" width="21.052631578947366%" id="d0e20">Attribute</th> |
| <th valign="top" width="56.84210526315789%" id="d0e22">Description</th> |
| <th align="left" valign="top" width="22.105263157894736%" id="d0e24">Required</th> |
| </tr> |
| </thead> |
| <tbody><tr><td valign="top" width="21.052631578947366%" headers="d0e20 ">PreferenceType</td> |
| <td valign="top" width="56.84210526315789%" headers="d0e22 ">The type of preference to be set</td> |
| <td align="left" valign="top" width="22.105263157894736%" headers="d0e24 ">Yes. May be <em>compiler</em> or <em>classpathVariable</em> or <em>classpath</em> or <em>builder</em></td> |
| </tr> |
| <tr><td valign="top" width="21.052631578947366%" headers="d0e20 ">PreferenceName</td> |
| <td valign="top" width="56.84210526315789%" headers="d0e22 ">The preference name to be set</td> |
| <td align="left" valign="top" width="22.105263157894736%" headers="d0e24 ">Yes</td> |
| </tr> |
| <tr><td valign="top" width="21.052631578947366%" headers="d0e20 ">PropertyName</td> |
| <td valign="top" width="56.84210526315789%" headers="d0e22 ">Property to receive the preference value</td> |
| <td align="left" valign="top" width="22.105263157894736%" headers="d0e24 ">Yes</td> |
| </tr> |
| <tr><td valign="top" width="21.052631578947366%" headers="d0e20 ">FailOnError</td> |
| <td valign="top" width="56.84210526315789%" headers="d0e22 ">Whether or not the Ant build should fail if there was |
| an error</td> |
| <td align="left" valign="top" width="22.105263157894736%" headers="d0e24 ">No, default is <em>true</em></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <p><span class="uicontrol">Examples</span></p> |
| <ul><li>Get and display a workspace preference:<pre><workspacePreferenceGet |
| preferenceType="compiler" |
| preferencename="problem.unusedImport" |
| PropertyName="unusedImport" /> |
| <echo message="compiler problem.unusedImport=${unusedImport}" /></pre> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div> |
| <div class="familylinks"> |
| <div class="parentlink"><strong>Parent topic:</strong> <a href="../topics/ph-antgeneral.html" title="">General Ant tasks</a></div> |
| </div> |
| <div class="reltasks"><strong>Related tasks</strong><br /> |
| <div><a href="../topics/tantcapturebuildmessages.html" title="This task captures Ant build messages and allows them to be searched or displayed, and allows conditional Ant build failures depending on whether or not a specified string is in the captured build messages.">captureBuildMessages</a></div> |
| <div><a href="../topics/tantcompilew.html" title="This task compiles the entire workspace. It performs the same action as javac. While this task is running, all the validation and other builders are turned of">compileWorkspace</a></div> |
| <div><a href="../topics/tantgetj.html" title="This task gets the error count for the last internal javac compilation of the specified project.">getJavacErrorCount</a></div> |
| <div><a href="../topics/tantgetp.html" title="This task gets the specified project information.">getProjectData</a></div> |
| <div><a href="../topics/tantproj.html" title="This task builds the specified project.">projectBuild</a></div> |
| <div><a href="../topics/tantprojectgeterrors.html" title="This task gets the errors for the specified project. It is a subset of the projectBuild task (it does not do a build, it just gets project errors regardless of how they were created)">projectGetErrors</a></div> |
| <div><a href="../topics/tantprojectimport.html" title="This task imports an existing file system project into a workspace.">projectImport</a></div> |
| <div><a href="../topics/tantprojectsetbuild.html" title="This task builds a set of Eclipse projects using an existing Eclipse team Project Set File ("PSF"). The PSF must have been first created using an Eclipse team "Project Set Export" command, and then the task projectSetImport must have been used to import those projects into a workspace.">projectSetBuild</a></div> |
| <div><a href="../topics/tantprojectsetimport.html" title="This task imports an existing Eclipse team Project Set File (PSF) into a workspace. The PSF must have been first created using an Eclipse team "Project Set Export" command.">projectSetImport</a></div> |
| <div><a href="../topics/tantsetd.html" title="This task sets the internal Java compilation debug level, and returns the current settings.">setDebugInfo</a></div> |
| <div><a href="../topics/tantworkspacebuild.html" title="This task builds the entire workspace.">workspaceBuild</a></div> |
| <div><a href="../topics/tantworkspacegeterrors.html" title="This task gets the errors for the entire workspace. It is a subset of the workspaceBuild task (it does not do a build, it just gets workspace errors regardless of how they were created).">workspaceGetErrors</a></div> |
| <div><a href="../topics/tantworkspacepreferencefile.html" title="This task reads a property file containing Eclipse workspace preferences and sets those preferences.">workspacePreferenceFile</a></div> |
| <div><a href="../topics/tantworkspacepreferenceset.html" title="This task sets Eclipse workspace preferences.">workspacePreferenceSet</a></div> |
| </div> |
| </div></body> |
| </html> |