VirtualBox

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

Last change on this file since 90057 was 87339, checked in by vboxsync, 4 years ago

IPRT/net: Document that RTCidrStrToIPv4() is deprecated. bugref:9330

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.2 KB
Line 
1/** @file
2 * IPRT - TCP/IP.
3 */
4
5/*
6 * Copyright (C) 2008-2020 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef IPRT_INCLUDED_cidr_h
27#define IPRT_INCLUDED_cidr_h
28#ifndef RT_WITHOUT_PRAGMA_ONCE
29# pragma once
30#endif
31
32#include <iprt/cdefs.h>
33#include <iprt/types.h>
34#include <iprt/net.h>
35
36/** @defgroup grp_rt_cidr RTCidr - Classless Inter-Domain Routing notation
37 * @ingroup grp_rt
38 * @{
39 */
40RT_C_DECLS_BEGIN
41
42/**
43 * Parse a string which contains an IP address in CIDR (Classless
44 * Inter-Domain Routing) notation.
45 *
46 * @warning The network address and the network mask are returned in
47 * @b host(!) byte order. This is different from all the other
48 * RTNetStrTo* functions.
49 *
50 * @deprecated This function is superseded by RTNetStrToIPv4Cidr()
51 * that provides a better API consistent with other functions
52 * from that family. It returns the prefix length, if you need a
53 * netmask, you can obtain it with RTNetPrefixToMaskIPv4().
54 *
55 * @return iprt status code.
56 *
57 * @param pszAddress The IP address in CIDR specificaion.
58 * @param pNetwork The determined IP address / network in host byte order.
59 * @param pNetmask The determined netmask in host byte order.
60 */
61RTDECL(int) RTCidrStrToIPv4(const char *pszAddress, PRTNETADDRIPV4 pNetwork, PRTNETADDRIPV4 pNetmask);
62
63RT_C_DECLS_END
64/** @} */
65
66#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