Htmlent

From Mailutils

(Difference between revisions)
Jump to: navigation, search
(Created page with "'''Htmlent''' is a filter that converts characters '''<''', '''>''', and '''&''' to their corresponding [http://en.wikipedia.org/wiki/Character_entity_reference HTML entites] and...")
m
 
(3 intermediate revisions not shown)
Line 1: Line 1:
-
'''Htmlent''' is a filter that converts characters '''<''', '''>''', and '''&''' to their corresponding [http://en.wikipedia.org/wiki/Character_entity_reference HTML entites] and vice-versa.
+
The <tt>htmlent</tt> filter converts characters '''<''', '''>''', and '''&''' to their corresponding [http://en.wikipedia.org/wiki/Character_entity_reference HTML entites] and vice-versa.
In ''encode'' mode, the filter replaces each occurrence of these characters with the corresponding named entity.  In ''decode'' mode the reverse operation is performed.
In ''encode'' mode, the filter replaces each occurrence of these characters with the corresponding named entity.  In ''decode'' mode the reverse operation is performed.
 +
The filter does not take arguments.
 +
 +
The following object, declared in '''mailutils/filter.h''' describes the ''htmlent'' filter:
 +
 +
<source lang="C">
 +
extern mu_filter_record_t mu_htmlent_filter;
 +
</source>
 +
 +
The example below shows how to create an instance of this filter in decode mode for reading:
 +
 +
<source lang="C">
 +
  int rc;          /* Return code */
 +
  mu_stream_t flt; /* Filter stream */
 +
  mu_stream_t input; /* Input stream */
 +
 +
  initialize_input_stream (&input);
 +
  rc = mu_filter_create (&flt, input, "htmlent", MU_FILTER_DECODE, MU_STREAM_READ);
 +
</source>
 +
 +
 +
== See also ==
 +
 +
* [[xml (filter)|xml]] filter
[[Category:Filters]]
[[Category:Filters]]
[[Category:C API]]
[[Category:C API]]

Latest revision as of 19:11, 5 September 2015

The htmlent filter converts characters <, >, and & to their corresponding HTML entites and vice-versa.

In encode mode, the filter replaces each occurrence of these characters with the corresponding named entity. In decode mode the reverse operation is performed.

The filter does not take arguments.

The following object, declared in mailutils/filter.h describes the htmlent filter:

extern mu_filter_record_t mu_htmlent_filter;

The example below shows how to create an instance of this filter in decode mode for reading:

  int rc;          /* Return code */
  mu_stream_t flt; /* Filter stream */
  mu_stream_t input; /* Input stream */
 
  initialize_input_stream (&input);
  rc = mu_filter_create (&flt, input, "htmlent", MU_FILTER_DECODE, MU_STREAM_READ);


See also

Personal tools