Display the source code in std/xml.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Function `std.xml.encode`

Encodes a string by replacing all characters which need to be escaped with appropriate predefined XML entities.


						
				S encode(S)
				(
				

				  S s
				

				);

encode() escapes certain characters (ampersand, quote, apostrophe, less-than and greater-than), and similarly, decode() unescapes them. These functions are provided for convenience only. You do not need to use them when using the std.xml classes, because then all the encoding and decoding will be done for you automatically.

If the string is not modified, the original will be returned.

Standards

XML 1.0

Parameters

Name	Description
s	The string to be encoded

Returns

The encoded string

Example

writefln(encode("a > b")); // writes "a &gt; b"

Authors

Janice Caron

License

Boost License 1.0.