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
  20 /*
  21  * This file is part of LibreOffice published API.
  22  */
  23 #ifndef INCLUDED_UNO_CURRENT_CONTEXT_H
  24 #define INCLUDED_UNO_CURRENT_CONTEXT_H
  25
  26 #include "cppu/cppudllapi.h"
  27 #include "rtl/ustring.h"
  28
  29 #ifdef __cplusplus
  30 extern "C"
  31 {
  32 #endif
  33
  34 /** Gets the current task's context.
  35     @attention
  36     Don't spread the returned interface around to other threads.  Every thread has its own
  37     current context.
  38
  39     @param ppCurrentContext  inout param current context of type com.sun.star.uno.XCurrentContext
  40     @param pEnvDcp           descriptor of returned interface's environment
  41     @param pEnvContext       context of returned interface's environment (commonly 0)
  42     @return                  true, if context ref was transferred (even if null ref)
  43 */
  44 CPPU_DLLPUBLIC sal_Bool SAL_CALL uno_getCurrentContext(
  45     void ** ppCurrentContext,
  46     rtl_uString * pEnvDcp, void * pEnvContext )
  47     SAL_THROW_EXTERN_C();
  48
  49 /** Sets the current task's context.
  50
  51     @param pCurrentContext  in param current context of type com.sun.star.uno.XCurrentContext
  52     @param pEnvDcp          descriptor of interface's environment
  53     @param pEnvContext      context of interface's environment (commonly 0)
  54     @return                 true, if context ref was transferred (even if null ref)
  55 */
  56 CPPU_DLLPUBLIC sal_Bool SAL_CALL uno_setCurrentContext(
  57     void * pCurrentContext,
  58     rtl_uString * pEnvDcp, void * pEnvContext )
  59     SAL_THROW_EXTERN_C();
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */