File: pr_stringtonetaddr.rst

package info (click to toggle)
firefox-esr 115.14.0esr-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 3,659,200 kB
  • sloc: cpp: 6,676,648; javascript: 5,690,850; ansic: 3,328,545; python: 1,120,605; asm: 397,163; xml: 180,531; java: 178,838; sh: 68,930; makefile: 20,999; perl: 12,595; objc: 12,561; yacc: 4,583; cs: 3,846; pascal: 2,840; lex: 1,720; ruby: 1,079; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10
file content (48 lines) | stat: -rw-r--r-- 1,037 bytes parent folder | download | duplicates (16) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
PR_StringToNetAddr
==================

Converts a character string to a network address.


Syntax
------

.. code::

   #include <prnetdb.h>

   PRStatus PR_StringToNetAddr(
     const char *string,
     PRNetAddr *addr);


Parameters
~~~~~~~~~~

The function has the following parameters:

``string``
   The string to be converted.
``addr``
   On output, the equivalent network address.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, ``PR_SUCCESS``.
-  If unsuccessful, ``PR_FAILURE``. You can retrieve the reason for the
   failure by calling :ref:`PR_GetError`.


Description
-----------

For IPv4 addresses, the input string represents numbers in the Internet
standard "." notation. IPv6 addresses are indicated as strings using ":"
characters separating octets, with numerous caveats for shortcutting
(see RFC #1884). If the NSPR library and the host are configured to
support IPv6, both formats are supported. Otherwise, use of anything
other than IPv4 dotted notation results in an error.