|
- <!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
- <html>
- <head>
- <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
- <title>LoadResource Task</title>
- </head>
-
- <body>
-
-
- <h2><a name="loadresource">LoadResource</a></h2>
-
- <p><em>Since Ant 1.7</em></p>
-
- <h3>Description</h3>
- <p>
- Load a text resource into a single property. Unless an encoding is
- specified, the encoding of the current locale is used. Resources to
- load are specified as nested <a
- href="../CoreTypes/resources.html">resource</a> elements or single
- element resource collections.
- </p>
-
- <h3>Parameters</h3>
- <table border="1" cellpadding="2" cellspacing="0">
- <tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
- </tr>
- <tr>
- <td valign="top">property</td>
- <td valign="top">property to save to</td>
- <td valign="top" align="center">Yes</td>
- </tr>
- <tr>
- <td valign="top">encoding</td>
- <td valign="top">encoding to use when loading the resource</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">failonerror</td>
- <td valign="top">Whether to halt the build on failure</td>
- <td align="center" valign="top">No, default "true"</td>
- </tr>
- <tr>
- <td valign="top">quiet</td>
- <td valign="top">Do not display a diagnostic message (unless Ant has been
- invoked with the <code>-verbose</code> or <code>-debug</code>
- switches) or modify the exit status to reflect an error. Setting this to
- "true" implies setting failonerror to "false".
- </td>
- <td align="center" valign="top">No, default "false"</td>
- </tr>
- </table>
- <p>
- The LoadResource task supports nested <a href="../CoreTypes/filterchain.html">
- FilterChain</a>s.
-
- <h3>Examples</h3>
- <pre>
- <loadresource property="homepage">
- <url url="http://ant.apache.org/index.html"/>
- </loadresource>
- </pre>
- Load the entry point of Ant's homepage into property "homepage"; an
- <tt><echo></tt> can print this.
-
- <p>For more examples see the <a href="loadfile.html">loadfile</a> task.</p>
-
-
- </body>
- </html>
|