stringprint_domainname

March 26, 2020 Contributors

Name

stringprint_domainname — Renders a domain name, respecting the raw-domain rendering mode

Synopsis

#include "controls/controls.h"

| size_t **stringprint_domainname** ( | str, |   |
|   | cc, |   |
|   | name); |   |

string * <var class="pdparam">str</var>;
command_construct * <var class="pdparam">cc</var>;
const char * <var class="pdparam">name</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

Renders a domain name, respecting the raw-domain rendering mode.

Parameters

str

the string to render into

cc

the command_construct for the session (may be NULL)

name

the raw domain name string (must not be NULL)

Return Values

the number of bytes written to the string.

If cc is NULL, the system will call ec_control_get_command_construct. It is only safe to do use stringprint_domainname with a NULL cc parameter when running on the scheduler thread.

The command construct parameter is needed by this function to determine the domain rendering mode.

This function respects the XML mode flag that is set in command_construct, and will appropriately escape special XML characters in what it emits.