xref: /aoo4110/main/sal/inc/rtl/process.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 _RTL_PROCESS_H_
24*b1cdbd2cSJim Jagielski #define _RTL_PROCESS_H_
25*b1cdbd2cSJim Jagielski 
26*b1cdbd2cSJim Jagielski #include <sal/types.h>
27*b1cdbd2cSJim Jagielski #include <osl/process.h>
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski #ifdef __cplusplus
30*b1cdbd2cSJim Jagielski extern "C" {
31*b1cdbd2cSJim Jagielski #endif
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski 
34*b1cdbd2cSJim Jagielski /**
35*b1cdbd2cSJim Jagielski 	gets a 16-byte fixed size identifier which is guaranteed not to change
36*b1cdbd2cSJim Jagielski 	during the current process.
37*b1cdbd2cSJim Jagielski 
38*b1cdbd2cSJim Jagielski 	The current implementation creates a 16-byte uuid without using
39*b1cdbd2cSJim Jagielski 	the ethernet address of system. Thus the
40*b1cdbd2cSJim Jagielski 	identifier is different from identifiers created
41*b1cdbd2cSJim Jagielski 	in other processes with a very probability.
42*b1cdbd2cSJim Jagielski 
43*b1cdbd2cSJim Jagielski 	@param pTargetUUID 16 byte of memory
44*b1cdbd2cSJim Jagielski     @see rtl_createUiid()
45*b1cdbd2cSJim Jagielski  */
46*b1cdbd2cSJim Jagielski void SAL_CALL rtl_getGlobalProcessId( sal_uInt8 *pTargetUUID );
47*b1cdbd2cSJim Jagielski 
48*b1cdbd2cSJim Jagielski /** Get the nArg-th command-line argument passed to the main-function of this process.
49*b1cdbd2cSJim Jagielski 
50*b1cdbd2cSJim Jagielski 	This functions differs from osl_getCommandArg() in filtering any bootstrap values
51*b1cdbd2cSJim Jagielski 	given by command args, that means that all arguments starting with "-env:" will be
52*b1cdbd2cSJim Jagielski 	ignored by this function.
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski     @param nArg [in] The number of the argument to return.
55*b1cdbd2cSJim Jagielski 	@param strCommandArg [out] The string receives the nArg-th command-line argument.
56*b1cdbd2cSJim Jagielski 	@return osl_Process_E_None or does not return.
57*b1cdbd2cSJim Jagielski 	@see osl_getCommandArg()
58*b1cdbd2cSJim Jagielski 	@see rtl_getCommandArgCount()
59*b1cdbd2cSJim Jagielski */
60*b1cdbd2cSJim Jagielski oslProcessError SAL_CALL rtl_getAppCommandArg(sal_uInt32 nArg, rtl_uString **strCommandArg);
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski /** Returns the number of command line arguments at process start.
63*b1cdbd2cSJim Jagielski 
64*b1cdbd2cSJim Jagielski 	This functions differs from osl_getCommandArg() in filtering any bootstrap values
65*b1cdbd2cSJim Jagielski 	given by command args, that means that all arguments starting with "-env:" will be
66*b1cdbd2cSJim Jagielski 	ignored by this function.
67*b1cdbd2cSJim Jagielski 
68*b1cdbd2cSJim Jagielski 	@return the number of commandline arguments passed to the main-function of this process.
69*b1cdbd2cSJim Jagielski     @see osl_getCommandArgCount()
70*b1cdbd2cSJim Jagielski 	@see rtl_getCommandArg()
71*b1cdbd2cSJim Jagielski */
72*b1cdbd2cSJim Jagielski sal_uInt32 SAL_CALL rtl_getAppCommandArgCount();
73*b1cdbd2cSJim Jagielski 
74*b1cdbd2cSJim Jagielski #ifdef __cplusplus
75*b1cdbd2cSJim Jagielski }
76*b1cdbd2cSJim Jagielski #endif
77*b1cdbd2cSJim Jagielski 
78*b1cdbd2cSJim Jagielski #endif
79