LibreOffice LibreOffice 5.3 SDK C/C++ API Reference

process.h
Go to the documentation of this file.
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 #ifndef INCLUDED_OSL_PROCESS_H
22 #define INCLUDED_OSL_PROCESS_H
23
24 #include <sal/config.h>
25
26 #include <osl/file.h>
27 #include <osl/pipe.h>
28 #include <osl/security.h>
29 #include <osl/socket.h>
30 #include <osl/time.h>
31 #include <rtl/locale.h>
32 #include <rtl/textenc.h>
33 #include <rtl/ustring.h>
34 #include <sal/saldllapi.h>
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40
41 typedef sal_Int32 oslProcessOption;
42 #define osl_Process_WAIT 0x0001 /* wait for completion */
43 #define osl_Process_SEARCHPATH 0x0002 /* search path for executable */
44 #define osl_Process_DETACHED 0x0004 /* run detached */
45 #define osl_Process_NORMAL 0x0000 /* run in normal window */
46 #define osl_Process_HIDDEN 0x0010 /* run hidden */
47 #define osl_Process_MINIMIZED 0x0020 /* run in minimized window */
48 #define osl_Process_MAXIMIZED 0x0040 /* run in maximized window */
49 #define osl_Process_FULLSCREEN 0x0080 /* run in fullscreen window */
50
51 typedef sal_Int32 oslProcessData;
52
53 /* defines for osl_getProcessInfo , can be OR'ed */
54 #define osl_Process_IDENTIFIER 0x0001 /* retrieves the process identifier */
55 #define osl_Process_EXITCODE 0x0002 /* retrieves exit code of the process */
56 #define osl_Process_CPUTIMES 0x0004 /* retrieves used cpu time */
57 #define osl_Process_HEAPUSAGE 0x0008 /* retrieves the used size of heap */
58
59 typedef sal_uInt32 oslProcessIdentifier;
60 typedef sal_uInt32 oslProcessExitCode;
61
62 typedef enum {
63 osl_Process_E_None, /* no error */
64 osl_Process_E_NotFound, /* image not found */
65 osl_Process_E_TimedOut, /* timout occurred */
66 osl_Process_E_NoPermission, /* permission denied */
67 osl_Process_E_Unknown, /* unknown error */
68 osl_Process_E_InvalidError, /* unmapped error */
69 osl_Process_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
70 } oslProcessError;
71
72 #ifdef SAL_W32
73 # pragma pack(push, 8)
74 #endif
75
76 typedef struct {
77 sal_uInt32 Size;
78 oslProcessData Fields;
79 oslProcessIdentifier Ident;
80 oslProcessExitCode Code;
81 TimeValue UserTime;
82 TimeValue SystemTime;
83 sal_uInt32 HeapUsage;
84 } oslProcessInfo;
85
86 #if defined( SAL_W32)
87 # pragma pack(pop)
88 #endif
89
98 typedef void* oslProcess;
99
160 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess(
161 rtl_uString* ustrImageName,
162 rtl_uString* ustrArguments[],
163 sal_uInt32 nArguments,
164 oslProcessOption Options,
165 oslSecurity Security,
166 rtl_uString* ustrDirectory,
167 rtl_uString* ustrEnvironments[],
168 sal_uInt32 nEnvironmentVars,
169 oslProcess* pProcess);
170
171
246 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess_WithRedirectedIO(
247 rtl_uString* strImageName,
248 rtl_uString* ustrArguments[],
249 sal_uInt32 nArguments,
250 oslProcessOption Options,
251 oslSecurity Security,
252 rtl_uString* ustrDirectory,
253 rtl_uString* ustrEnvironments[],
254 sal_uInt32 nEnvironmentVars,
255 oslProcess* pProcess,
256 oslFileHandle* pChildInputWrite,
257 oslFileHandle* pChildOutputRead,
258 oslFileHandle* pChildErrorRead);
259
267 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_terminateProcess(
268 oslProcess Process);
269
270
277 SAL_DLLPUBLIC oslProcess SAL_CALL osl_getProcess(
278 oslProcessIdentifier Ident) SAL_COLD;
279
280
284 SAL_DLLPUBLIC void SAL_CALL osl_freeProcessHandle(
285 oslProcess Process);
286
287
293 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_joinProcess(
294 oslProcess Process);
295
313 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_joinProcessWithTimeout(
314 oslProcess Process, const TimeValue* pTimeout);
315
331 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessInfo(
332 oslProcess Process, oslProcessData Fields, oslProcessInfo* pInfo);
333
345 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getExecutableFile(
346 rtl_uString **strFile);
347
352 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getCommandArgCount(void);
353
360 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getCommandArg(
361 sal_uInt32 nArg, rtl_uString **strCommandArg);
362
376 SAL_DLLPUBLIC void SAL_CALL osl_setCommandArgs (int argc, char **argv);
377
382 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getEnvironment(
383 rtl_uString *strVar, rtl_uString **strValue);
384
391 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_setEnvironment(
392 rtl_uString *strVar, rtl_uString *strValue);
393
399 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_clearEnvironment(
400 rtl_uString *strVar);
401
408 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessWorkingDir(
409 rtl_uString **pustrWorkingDir );
410
420 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessLocale(
421 rtl_Locale ** ppLocale );
422
429 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_setProcessLocale(
430 rtl_Locale * pLocale );
431
432 #ifdef __cplusplus
433 }
434 #endif
435
436 #endif // INCLUDED_OSL_PROCESS_H
437
438 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
security.h
oslFileHandle
void * oslFileHandle
Definition: file.h:634
oslProcess
void * oslProcess
Process handle.
Definition: process.h:98
osl_getProcessLocale
SAL_DLLPUBLIC oslProcessError osl_getProcessLocale(rtl_Locale **ppLocale)
Get the locale the process is currently running in.
TimeValue
Definition: time.h:70
oslProcessOption
sal_Int32 oslProcessOption
Definition: process.h:41
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
oslProcessInfo::Fields
oslProcessData Fields
Definition: process.h:78
osl_Process_E_NoPermission
Definition: process.h:66
osl_Process_E_TimedOut
Definition: process.h:65
osl_setCommandArgs
SAL_DLLPUBLIC void osl_setCommandArgs(int argc, char **argv)
Set the command-line arguments as passed to the main-function of this process.
oslSecurity
void * oslSecurity
Process handle.
Definition: security.h:45
oslProcessInfo::Size
sal_uInt32 Size
Definition: process.h:77
osl_Process_E_Unknown
Definition: process.h:67
file.h
Main goals and usage hints.
osl_Process_E_None
Definition: process.h:63
oslProcessInfo::SystemTime
TimeValue SystemTime
Definition: process.h:82
osl_joinProcess
SAL_DLLPUBLIC oslProcessError osl_joinProcess(oslProcess Process)
Wait for completion of the specified childprocess.
osl_setProcessLocale
SAL_DLLPUBLIC oslProcessError osl_setProcessLocale(rtl_Locale *pLocale)
Change the locale of the process.
oslProcessIdentifier
sal_uInt32 oslProcessIdentifier
Definition: process.h:59
oslProcessData
sal_Int32 oslProcessData
Definition: process.h:51
pipe.h
osl_terminateProcess
SAL_DLLPUBLIC oslProcessError osl_terminateProcess(oslProcess Process)
Terminate a process.
oslProcessInfo::Ident
oslProcessIdentifier Ident
Definition: process.h:79
osl_getProcessWorkingDir
SAL_DLLPUBLIC oslProcessError osl_getProcessWorkingDir(rtl_uString **pustrWorkingDir)
Get the working directory of the current process as a file URL.
osl_clearEnvironment
SAL_DLLPUBLIC oslProcessError osl_clearEnvironment(rtl_uString *strVar)
Unsets the value of one environment variable.
locale.h
saldllapi.h
osl_getCommandArg
SAL_DLLPUBLIC oslProcessError osl_getCommandArg(sal_uInt32 nArg, rtl_uString **strCommandArg)
Get the nArg-th command-line argument passed to the main-function of this process.
ustring.h
osl_getProcess
SAL_DLLPUBLIC oslProcess osl_getProcess(oslProcessIdentifier Ident) SAL_COLD
osl_getProcessInfo
SAL_DLLPUBLIC oslProcessError osl_getProcessInfo(oslProcess Process, oslProcessData Fields, oslProcessInfo *pInfo)
Retrieves information about a Process.
osl_getCommandArgCount
SAL_DLLPUBLIC sal_uInt32 osl_getCommandArgCount(void)
osl_Process_E_InvalidError
Definition: process.h:68
oslProcessInfo::HeapUsage
sal_uInt32 HeapUsage
Definition: process.h:83
osl_executeProcess
SAL_DLLPUBLIC oslProcessError osl_executeProcess(rtl_uString *ustrImageName, rtl_uString *ustrArguments[], sal_uInt32 nArguments, oslProcessOption Options, oslSecurity Security, rtl_uString *ustrDirectory, rtl_uString *ustrEnvironments[], sal_uInt32 nEnvironmentVars, oslProcess *pProcess)
Execute a process.
oslProcessInfo::Code
oslProcessExitCode Code
Definition: process.h:80
config.h
textenc.h
oslProcessExitCode
sal_uInt32 oslProcessExitCode
Definition: process.h:60
osl_setEnvironment
SAL_DLLPUBLIC oslProcessError osl_setEnvironment(rtl_uString *strVar, rtl_uString *strValue)
Set the value of one environment variable.
osl_getExecutableFile
SAL_DLLPUBLIC oslProcessError osl_getExecutableFile(rtl_uString **strFile)
Get the filename of the executable.
osl_joinProcessWithTimeout
SAL_DLLPUBLIC oslProcessError osl_joinProcessWithTimeout(oslProcess Process, const TimeValue *pTimeout)
Wait with a timeout for the completion of the specified child process.
_rtl_Locale
The implementation structure of a locale.
Definition: locale.h:42
osl_freeProcessHandle
SAL_DLLPUBLIC void osl_freeProcessHandle(oslProcess Process)
Free the specified process-handle.
osl_Process_E_NotFound
Definition: process.h:64
oslProcessError
oslProcessError
Definition: process.h:62
oslProcessInfo::UserTime
TimeValue UserTime
Definition: process.h:81
osl_getEnvironment
SAL_DLLPUBLIC oslProcessError osl_getEnvironment(rtl_uString *strVar, rtl_uString **strValue)
Get the value of one environment variable.
osl_Process_E_FORCE_EQUAL_SIZE
Definition: process.h:69
SAL_MAX_ENUM
#define SAL_MAX_ENUM
Definition: types.h:242
oslProcessInfo
Definition: process.h:76
time.h
osl_executeProcess_WithRedirectedIO
SAL_DLLPUBLIC oslProcessError osl_executeProcess_WithRedirectedIO(rtl_uString *strImageName, rtl_uString *ustrArguments[], sal_uInt32 nArguments, oslProcessOption Options, oslSecurity Security, rtl_uString *ustrDirectory, rtl_uString *ustrEnvironments[], sal_uInt32 nEnvironmentVars, oslProcess *pProcess, oslFileHandle *pChildInputWrite, oslFileHandle *pChildOutputRead, oslFileHandle *pChildErrorRead)
Execute a process and redirect child process standard IO.
socket.h