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