1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_datatransfer_XSystemTransferable_idl__
25#define __com_sun_star_datatransfer_XSystemTransferable_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31//=============================================================================
32
33module com { module sun { module star { module datatransfer {
34
35//=============================================================================
36/** Interface to be implemented by  objects used to provide system dependent data
37	for a transfer operation. Those objects usually also implement <type>XTransferable</type>.
38*/
39
40published interface XSystemTransferable: com::sun::star::uno::XInterface
41{
42	//-------------------------------------------------------------------------
43	/** Called by a data consumer to obtain a system specific data object from the
44		source.
45		The data object is returned in an any. The contained type may differ on
46		different platforms.
47
48		@param aProcessId
49		The argument aProcessId is a process identifier of the caller's process.
50		The interface implementation must ensure that the system data object can be
51		used in that process. If the data object is not valid in the caller process
52		then the returned any must be empty.
53
54		@returns
55		The system dependent data object.
56
57		<br/><br/><p><strong>Notes:</strong>Under Windows the returned any contains an unsigned long which represents a pointer to
58		an IDataObject interface. The caller of getData has to release the data
59		object (IDataObject::Release) if it is no longer needed.
60		The caller must also make sure that the current thread has been initialized for
61		OLE (use OleInitialize).</p>
62	*/
63	any getData( [in] sequence < byte > aProcessId);
64};
65
66}; }; }; };
67
68#endif
69