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