xref: /aoo4110/main/cppu/inc/uno/current_context.h (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski #ifndef _UNO_CURRENT_CONTEXT_H_
24*b1cdbd2cSJim Jagielski #define _UNO_CURRENT_CONTEXT_H_
25*b1cdbd2cSJim Jagielski 
26*b1cdbd2cSJim Jagielski #include <rtl/ustring.h>
27*b1cdbd2cSJim Jagielski 
28*b1cdbd2cSJim Jagielski #ifdef __cplusplus
29*b1cdbd2cSJim Jagielski extern "C"
30*b1cdbd2cSJim Jagielski {
31*b1cdbd2cSJim Jagielski #endif
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski /** Gets the current task's context.
34*b1cdbd2cSJim Jagielski 	@attention
35*b1cdbd2cSJim Jagielski     Don't spread the returned interface around to other threads.  Every thread has its own
36*b1cdbd2cSJim Jagielski     current context.
37*b1cdbd2cSJim Jagielski 
38*b1cdbd2cSJim Jagielski 	@param ppCurrentContext  inout param current context of type com.sun.star.uno.XCurrentContext
39*b1cdbd2cSJim Jagielski 	@param pEnvDcp           descriptor of returned interface's environment
40*b1cdbd2cSJim Jagielski 	@param pEnvContext       context of returned interface's environment (commonly 0)
41*b1cdbd2cSJim Jagielski     @return                  true, if context ref was transferred (even if null ref)
42*b1cdbd2cSJim Jagielski */
43*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL uno_getCurrentContext(
44*b1cdbd2cSJim Jagielski 	void ** ppCurrentContext,
45*b1cdbd2cSJim Jagielski 	rtl_uString * pEnvDcp, void * pEnvContext )
46*b1cdbd2cSJim Jagielski 	SAL_THROW_EXTERN_C();
47*b1cdbd2cSJim Jagielski 
48*b1cdbd2cSJim Jagielski /** Sets the current task's context.
49*b1cdbd2cSJim Jagielski 
50*b1cdbd2cSJim Jagielski 	@param pCurrentContext  in param current context of type com.sun.star.uno.XCurrentContext
51*b1cdbd2cSJim Jagielski 	@param pEnvDcp          descriptor of interface's environment
52*b1cdbd2cSJim Jagielski 	@param pEnvContext      context of interface's environment (commonly 0)
53*b1cdbd2cSJim Jagielski     @return                 true, if context ref was transferred (even if null ref)
54*b1cdbd2cSJim Jagielski */
55*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL uno_setCurrentContext(
56*b1cdbd2cSJim Jagielski 	void * pCurrentContext,
57*b1cdbd2cSJim Jagielski 	rtl_uString * pEnvDcp, void * pEnvContext )
58*b1cdbd2cSJim Jagielski 	SAL_THROW_EXTERN_C();
59*b1cdbd2cSJim Jagielski 
60*b1cdbd2cSJim Jagielski #ifdef __cplusplus
61*b1cdbd2cSJim Jagielski }
62*b1cdbd2cSJim Jagielski #endif
63*b1cdbd2cSJim Jagielski 
64*b1cdbd2cSJim Jagielski #endif
65