VBoxGuestR3LibClipboard.cpp revision c7814cf6e1240a519cbec0441e033d0e2470ed00
/* $Id$ */
/** @file
* VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Clipboard.
*/
/*
* Copyright (C) 2007-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include "VBGLR3Internal.h"
/**
* Connects to the clipboard service.
*
* @returns VBox status code
* @param pu32ClientId Where to put the client id on success. The client id
* must be passed to all the other clipboard calls.
*/
{
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
}
return rc;
}
/**
* Disconnect from the clipboard service.
*
* @returns VBox status code.
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
*/
{
if (RT_SUCCESS(rc))
return rc;
}
/**
* Get a host message.
*
* This will block until a message becomes available.
*
* @returns VBox status code.
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
* @param pMsg Where to store the message id.
* @param pfFormats Where to store the format(s) the message applies to.
*/
VBGLR3DECL(int) VbglR3ClipboardGetHostMsg(uint32_t u32ClientId, uint32_t *pMsg, uint32_t *pfFormats)
{
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
{
}
}
}
}
return rc;
}
/**
* Reads data from the host clipboard.
*
* @returns VBox status code.
* @retval VINF_BUFFER_OVERFLOW If there is more data available than the caller provided buffer space for.
*
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
* @param fFormat The format we're requesting the data in.
* @param pv Where to store the data.
* @param cb The size of the buffer pointed to by pv.
* @param pcb The actual size of the host clipboard data. May be larger than cb.
*/
VBGLR3DECL(int) VbglR3ClipboardReadData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb)
{
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
{
return VINF_BUFFER_OVERFLOW;
}
}
}
return rc;
}
/**
* Advertises guest clipboard formats to the host.
*
* @returns VBox status code.
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
* @param fFormats The formats to advertise.
*/
{
if (RT_SUCCESS(rc))
return rc;
}
/**
* Send guest clipboard data to the host.
*
* This is usually called in reply to a VBOX_SHARED_CLIPBOARD_HOST_MSG_READ_DATA message
* from the host.
*
* @returns VBox status code.
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
* @param fFormat The format of the data.
* @param pv The data.
* @param cb The size of the data.
*/
VBGLR3DECL(int) VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb)
{
if (RT_SUCCESS(rc))
return rc;
}