cppu/inc/uno/EnvDcp.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: EnvDcp.h,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_uno_EnvDcp_h
  32 #define INCLUDED_uno_EnvDcp_h
  33
  34 #include "rtl/ustring.h"
  35
  36 #ifdef __cplusplus
  37 extern "C"
  38 {
  39 #endif
  40
  41 /** Get the OBI type part of an environment descriptor.
  42     (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Descriptor)
  43
  44     @param pEnvDcp        the Environment Descriptor
  45     @param ppEnvTypeName  the OBI type
  46     @since UDK 3.2.7
  47 */
  48 void uno_EnvDcp_getTypeName(rtl_uString const * pEnvDcp, rtl_uString ** ppEnvTypeName);
  49
  50
  51 /** Get the purpose part of an environment descriptor.
  52     (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Descriptor)
  53
  54     @param pEnvDcp        the Environment Descriptor
  55     @param ppEnvPurpose   the purpose
  56     @since UDK 3.2.7
  57 */
  58 void uno_EnvDcp_getPurpose (rtl_uString const * pEnvDcp, rtl_uString ** ppEnvPurpose);
  59
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif
  64
  65
  66 #endif