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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/* $Id: inifile.h $ */
/** @file
* IPRT - INI-file parser.
*/
/*
* Copyright (C) 2017-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef IPRT_INCLUDED_inifile_h
#define IPRT_INCLUDED_inifile_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/types.h>
RT_C_DECLS_BEGIN
/** @defgroup grp_rt_inifile RTIniFile - INI-file parser
* @ingroup grp_rt
* @{
*/
/** @name RTINIFILE_F_XXX - INI-file open flags.
* @{ */
/** Readonly. */
#define RTINIFILE_F_READONLY RT_BIT(0)
/** Valid mask. */
#define RTINIFILE_F_VALID_MASK UINT32_C(0x00000001)
/** @} */
/**
* Creates a INI-file instance from a VFS file handle.
*
* @returns IPRT status code
* @param phIniFile Where to return the INI-file handle.
* @param hVfsFile The VFS file handle (not consumed, additional
* reference is retained).
* @param fFlags Flags, RTINIFILE_F_XXX.
*/
RTDECL(int) RTIniFileCreateFromVfsFile(PRTINIFILE phIniFile, RTVFSFILE hVfsFile, uint32_t fFlags);
/**
* Retains a reference to an INI-file instance.
*
* @returns New reference count, UINT32_MAX on failure.
* @param hIniFile The INI-file handle.
*/
RTDECL(uint32_t) RTIniFileRetain(RTINIFILE hIniFile);
/**
* Releases a reference to an INI-file instance, destroying it if the count
* reaches zero.
*
* @returns New reference count, UINT32_MAX on failure.
* @param hIniFile The INI-file handle. NIL is ignored.
*/
RTDECL(uint32_t) RTIniFileRelease(RTINIFILE hIniFile);
/**
* Queries a named value in a section.
*
* The first matching value is returned. The matching is by default case
* insensitive.
*
* @returns IPRT status code.
* @retval VERR_NOT_FOUND if section or key not found.
*
* @param hIniFile The INI-file handle.
* @param pszSection The section name. Pass NULL to refer to the
* unsectioned key space at the top of the file.
* @param pszKey The key name.
* @param pszValue Where to return the value.
* @param cbValue Size of the buffer @a pszValue points to.
* @param pcbActual Where to return the actual value size excluding
* terminator on success. On VERR_BUFFER_OVERFLOW this
* will be set to the buffer size needed to hold the
* value, terminator included. Optional.
*/
RTDECL(int) RTIniFileQueryValue(RTINIFILE hIniFile, const char *pszSection, const char *pszKey,
char *pszValue, size_t cbValue, size_t *pcbActual);
/**
* Queries a key-value pair in a section by ordinal.
*
* @returns IPRT status code.
* @retval VERR_NOT_FOUND if the section wasn't found or if it contains no pair
* with the given ordinal value.
*
* @param hIniFile The INI-file handle.
* @param pszSection The section name. Pass NULL to refer to the
* unsectioned key space at the top of the file.
* @param idxPair The pair to fetch (counting from 0).
*
* @param pszKey Where to return the key name.
* @param cbKey Size of the buffer @a pszKey points to.
* @param pcbKeyActual Where to return the actual key size excluding
* terminator on success. On VERR_BUFFER_OVERFLOW this
* will be set to the buffer size needed to hold the
* value, terminator included. Optional.
*
* @param pszValue Where to return the value.
* @param cbValue Size of the buffer @a pszValue points to.
* @param pcbValueActual Where to return the actual value size excluding
* terminator on success. On VERR_BUFFER_OVERFLOW this
* will be set to the buffer size needed to hold the
* value, terminator included. Optional.
*/
RTDECL(int) RTIniFileQueryPair(RTINIFILE hIniFile, const char *pszSection, uint32_t idxPair,
char *pszKey, size_t cbKey, size_t *pcbKeyActual,
char *pszValue, size_t cbValue, size_t *pcbValueActual);
/** @} */
RT_C_DECLS_END
#endif /* !IPRT_INCLUDED_inifile_h */
|
