Global Functions in Namespace in Sourcefile uri.h

Class

Index

Help

Global Functions in Global Namespace C++
in Sourcefile uri.h

rtl_getUriCharClass

extern "C"
const sal_Bool * rtl_getUriCharClass(

eCharClass );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Map a predefined rtl_UriCharClass to a form usable by rtl_uriEncode().

Parameters

eCharClass

    Any valid member of rtl_UriCharClass.

Return

An array of 128 booleans, to be used in calls to rtl_uriEncode().

rtl_uriDecode

extern "C"
void rtl_uriDecode(

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Decode (a part of) a URI.

Parameters

pText	Any Unicode string. Must not be null. (If the input is indeed part of a valid URI, this string will only contain a subset of the ASCII characters, but this function also handles other Unicode characters properly.)
eMechanism	The mechanism describing how the input text is translated into a Unicode string.
eCharset	When the decode mechanism is rtl_UriDecodeWithCharset, all escape sequences in the input text are interpreted as characters from this charset. Those characters are translated to Unicode characters in the resulting output, if possible. When the decode mechanism is rtl_UriDecodeNone or rtl_UriDecodeToIuri, this parameter is ignored (and is best specified as RTL_TEXTENCODING_UTF8).
pResult	Returns a decoded representation of the input text. Must itself not be null, and must point to either null or a valid string.

rtl_uriEncode

extern "C"
void rtl_uriEncode(

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Encode a text as (part of) a URI.

Parameters

pText	Any Unicode string. Must not be null.
pCharClass	A char class, represented as an array of 128 booleans (true means keep the corresponding ASCII character unencoded, false means encode it). Must not be null, and the boolean corresponding to the percent sign (0x25) must be false. (See rtl_getUriCharClass() for a function mapping from rtl_UriCharClass to such arrays.)
eMechanism	The mechanism describing how escape sequences in the input text are handled.
eCharset	When Unicode characters from the input text have to be written using escape sequences (because they are either outside the ASCII range or do not belong to the given char class), they are first translated into this charset before being encoded using escape sequences. Also, if the encode mechanism is rtl_UriEncodeCheckEscapes, all escape sequences already present in the input text are interpreted as characters from this charset.
pResult	Returns an encoded representation of the input text. Must itself not be null, and must point to either null or a valid string.