Changeset 79899 in vbox
- Timestamp:
- Jul 19, 2019 5:56:08 PM (6 years ago)
- Location:
- trunk
- Files:
-
- 3 edited
- 1 copied
Legend:
- Unmodified
- Added
- Removed
-
trunk/Makefile.kmk
r79896 r79899 832 832 $(PATH_ROOT)/include/VBox/version.h \ 833 833 \ 834 $(PATH_ROOT)/include/VBox/com/com.h 834 $(PATH_ROOT)/include/VBox/com/com.h \ 835 $(PATH_ROOT)/include/VBox/com/utils.h 835 836 836 837 VBOX_CORE_DOXYFILE_INPUT := \ -
trunk/include/VBox/com/com.h
r78108 r79899 31 31 32 32 #include "VBox/com/defs.h" 33 #include "VBox/com/utils.h" 33 34 34 35 /** @defgroup grp_com MS COM / XPCOM Abstraction Layer … … 81 82 void GetInterfaceNameByIID(const GUID &aIID, BSTR *aName); 82 83 83 /**84 * Returns the VirtualBox user home directory.85 *86 * On failure, this function will return a path that caused a failure (or87 * NULL if the failure is not path-related).88 *89 * On success, this function will try to create the returned directory if it90 * doesn't exist yet. This may also fail with the corresponding status code.91 *92 * If @a aDirLen is smaller than RTPATH_MAX then there is a great chance that93 * this method will return VERR_BUFFER_OVERFLOW.94 *95 * @param aDir Buffer to store the directory string in UTF-8 encoding.96 * @param aDirLen Length of the supplied buffer including space for the97 * terminating null character, in bytes.98 * @param fCreateDir Flag whether to create the returned directory on success if it99 * doesn't exist.100 * @return VBox status code.101 */102 int GetVBoxUserHomeDirectory(char *aDir, size_t aDirLen, bool fCreateDir = true);103 104 /**105 * Creates a release log file, used both in VBoxSVC and in API clients.106 *107 * @param pcszEntity Human readable name of the program.108 * @param pcszLogFile Name of the release log file.109 * @param fFlags Logger instance flags.110 * @param pcszGroupSettings Group logging settings.111 * @param pcszEnvVarBase Base environment variable name for the logger.112 * @param fDestFlags Logger destination flags.113 * @param cMaxEntriesPerGroup Limit for log entries per group. UINT32_MAX for no limit.114 * @param cHistory Number of old log files to keep.115 * @param uHistoryFileTime Maximum amount of time to put in a log file.116 * @param uHistoryFileSize Maximum size of a log file before rotating.117 * @param pErrInfo Where to return extended error information.118 * Optional.119 *120 * @return VBox status code.121 */122 int VBoxLogRelCreate(const char *pcszEntity, const char *pcszLogFile,123 uint32_t fFlags, const char *pcszGroupSettings,124 const char *pcszEnvVarBase, uint32_t fDestFlags,125 uint32_t cMaxEntriesPerGroup, uint32_t cHistory,126 uint32_t uHistoryFileTime, uint64_t uHistoryFileSize,127 PRTERRINFO pErrInfo);128 129 84 #ifdef RT_OS_WINDOWS 130 85 void PatchComBugs(void); -
trunk/include/VBox/com/utils.h
r79882 r79899 24 24 */ 25 25 26 #ifndef VBOX_INCLUDED_com_ com_h27 #define VBOX_INCLUDED_com_ com_h26 #ifndef VBOX_INCLUDED_com_utils_h 27 #define VBOX_INCLUDED_com_utils_h 28 28 #ifndef RT_WITHOUT_PRAGMA_ONCE 29 29 # pragma once 30 30 #endif 31 31 32 #include " VBox/com/defs.h"32 #include "iprt/types.h" 33 33 34 /** @ defgroup grp_com MS COM / XPCOM Abstraction Layer34 /** @addtogroup grp_com 35 35 * @{ 36 36 */ … … 39 39 { 40 40 41 /** @name VBOX_COM_INIT_F_XXX - flags for com::Initialize().42 * @{ */43 /** Windows: Caller is the GUI and needs a STA rather than MTA apartment. */44 #define VBOX_COM_INIT_F_GUI RT_BIT_32(0)45 /** Windows: Auto registration updating, if privileged enough. */46 #define VBOX_COM_INIT_F_AUTO_REG_UPDATE RT_BIT_32(1)47 /** Windows: Opt-out of COM patching (client code should do this). */48 #define VBOX_COM_INIT_F_NO_COM_PATCHING RT_BIT_32(2)49 /** The default flags. */50 #define VBOX_COM_INIT_F_DEFAULT (VBOX_COM_INIT_F_AUTO_REG_UPDATE)51 /** @} */52 53 41 /** 54 * Initializes the COM runtime.42 * Returns the VirtualBox user home directory. 55 43 * 56 * Must be called on the main thread, before any COM activity in any thread, and by any thread57 * willing to perform COM operations.44 * On failure, this function will return a path that caused a failure (or 45 * NULL if the failure is not path-related). 58 46 * 59 * @return COM result code 60 */ 61 HRESULT Initialize(uint32_t fInitFlags = VBOX_COM_INIT_F_DEFAULT); 62 63 /** 64 * Shuts down the COM runtime. 47 * On success, this function will try to create the returned directory if it 48 * doesn't exist yet. This may also fail with the corresponding status code. 65 49 * 66 * Must be called on the main thread before termination. 67 * No COM calls may be made in any thread after this method returns. 68 */ 69 HRESULT Shutdown(); 70 71 /** 72 * Resolves a given interface ID to a string containing the interface name. 50 * If @a aDirLen is smaller than RTPATH_MAX then there is a great chance that 51 * this method will return VERR_BUFFER_OVERFLOW. 73 52 * 74 * If, for some reason, the given IID cannot be resolved to a name, a NULL 75 * string is returned. A non-NULL string returned by this function must be 76 * freed using SysFreeString(). 77 * 78 * @param aIID ID of the interface to get a name for 79 * @param aName Resolved interface name or @c NULL on error 80 */ 81 void GetInterfaceNameByIID(const GUID &aIID, BSTR *aName); 82 83 /** 84 * Returns the VirtualBox user home directory. 85 * 86 * On failure, this function will return a path that caused a failure (or 87 * NULL if the failure is not path-related). 88 * 89 * On success, this function will try to create the returned directory if it 90 * doesn't exist yet. This may also fail with the corresponding status code. 91 * 92 * If @a aDirLen is smaller than RTPATH_MAX then there is a great chance that 93 * this method will return VERR_BUFFER_OVERFLOW. 94 * 95 * @param aDir Buffer to store the directory string in UTF-8 encoding. 96 * @param aDirLen Length of the supplied buffer including space for the 97 * terminating null character, in bytes. 98 * @param fCreateDir Flag whether to create the returned directory on success if it 99 * doesn't exist. 100 * @return VBox status code. 53 * @param aDir Buffer to store the directory string in UTF-8 encoding. 54 * @param aDirLen Length of the supplied buffer including space for the 55 * terminating null character, in bytes. 56 * @param fCreateDir Flag whether to create the returned directory on success 57 * if it doesn't exist. 58 * @returns VBox status code. 101 59 */ 102 60 int GetVBoxUserHomeDirectory(char *aDir, size_t aDirLen, bool fCreateDir = true); 103 61 104 62 /** 105 * 63 * Creates a release log file, used both in VBoxSVC and in API clients. 106 64 * 107 * @param pcszEntityHuman readable name of the program.108 * @param pcszLogFileName of the release log file.109 * @paramfFlags Logger instance flags.110 * @param pcszGroupSettings Group logging settings.111 * @param pcszEnvVarBaseBase environment variable name for the logger.112 * @paramfDestFlags Logger destination flags.113 * @paramcMaxEntriesPerGroup Limit for log entries per group. UINT32_MAX for no limit.114 * @paramcHistory Number of old log files to keep.115 * @paramuHistoryFileTime Maximum amount of time to put in a log file.116 * @paramuHistoryFileSize Maximum size of a log file before rotating.117 * @parampErrInfo Where to return extended error information.118 * Optional.65 * @param pszEntity Human readable name of the program. 66 * @param pszLogFile Name of the release log file. 67 * @param fFlags Logger instance flags. 68 * @param pszGroupSettings Group logging settings. 69 * @param pszEnvVarBase Base environment variable name for the logger. 70 * @param fDestFlags Logger destination flags. 71 * @param cMaxEntriesPerGroup Limit for log entries per group. UINT32_MAX for no limit. 72 * @param cHistory Number of old log files to keep. 73 * @param uHistoryFileTime Maximum amount of time to put in a log file. 74 * @param uHistoryFileSize Maximum size of a log file before rotating. 75 * @param pErrInfo Where to return extended error information. 76 * Optional. 119 77 * 120 * @returnVBox status code.78 * @returns VBox status code. 121 79 */ 122 int VBoxLogRelCreate(const char *p cszEntity, const char *pcszLogFile,123 uint32_t fFlags, const char *p cszGroupSettings,124 const char *p cszEnvVarBase, uint32_t fDestFlags,80 int VBoxLogRelCreate(const char *pszEntity, const char *pszLogFile, 81 uint32_t fFlags, const char *pszGroupSettings, 82 const char *pszEnvVarBase, uint32_t fDestFlags, 125 83 uint32_t cMaxEntriesPerGroup, uint32_t cHistory, 126 84 uint32_t uHistoryFileTime, uint64_t uHistoryFileSize, 127 85 PRTERRINFO pErrInfo); 128 86 129 #ifdef RT_OS_WINDOWS130 void PatchComBugs(void);131 #endif132 133 87 } /* namespace com */ 134 88 135 89 /** @} */ 136 #endif /* !VBOX_INCLUDED_com_ com_h */90 #endif /* !VBOX_INCLUDED_com_utils_h */ 137 91 -
trunk/src/VBox/NetworkServices/Dhcpd/Config.cpp
r79868 r79899 31 31 #include <iprt/cpp/path.h> 32 32 33 #include <VBox/com/ com.h>/* For log initialization. */33 #include <VBox/com/utils.h> /* For log initialization. */ 34 34 35 35 #include "Config.h"
Note:
See TracChangeset
for help on using the changeset viewer.