VirtualBox

source: vbox/trunk/src/VBox/Additions/common/VBoxService/VBoxServicePropCache.h@ 83826

Last change on this file since 83826 was 82968, checked in by vboxsync, 5 years 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.3 KB
Line 
1/* $Id: */
2/** @file
3 * VBoxServicePropCache - Guest property cache.
4 */
5
6/*
7 * Copyright (C) 2010-2020 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef GA_INCLUDED_SRC_common_VBoxService_VBoxServicePropCache_h
19#define GA_INCLUDED_SRC_common_VBoxService_VBoxServicePropCache_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24#include "VBoxServiceInternal.h"
25
26#ifdef VBOX_WITH_GUEST_PROPS
27
28/** @name VGSVCPROPCACHE_FLAG_XXX - Guest Property Cache Flags.
29 * @{ */
30/** Indicates wheter a guest property is temporary and either should
31 * - a) get a "reset" value assigned (via VBoxServicePropCacheUpdateEntry)
32 * as soon as the property cache gets destroyed, or
33 * - b) get deleted when no reset value is specified.
34 */
35# define VGSVCPROPCACHE_FLAGS_TEMPORARY RT_BIT(1)
36/** Indicates whether a property every time needs to be updated, regardless
37 * if its real value changed or not. */
38# define VGSVCPROPCACHE_FLAGS_ALWAYS_UPDATE RT_BIT(2)
39/** The guest property gets deleted when
40 * - a) the property cache gets destroyed, or
41 * - b) the VM gets reset / shutdown / destroyed.
42 */
43# define VGSVCPROPCACHE_FLAGS_TRANSIENT RT_BIT(3)
44/** @} */
45
46int VGSvcPropCacheCreate(PVBOXSERVICEVEPROPCACHE pCache, uint32_t uClientId);
47int VGSvcPropCacheUpdateEntry(PVBOXSERVICEVEPROPCACHE pCache, const char *pszName, uint32_t fFlags, const char *pszValueReset);
48int VGSvcPropCacheUpdate(PVBOXSERVICEVEPROPCACHE pCache, const char *pszName, const char *pszValueFormat, ...);
49int VGSvcPropCacheUpdateByPath(PVBOXSERVICEVEPROPCACHE pCache, const char *pszValue, uint32_t fFlags,
50 const char *pszPathFormat, ...);
51int VGSvcPropCacheFlush(PVBOXSERVICEVEPROPCACHE pCache);
52void VGSvcPropCacheDestroy(PVBOXSERVICEVEPROPCACHE pCache);
53#endif /* VBOX_WITH_GUEST_PROPS */
54
55#endif /* !GA_INCLUDED_SRC_common_VBoxService_VBoxServicePropCache_h */
56
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