message.h revision 03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync/** @file
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * IPRT - Message Formatting.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync */
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync/*
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * Copyright (C) 2009 Sun Microsystems, Inc.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync *
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * available from http://www.virtualbox.org. This file is free software;
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * you can redistribute it and/or modify it under the terms of the GNU
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * General Public License (GPL) as published by the Free Software
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync *
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * The contents of this file may alternatively be used under the terms
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * of the Common Development and Distribution License Version 1.0
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * VirtualBox OSE distribution, in which case the provisions of the
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * CDDL are applicable instead of those of the GPL.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync *
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * You may elect to license modified versions of this file under the
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * terms and conditions of either the GPL or the CDDL or both.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync *
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * additional information or have any questions.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync */
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync#ifndef ___iprt_msg_h
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync#define ___iprt_msg_h
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync#include <iprt/cdefs.h>
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync#include <iprt/types.h>
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync#include <iprt/stdarg.h>
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsyncRT_C_DECLS_BEGIN
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync/** @defgroup grp_rt_msg RTMsg - Message Formatting
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * @ingroup grp_rt
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * @{
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync */
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync/**
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * Print error message to standard error.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync *
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * The message will be prefixed with the file name part of process image name
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * (i.e. no path) and "error: ". If the message doesn't end with a new line,
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * one will be added. The caller should call this with an empty string if
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * unsure whether the cursor is currently position at the start of a new line.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync *
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * @returns IPRT status code.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * @param pszFormat The message format string.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * @param ... Format arguments.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync */
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsyncRTDECL(int) RTMsgError(const char *pszFormat, ...);
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync/**
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * Print error message to standard error.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync *
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * The message will be prefixed with the file name part of process image name
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * (i.e. no path) and "error: ". If the message doesn't end with a new line,
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * one will be added. The caller should call this with an empty string if
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * unsure whether the cursor is currently position at the start of a new line.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync *
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * @returns IPRT status code.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * @param pszFormat The message format string.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync * @param va Format arguments.
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync */
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsyncRTDECL(int) RTMsgErrorV(const char *pszFormat, va_list va);
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync/** @} */
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsyncRT_C_DECLS_END
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync#endif
03c2683d4e59cc500217b1d5d76fdf9b8cdfefa5vboxsync