VirtualBox

source: vbox/trunk/include/iprt/cidr.h@ 103224

Last change on this file since 103224 was 98103, checked in by vboxsync, 21 months ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.5 KB
Line 
1/** @file
2 * IPRT - TCP/IP.
3 */
4
5/*
6 * Copyright (C) 2008-2023 Oracle and/or its affiliates.
7 *
8 * This file is part of VirtualBox base platform packages, as
9 * available from https://www.virtualbox.org.
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation, in version 3 of the
14 * License.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <https://www.gnu.org/licenses>.
23 *
24 * The contents of this file may alternatively be used under the terms
25 * of the Common Development and Distribution License Version 1.0
26 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
27 * in the VirtualBox distribution, in which case the provisions of the
28 * CDDL are applicable instead of those of the GPL.
29 *
30 * You may elect to license modified versions of this file under the
31 * terms and conditions of either the GPL or the CDDL or both.
32 *
33 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
34 */
35
36#ifndef IPRT_INCLUDED_cidr_h
37#define IPRT_INCLUDED_cidr_h
38#ifndef RT_WITHOUT_PRAGMA_ONCE
39# pragma once
40#endif
41
42#include <iprt/cdefs.h>
43#include <iprt/types.h>
44#include <iprt/net.h>
45
46/** @defgroup grp_rt_cidr RTCidr - Classless Inter-Domain Routing notation
47 * @ingroup grp_rt
48 * @{
49 */
50RT_C_DECLS_BEGIN
51
52/**
53 * Parse a string which contains an IP address in CIDR (Classless
54 * Inter-Domain Routing) notation.
55 *
56 * @warning The network address and the network mask are returned in
57 * @b host(!) byte order. This is different from all the other
58 * RTNetStrTo* functions.
59 *
60 * @deprecated This function is superseded by RTNetStrToIPv4Cidr()
61 * that provides a better API consistent with other functions
62 * from that family. It returns the prefix length, if you need a
63 * netmask, you can obtain it with RTNetPrefixToMaskIPv4().
64 *
65 * @return iprt status code.
66 *
67 * @param pszAddress The IP address in CIDR specificaion.
68 * @param pNetwork The determined IP address / network in host byte order.
69 * @param pNetmask The determined netmask in host byte order.
70 */
71RTDECL(int) RTCidrStrToIPv4(const char *pszAddress, PRTNETADDRIPV4 pNetwork, PRTNETADDRIPV4 pNetmask);
72
73RT_C_DECLS_END
74/** @} */
75
76#endif /* !IPRT_INCLUDED_cidr_h */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette