VirtualBox

source: vbox/trunk/include/VBox/cfgm.h@ 5790

Last change on this file since 5790 was 4503, checked in by vboxsync, 17 years ago

CFGMR3InsertBytes should take a const data pointer.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 21.8 KB
Line 
1/** @file
2 * CFGM - Configuration Manager
3 */
4
5/*
6 * Copyright (C) 2006-2007 innotek GmbH
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 as published by the Free Software Foundation,
12 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13 * distribution. VirtualBox OSE is distributed in the hope that it will
14 * be useful, but WITHOUT ANY WARRANTY of any kind.
15 */
16
17#ifndef ___VBox_cfgm_h
18#define ___VBox_cfgm_h
19
20#include <VBox/cdefs.h>
21#include <VBox/types.h>
22#include <iprt/stdarg.h>
23
24/** @defgroup grp_cfgm The Configuration Manager API
25 * @{
26 */
27
28/** Configuration manager tree node - A key. */
29typedef struct CFGMNODE *PCFGMNODE;
30
31/** Configuration manager tree leaf - A value. */
32typedef struct CFGMLEAF *PCFGMLEAF;
33
34/**
35 * Configuration manager value type.
36 */
37typedef enum CFGMVALUETYPE
38{
39 /** Integer value. */
40 CFGMVALUETYPE_INTEGER = 1,
41 /** String value. */
42 CFGMVALUETYPE_STRING,
43 /** Bytestring value. */
44 CFGMVALUETYPE_BYTES
45} CFGMVALUETYPE;
46/** Pointer to configuration manager property type. */
47typedef CFGMVALUETYPE *PCFGMVALUETYPE;
48
49
50
51__BEGIN_DECLS
52
53#ifdef IN_RING3
54/** @defgroup grp_cfgm_r3 The CFGM Host Context Ring-3 API
55 * @ingroup grp_cfgm
56 * @{
57 */
58
59typedef enum CFGMCONFIGTYPE
60{
61 /** pvConfig points to nothing, use defaults. */
62 CFGMCONFIGTYPE_NONE = 0,
63 /** pvConfig points to a IMachine interface. */
64 CFGMCONFIGTYPE_IMACHINE
65} CFGMCONFIGTYPE;
66
67
68/**
69 * CFGM init callback for constructing the configuration tree.
70 *
71 * This is called from the emulation thread, and the one interfacing the VM
72 * can make any necessary per-thread initializations at this point.
73 *
74 * @returns VBox status code.
75 * @param pVM VM handle.
76 * @param pvUser The argument supplied to VMR3Create().
77 */
78typedef DECLCALLBACK(int) FNCFGMCONSTRUCTOR(PVM pVM, void *pvUser);
79/** Pointer to a FNCFGMCONSTRUCTOR(). */
80typedef FNCFGMCONSTRUCTOR *PFNCFGMCONSTRUCTOR;
81
82
83/**
84 * Constructs the configuration for the VM.
85 *
86 * @returns VBox status code.
87 * @param pVM Pointer to VM which configuration has not yet been loaded.
88 * @param pfnCFGMConstructor Pointer to callback function for constructing the VM configuration tree.
89 * This is called in the EM.
90 * @param pvUser The user argument passed to pfnCFGMConstructor.
91 */
92CFGMR3DECL(int) CFGMR3Init(PVM pVM, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUser);
93
94/**
95 * Terminates the configuration manager.
96 *
97 * @returns VBox status code.
98 * @param pVM VM handle.
99 */
100CFGMR3DECL(int) CFGMR3Term(PVM pVM);
101
102
103/** Tree Navigation and Enumeration.
104 * @{
105 */
106
107/**
108 * Gets the root node for the VM.
109 *
110 * @returns Pointer to root node.
111 * @param pVM VM handle.
112 */
113CFGMR3DECL(PCFGMNODE) CFGMR3GetRoot(PVM pVM);
114
115/**
116 * Gets the parent of a CFGM node.
117 *
118 * @returns Pointer to the parent node.
119 * @returns NULL if pNode is Root or pNode is the start of a
120 * restricted subtree (use CFGMr3GetParentEx() for that).
121 *
122 * @param pNode The node which parent we query.
123 */
124CFGMR3DECL(PCFGMNODE) CFGMR3GetParent(PCFGMNODE pNode);
125
126/**
127 * Gets the parent of a CFGM node.
128 *
129 * @returns Pointer to the parent node.
130 * @returns NULL if pNode is Root or pVM is not correct.
131 *
132 * @param pVM The VM handle, used as token that the caller is trusted.
133 * @param pNode The node which parent we query.
134 */
135CFGMR3DECL(PCFGMNODE) CFGMR3GetParentEx(PVM pVM, PCFGMNODE pNode);
136
137/**
138 * Query a child node.
139 *
140 * @returns Pointer to the specified node.
141 * @returns NULL if node was not found or pNode is NULL.
142 * @param pNode Node pszPath is relative to.
143 * @param pszPath Path to the child node or pNode.
144 * It's good style to end this with '/'.
145 */
146CFGMR3DECL(PCFGMNODE) CFGMR3GetChild(PCFGMNODE pNode, const char *pszPath);
147
148/**
149 * Query a child node by a format string.
150 *
151 * @returns Pointer to the specified node.
152 * @returns NULL if node was not found or pNode is NULL.
153 * @param pNode Node pszPath is relative to.
154 * @param pszPathFormat Path to the child node or pNode.
155 * It's good style to end this with '/'.
156 * @param ... Arguments to pszPathFormat.
157 */
158CFGMR3DECL(PCFGMNODE) CFGMR3GetChildF(PCFGMNODE pNode, const char *pszPathFormat, ...);
159
160/**
161 * Query a child node by a format string.
162 *
163 * @returns Pointer to the specified node.
164 * @returns NULL if node was not found or pNode is NULL.
165 * @param pNode Node pszPath is relative to.
166 * @param pszPathFormat Path to the child node or pNode.
167 * It's good style to end this with '/'.
168 * @param Args Arguments to pszPathFormat.
169 */
170CFGMR3DECL(PCFGMNODE) CFGMR3GetChildFV(PCFGMNODE pNode, const char *pszPathFormat, va_list Args);
171
172/**
173 * Gets the first child node.
174 * Use this to start an enumeration of child nodes.
175 *
176 * @returns Pointer to the first child.
177 * @returns NULL if no children.
178 * @param pNode Node to enumerate children for.
179 */
180CFGMR3DECL(PCFGMNODE) CFGMR3GetFirstChild(PCFGMNODE pNode);
181
182/**
183 * Gets the next sibling node.
184 * Use this to continue an enumeration.
185 *
186 * @returns Pointer to the first child.
187 * @returns NULL if no children.
188 * @param pCur Node to returned by a call to CFGMR3GetFirstChild()
189 * or successive calls to this function.
190 */
191CFGMR3DECL(PCFGMNODE) CFGMR3GetNextChild(PCFGMNODE pCur);
192
193/**
194 * Gets the name of the current node.
195 * (Needed for enumeration.)
196 *
197 * @returns VBox status code.
198 * @param pCur Node to returned by a call to CFGMR3GetFirstChild()
199 * or successive calls to CFGMR3GetNextChild().
200 * @param pszName Where to store the node name.
201 * @param cchName Size of the buffer pointed to by pszName (with terminator).
202 */
203CFGMR3DECL(int) CFGMR3GetName(PCFGMNODE pCur, char *pszName, size_t cchName);
204
205/**
206 * Gets the length of the current node's name.
207 * (Needed for enumeration.)
208 *
209 * @returns Node name length in bytes including the terminating null char.
210 * @returns 0 if pCur is NULL.
211 * @param pCur Node returned by a call to CFGMR3GetFirstChild()
212 * or successive calls to CFGMR3GetNextChild().
213 */
214CFGMR3DECL(int) CFGMR3GetNameLen(PCFGMNODE pCur);
215
216/**
217 * Validates that the child nodes are within a set of valid names.
218 *
219 * @returns true if all names are found in pszzAllowed.
220 * @returns false if not.
221 * @param pNode The node which values should be examined.
222 * @param pszzValid List of valid names separated by '\\0' and ending with
223 * a double '\\0'.
224 */
225CFGMR3DECL(bool) CFGMR3AreChildrenValid(PCFGMNODE pNode, const char *pszzValid);
226
227
228/**
229 * Gets the first value of a node.
230 * Use this to start an enumeration of values.
231 *
232 * @returns Pointer to the first value.
233 * @param pCur The node (Key) which values to enumerate.
234 */
235CFGMR3DECL(PCFGMLEAF) CFGMR3GetFirstValue(PCFGMNODE pCur);
236
237/**
238 * Gets the next value in enumeration.
239 *
240 * @returns Pointer to the next value.
241 * @param pCur The current value as returned by this function or CFGMR3GetFirstValue().
242 */
243CFGMR3DECL(PCFGMLEAF) CFGMR3GetNextValue(PCFGMLEAF pCur);
244
245/**
246 * Get the value name.
247 * (Needed for enumeration.)
248 *
249 * @returns VBox status code.
250 * @param pCur Value returned by a call to CFGMR3GetFirstValue()
251 * or successive calls to CFGMR3GetNextValue().
252 * @param pszName Where to store the value name.
253 * @param cchName Size of the buffer pointed to by pszName (with terminator).
254 */
255CFGMR3DECL(int) CFGMR3GetValueName(PCFGMLEAF pCur, char *pszName, size_t cchName);
256
257/**
258 * Gets the length of the current node's name.
259 * (Needed for enumeration.)
260 *
261 * @returns Value name length in bytes including the terminating null char.
262 * @returns 0 if pCur is NULL.
263 * @param pCur Value returned by a call to CFGMR3GetFirstValue()
264 * or successive calls to CFGMR3GetNextValue().
265 */
266CFGMR3DECL(int) CFGMR3GetValueNameLen(PCFGMLEAF pCur);
267
268/**
269 * Gets the value type.
270 * (For enumeration.)
271 *
272 * @returns VBox status code.
273 * @param pCur Value returned by a call to CFGMR3GetFirstValue()
274 * or successive calls to CFGMR3GetNextValue().
275 */
276CFGMR3DECL(CFGMVALUETYPE) CFGMR3GetValueType(PCFGMLEAF pCur);
277
278/**
279 * Validates that the values are within a set of valid names.
280 *
281 * @returns true if all names are found in pszzAllowed.
282 * @returns false if not.
283 * @param pNode The node which values should be examined.
284 * @param pszzValid List of valid names separated by '\\0' and ending with
285 * a double '\\0'.
286 */
287CFGMR3DECL(bool) CFGMR3AreValuesValid(PCFGMNODE pNode, const char *pszzValid);
288
289/** @} */
290
291/**
292 * Query value type.
293 *
294 * @returns VBox status code.
295 * @param pNode Which node to search for pszName in.
296 * @param pszName Name of an integer value.
297 * @param penmType Where to store the type.
298 */
299CFGMR3DECL(int) CFGMR3QueryType(PCFGMNODE pNode, const char *pszName, PCFGMVALUETYPE penmType);
300
301/**
302 * Query value size.
303 * This works on all types of values.
304 *
305 * @returns VBox status code.
306 * @param pNode Which node to search for pszName in.
307 * @param pszName Name of an integer value.
308 * @param pcb Where to store the value size.
309 */
310CFGMR3DECL(int) CFGMR3QuerySize(PCFGMNODE pNode, const char *pszName, size_t *pcb);
311
312/**
313 * Query integer value.
314 *
315 * @returns VBox status code.
316 * @param pNode Which node to search for pszName in.
317 * @param pszName Name of an integer value.
318 * @param pu64 Where to store the integer value.
319 */
320CFGMR3DECL(int) CFGMR3QueryInteger(PCFGMNODE pNode, const char *pszName, uint64_t *pu64);
321
322/**
323 * Query zero terminated character value.
324 *
325 * @returns VBox status code.
326 * @param pNode Which node to search for pszName in.
327 * @param pszName Name of a zero terminate character value.
328 * @param pszString Where to store the string.
329 * @param cchString Size of the string buffer. (Includes terminator.)
330 */
331CFGMR3DECL(int) CFGMR3QueryString(PCFGMNODE pNode, const char *pszName, char *pszString, size_t cchString);
332
333/**
334 * Query byte string value.
335 *
336 * @returns VBox status code.
337 * @param pNode Which node to search for pszName in.
338 * @param pszName Name of a byte string value.
339 * @param pvData Where to store the binary data.
340 * @param cbData Size of buffer pvData points too.
341 */
342CFGMR3DECL(int) CFGMR3QueryBytes(PCFGMNODE pNode, const char *pszName, void *pvData, size_t cbData);
343
344
345/**
346 * Creates a CFGM tree.
347 *
348 * This is intended for creating device/driver configs can be
349 * passed around and later attached to the main tree in the
350 * correct location.
351 *
352 * @returns Pointer to the root node.
353 * @param pVM The VM handle.
354 */
355CFGMR3DECL(PCFGMNODE) CFGMR3CreateTree(PVM pVM);
356
357/**
358 * Insert subtree.
359 *
360 * This function inserts (no duplication) a tree created by CFGMR3CreateTree()
361 * into the main tree.
362 *
363 * The root node of the inserted subtree will need to be reallocated, which
364 * effectually means that the passed in pSubTree handle becomes invalid
365 * upon successful return. Use the value returned in ppChild instead
366 * of pSubTree.
367 *
368 * @returns VBox status code.
369 * @returns VERR_CFGM_NODE_EXISTS if the final child node name component exists.
370 * @param pNode Parent node.
371 * @param pszName Name or path of the new child node.
372 * @param pSubTree The subtree to insert. Must be returned by CFGMR3CreateTree().
373 * @param ppChild Where to store the address of the new child node. (optional)
374 */
375CFGMR3DECL(int) CFGMR3InsertSubTree(PCFGMNODE pNode, const char *pszName, PCFGMNODE pSubTree, PCFGMNODE *ppChild);
376
377/**
378 * Insert a node.
379 *
380 * @returns VBox status code.
381 * @returns VERR_CFGM_NODE_EXISTS if the final child node name component exists.
382 * @param pNode Parent node.
383 * @param pszName Name or path of the new child node.
384 * @param ppChild Where to store the address of the new child node. (optional)
385 */
386CFGMR3DECL(int) CFGMR3InsertNode(PCFGMNODE pNode, const char *pszName, PCFGMNODE *ppChild);
387
388/**
389 * Insert a node, format string name.
390 *
391 * @returns VBox status code.
392 * @param pNode Parent node.
393 * @param ppChild Where to store the address of the new child node. (optional)
394 * @param pszNameFormat Name or path of the new child node.
395 * @param ... Name format arguments.
396 */
397CFGMR3DECL(int) CFGMR3InsertNodeF(PCFGMNODE pNode, PCFGMNODE *ppChild, const char *pszNameFormat, ...);
398
399/**
400 * Insert a node, format string name.
401 *
402 * @returns VBox status code.
403 * @param pNode Parent node.
404 * @param ppChild Where to store the address of the new child node. (optional)
405 * @param pszNameFormat Name or path of the new child node.
406 * @param Args Name format arguments.
407 */
408CFGMR3DECL(int) CFGMR3InsertNodeFV(PCFGMNODE pNode, PCFGMNODE *ppChild, const char *pszNameFormat, va_list Args);
409
410/**
411 * Marks the node as the root of a restricted subtree, i.e. the end of
412 * a CFGMR3GetParent() journey.
413 *
414 * @param pNode The node to mark.
415 */
416CFGMR3DECL(void) CFGMR3SetRestrictedRoot(PCFGMNODE pNode);
417
418/**
419 * Remove a node.
420 *
421 * @param pNode Parent node.
422 */
423CFGMR3DECL(void) CFGMR3RemoveNode(PCFGMNODE pNode);
424
425
426/**
427 * Inserts a new integer value.
428 *
429 * @returns VBox status code.
430 * @param pNode Parent node.
431 * @param pszName Value name.
432 * @param u64Integer The value.
433 */
434CFGMR3DECL(int) CFGMR3InsertInteger(PCFGMNODE pNode, const char *pszName, uint64_t u64Integer);
435
436/**
437 * Inserts a new string value.
438 *
439 * @returns VBox status code.
440 * @param pNode Parent node.
441 * @param pszName Value name.
442 * @param pszString The value.
443 */
444CFGMR3DECL(int) CFGMR3InsertString(PCFGMNODE pNode, const char *pszName, const char *pszString);
445
446/**
447 * Inserts a new integer value.
448 *
449 * @returns VBox status code.
450 * @param pNode Parent node.
451 * @param pszName Value name.
452 * @param pvBytes The value.
453 * @param cbBytes The value size.
454 */
455CFGMR3DECL(int) CFGMR3InsertBytes(PCFGMNODE pNode, const char *pszName, const void *pvBytes, size_t cbBytes);
456
457/**
458 * Remove a value.
459 *
460 * @returns VBox status code.
461 * @param pNode Parent node.
462 * @param pszName Name of the new child node.
463 */
464CFGMR3DECL(int) CFGMR3RemoveValue(PCFGMNODE pNode, const char *pszName);
465
466
467
468/** Helpers
469 * @{
470 */
471/**
472 * Query unsigned 64-bit integer value.
473 *
474 * @returns VBox status code.
475 * @param pNode Which node to search for pszName in.
476 * @param pszName Name of an integer value.
477 * @param pu64 Where to store the integer value.
478 */
479CFGMR3DECL(int) CFGMR3QueryU64(PCFGMNODE pNode, const char *pszName, uint64_t *pu64);
480
481/**
482 * Query signed 64-bit integer value.
483 *
484 * @returns VBox status code.
485 * @param pNode Which node to search for pszName in.
486 * @param pszName Name of an integer value.
487 * @param pi64 Where to store the value.
488 */
489CFGMR3DECL(int) CFGMR3QueryS64(PCFGMNODE pNode, const char *pszName, int64_t *pi64);
490
491/**
492 * Query unsigned 32-bit integer value.
493 *
494 * @returns VBox status code.
495 * @param pNode Which node to search for pszName in.
496 * @param pszName Name of an integer value.
497 * @param pu32 Where to store the value.
498 */
499CFGMR3DECL(int) CFGMR3QueryU32(PCFGMNODE pNode, const char *pszName, uint32_t *pu32);
500
501/**
502 * Query signed 32-bit integer value.
503 *
504 * @returns VBox status code.
505 * @param pNode Which node to search for pszName in.
506 * @param pszName Name of an integer value.
507 * @param pi32 Where to store the value.
508 */
509CFGMR3DECL(int) CFGMR3QueryS32(PCFGMNODE pNode, const char *pszName, int32_t *pi32);
510
511/**
512 * Query unsigned 16-bit integer value.
513 *
514 * @returns VBox status code.
515 * @param pNode Which node to search for pszName in.
516 * @param pszName Name of an integer value.
517 * @param pu16 Where to store the value.
518 */
519CFGMR3DECL(int) CFGMR3QueryU16(PCFGMNODE pNode, const char *pszName, uint16_t *pu16);
520
521/**
522 * Query signed 16-bit integer value.
523 *
524 * @returns VBox status code.
525 * @param pNode Which node to search for pszName in.
526 * @param pszName Name of an integer value.
527 * @param pi16 Where to store the value.
528 */
529CFGMR3DECL(int) CFGMR3QueryS16(PCFGMNODE pNode, const char *pszName, int16_t *pi16);
530
531/**
532 * Query unsigned 8-bit integer value.
533 *
534 * @returns VBox status code.
535 * @param pNode Which node to search for pszName in.
536 * @param pszName Name of an integer value.
537 * @param pu8 Where to store the value.
538 */
539CFGMR3DECL(int) CFGMR3QueryU8(PCFGMNODE pNode, const char *pszName, uint8_t *pu8);
540
541/**
542 * Query signed 8-bit integer value.
543 *
544 * @returns VBox status code.
545 * @param pNode Which node to search for pszName in.
546 * @param pszName Name of an integer value.
547 * @param pi8 Where to store the value.
548 */
549CFGMR3DECL(int) CFGMR3QueryS8(PCFGMNODE pNode, const char *pszName, int8_t *pi8);
550
551/**
552 * Query boolean integer value.
553 *
554 * @returns VBox status code.
555 * @param pNode Which node to search for pszName in.
556 * @param pszName Name of an integer value.
557 * @param pf Where to store the value.
558 * @remark This function will interpret any non-zero value as true.
559 */
560CFGMR3DECL(int) CFGMR3QueryBool(PCFGMNODE pNode, const char *pszName, bool *pf);
561
562/**
563 * Query pointer integer value.
564 *
565 * @returns VBox status code.
566 * @param pNode Which node to search for pszName in.
567 * @param pszName Name of an integer value.
568 * @param ppv Where to store the value.
569 */
570CFGMR3DECL(int) CFGMR3QueryPtr(PCFGMNODE pNode, const char *pszName, void **ppv);
571
572/**
573 * Query Guest Context pointer integer value.
574 *
575 * @returns VBox status code.
576 * @param pNode Which node to search for pszName in.
577 * @param pszName Name of an integer value.
578 * @param pGCPtr Where to store the value.
579 */
580CFGMR3DECL(int) CFGMR3QueryGCPtr(PCFGMNODE pNode, const char *pszName, PRTGCPTR pGCPtr);
581
582/**
583 * Query Guest Context unsigned pointer value.
584 *
585 * @returns VBox status code.
586 * @param pNode Which node to search for pszName in.
587 * @param pszName Name of an integer value.
588 * @param pGCPtr Where to store the value.
589 */
590CFGMR3DECL(int) CFGMR3QueryGCPtrU(PCFGMNODE pNode, const char *pszName, PRTGCUINTPTR pGCPtr);
591
592/**
593 * Query Guest Context signed pointer value.
594 *
595 * @returns VBox status code.
596 * @param pNode Which node to search for pszName in.
597 * @param pszName Name of an integer value.
598 * @param pGCPtr Where to store the value.
599 */
600CFGMR3DECL(int) CFGMR3QueryGCPtrS(PCFGMNODE pNode, const char *pszName, PRTGCINTPTR pGCPtr);
601
602/**
603 * Query boolean integer value.
604 *
605 * @returns VBox status code.
606 * @param pNode Which node to search for pszName in.
607 * @param pszName Name of an integer value.
608 * @param pvValue Where to store the value.
609 * @param cbValue The size of the integer value (in bytes).
610 * @param fSigned Whether the integer is signed (true) or not (false).
611 * @remark This function will interpret any non-zero value as true.
612 */
613DECLINLINE(int) CFGMR3QueryIntegerBySize(PCFGMNODE pNode, const char *pszName, void *pvValue, size_t cbValue, bool fSigned)
614{
615 int rc;
616 if (fSigned)
617 {
618 switch (cbValue)
619 {
620 case 8: rc = CFGMR3QueryS8(pNode, pszName, (int8_t *)pvValue); break;
621 case 16: rc = CFGMR3QueryS16(pNode, pszName, (int16_t *)pvValue); break;
622 case 32: rc = CFGMR3QueryS32(pNode, pszName, (int32_t *)pvValue); break;
623 case 64: rc = CFGMR3QueryS64(pNode, pszName, (int64_t *)pvValue); break;
624 default: rc = -1 /* VERR_GENERAL_FAILURE*/; break;
625 }
626 }
627 else
628 {
629 switch (cbValue)
630 {
631 case 8: rc = CFGMR3QueryU8(pNode, pszName, (uint8_t *)pvValue); break;
632 case 16: rc = CFGMR3QueryU16(pNode, pszName, (uint16_t *)pvValue); break;
633 case 32: rc = CFGMR3QueryU32(pNode, pszName, (uint32_t *)pvValue); break;
634 case 64: rc = CFGMR3QueryU64(pNode, pszName, (uint64_t *)pvValue); break;
635 default: rc = -1 /* VERR_GENERAL_FAILURE*/; break;
636 }
637 }
638 return rc;
639}
640
641
642/**
643 * Query I/O port address value (integer).
644 *
645 * @returns VBox status code.
646 * @param pNode Which node to search for pszName in.
647 * @param pszName Name of an integer value.
648 * @param pPort Where to store the value.
649 */
650DECLINLINE(int) CFGMR3QueryPort(PCFGMNODE pNode, const char *pszName, PRTIOPORT pPort)
651{
652 return CFGMR3QueryIntegerBySize(pNode, pszName, pPort, sizeof(*pPort), false);
653}
654
655
656
657/**
658 * Query zero terminated character value storing it in a
659 * buffer allocated from the MM heap.
660 *
661 * @returns VBox status code.
662 * @param pNode Which node to search for pszName in.
663 * @param pszName Value name. This value must be of zero terminated character string type.
664 * @param ppszString Where to store the string pointer.
665 * Free this using MMR3HeapFree().
666 */
667CFGMR3DECL(int) CFGMR3QueryStringAlloc(PCFGMNODE pNode, const char *pszName, char **ppszString);
668
669/** @} */
670
671
672/**
673 * Dumps the configuration (sub)tree.
674 *
675 * @param pRoot The root node of the dump.
676 */
677CFGMR3DECL(void) CFGMR3Dump(PCFGMNODE pRoot);
678
679/** @} */
680#endif /* IN_RING3 */
681
682
683__END_DECLS
684
685/** @} */
686
687#endif
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