VBoxManage.h revision 914fe6f35c397cfd7d97b44a63398c6422579c49
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync * VBoxManage - VirtualBox command-line interface, internal header file.
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync * Copyright (C) 2006-2012 Oracle Corporation
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync * available from http://www.virtualbox.org. This file is free software;
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync * you can redistribute it and/or modify it under the terms of the GNU
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync * General Public License (GPL) as published by the Free Software
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync#endif /* !VBOX_ONLY_DOCS */
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync////////////////////////////////////////////////////////////////////////////////
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync// definitions
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync////////////////////////////////////////////////////////////////////////////////
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync/** @name Syntax diagram category.
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync#define USAGE_USBFILTER (RT_BIT_64(22) | RT_BIT_64(23) | RT_BIT_64(24))
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync#define USAGE_SHAREDFOLDER (RT_BIT_64(25) | RT_BIT_64(26))
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync#endif /* VBOX_WITH_GUEST_CONTROL defined */
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync/** command handler argument */
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync/** flag whether we're in internal mode */
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync/** showVMInfo details */
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsynctypedef enum
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync VMINFO_MACHINEREADABLE = 3, /**< both, and make it machine readable */
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync////////////////////////////////////////////////////////////////////////////////
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync// global variables
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync////////////////////////////////////////////////////////////////////////////////
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncextern bool g_fDetailedProgress; // in VBoxManage.cpp
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync////////////////////////////////////////////////////////////////////////////////
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync// prototypes
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync////////////////////////////////////////////////////////////////////////////////
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncvoid printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncRTEXITCODE errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncRTEXITCODE errorGetOpt(USAGECATEGORY u64Cmd, int rc, union RTGETOPTUNION const *pValueUnion);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncRTEXITCODE errorArgument(const char *pszFormat, ...);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncvoid printUsageInternal(USAGECATEGORY u64Cmd, PRTSTREAM pStrm);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncRTEXITCODE readPasswordFile(const char *pszFilename, com::Utf8Str *pPasswd);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync#endif /* !VBOX_ONLY_DOCS */
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncunsigned int getMaxNics(IVirtualBox* vbox, IMachine* mach);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncvoid parseGroups(const char *pcszGroups, com::SafeArray<BSTR> *pGroups);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncextern void usageGuestProperty(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncextern void usageGuestControl(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncHRESULT showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncconst char *machineStateToName(MachineState_T machineState, bool fShort);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncHRESULT showBandwidthGroups(ComPtr<IBandwidthControl> &bwCtrl,
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncHRESULT findMedium(HandlerArg *a, const char *pszFilenameOrUuid,
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncHRESULT findOrOpenMedium(HandlerArg *a, const char *pszFilenameOrUuid,
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync DeviceType_T enmDevType, AccessMode_T enmAccessMode,
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync ComPtr<IMedium> &pMedium, bool fForceNewUuidOnOpen,
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncRTEXITCODE handleConvertFromRaw(int argc, char *argv[]);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsyncint parseDiskType(const char *psz, MediumType_T *pDiskType);
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync#endif /* !VBOX_ONLY_DOCS */
ba287763fb250c9244e7a7afc1abff9387b94e43vboxsync#endif /* !___H_VBOXMANAGE */