include/uno/current_context.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_UNO_CURRENT_CONTEXT_H
  20 #define INCLUDED_UNO_CURRENT_CONTEXT_H
  21
  22 #include <cppu/cppudllapi.h>
  23 #include <rtl/ustring.h>
  24
  25 #ifdef __cplusplus
  26 extern "C"
  27 {
  28 #endif
  29
  30 /** Gets the current task's context.
  31     @attention
  32     Don't spread the returned interface around to other threads.  Every thread has its own
  33     current context.
  34
  35     @param ppCurrentContext  inout param current context of type com.sun.star.uno.XCurrentContext
  36     @param pEnvDcp           descriptor of returned interface's environment
  37     @param pEnvContext       context of returned interface's environment (commonly 0)
  38     @return                  true, if context ref was transferred (even if null ref)
  39 */
  40 CPPU_DLLPUBLIC sal_Bool SAL_CALL uno_getCurrentContext(
  41     void ** ppCurrentContext,
  42     rtl_uString * pEnvDcp, void * pEnvContext )
  43     SAL_THROW_EXTERN_C();
  44
  45 /** Sets the current task's context.
  46
  47     @param pCurrentContext  in param current context of type com.sun.star.uno.XCurrentContext
  48     @param pEnvDcp          descriptor of interface's environment
  49     @param pEnvContext      context of interface's environment (commonly 0)
  50     @return                 true, if context ref was transferred (even if null ref)
  51 */
  52 CPPU_DLLPUBLIC sal_Bool SAL_CALL uno_setCurrentContext(
  53     void * pCurrentContext,
  54     rtl_uString * pEnvDcp, void * pEnvContext )
  55     SAL_THROW_EXTERN_C();
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */