UDK 3.2.7 C/C++ API Reference
|
#include <rtl/ustring.h>
#include <rtl/textenc.h>
#include <rtl/locale.h>
#include <osl/time.h>
#include <osl/file.h>
#include <osl/pipe.h>
#include <osl/socket.h>
#include <osl/security.h>
Go to the source code of this file.
Classes | |
struct | oslProcessInfo |
Defines | |
#define | osl_Process_WAIT 0x0001 |
#define | osl_Process_SEARCHPATH 0x0002 |
#define | osl_Process_DETACHED 0x0004 |
#define | osl_Process_NORMAL 0x0000 |
#define | osl_Process_HIDDEN 0x0010 |
#define | osl_Process_MINIMIZED 0x0020 |
#define | osl_Process_MAXIMIZED 0x0040 |
#define | osl_Process_FULLSCREEN 0x0080 |
#define | osl_Process_IDENTIFIER 0x0001 |
#define | osl_Process_EXITCODE 0x0002 |
#define | osl_Process_CPUTIMES 0x0004 |
#define | osl_Process_HEAPUSAGE 0x0008 |
#define | osl_Process_DFNONE 0x0000 |
#define | osl_Process_DFWAIT 0x0001 |
Typedefs | |
typedef sal_Int32 | oslProcessOption |
typedef sal_Int32 | oslProcessData |
typedef sal_uInt32 | oslProcessIdentifier |
typedef sal_uInt32 | oslProcessExitCode |
typedef sal_Int32 | oslDescriptorFlag |
typedef void * | oslProcess |
Process handle. | |
Enumerations | |
enum | oslProcessError { osl_Process_E_None, osl_Process_E_NotFound, osl_Process_E_TimedOut, osl_Process_E_NoPermission, osl_Process_E_Unknown, osl_Process_E_InvalidError, osl_Process_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM } |
enum | oslDescriptorType { osl_Process_TypeNone, osl_Process_TypeSocket, osl_Process_TypeFile, osl_Process_TypePipe, osl_Process_FORCE_EQUAL_SIZE = SAL_MAX_ENUM } |
Functions | |
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. | |
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. | |
SAL_DLLPUBLIC oslProcessError | osl_terminateProcess (oslProcess Process) |
Terminate a process. | |
SAL_DLLPUBLIC oslProcess | osl_getProcess (oslProcessIdentifier Ident) |
SAL_DLLPUBLIC void | osl_freeProcessHandle (oslProcess Process) |
Free the specified proces-handle. | |
SAL_DLLPUBLIC oslProcessError | osl_joinProcess (oslProcess Process) |
Wait for completation of the specified childprocess. | |
SAL_DLLPUBLIC oslProcessError | osl_joinProcessWithTimeout (oslProcess Process, const TimeValue *pTimeout) |
Wait with a timeout for the completion of the specified child process. | |
SAL_DLLPUBLIC oslProcessError | osl_getProcessInfo (oslProcess Process, oslProcessData Fields, oslProcessInfo *pInfo) |
Retrieves information about a Process. | |
SAL_DLLPUBLIC oslProcessError | osl_getExecutableFile (rtl_uString **strFile) |
Get the filename of the executable. | |
SAL_DLLPUBLIC sal_uInt32 | osl_getCommandArgCount (void) |
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. | |
SAL_DLLPUBLIC void | osl_setCommandArgs (int argc, char **argv) |
Set the command-line arguments as passed to the main-function of this process. | |
SAL_DLLPUBLIC oslProcessError | osl_getEnvironment (rtl_uString *strVar, rtl_uString **strValue) |
Get the value of one enviroment variable. | |
SAL_DLLPUBLIC oslProcessError | osl_setEnvironment (rtl_uString *strVar, rtl_uString *strValue) |
Set the value of one enviroment variable. | |
SAL_DLLPUBLIC oslProcessError | osl_clearEnvironment (rtl_uString *strVar) |
Unsets the value of one enviroment variable. | |
SAL_DLLPUBLIC oslProcessError | osl_getProcessWorkingDir (rtl_uString **pustrWorkingDir) |
Get the working directory of the current process as a file URL. | |
SAL_DLLPUBLIC oslProcessError | osl_getProcessLocale (rtl_Locale **ppLocale) |
Get the locale the process is currently running in. | |
SAL_DLLPUBLIC oslProcessError | osl_setProcessLocale (rtl_Locale *pLocale) |
Change the locale of the process. | |
SAL_DLLPUBLIC sal_Bool | osl_sendResourcePipe (oslPipe Pipe, oslSocket Socket) |
SAL_DLLPUBLIC oslSocket | osl_receiveResourcePipe (oslPipe Pipe) |
#define osl_Process_CPUTIMES 0x0004 |
#define osl_Process_DETACHED 0x0004 |
#define osl_Process_DFNONE 0x0000 |
#define osl_Process_DFWAIT 0x0001 |
#define osl_Process_EXITCODE 0x0002 |
#define osl_Process_FULLSCREEN 0x0080 |
#define osl_Process_HEAPUSAGE 0x0008 |
#define osl_Process_HIDDEN 0x0010 |
#define osl_Process_IDENTIFIER 0x0001 |
#define osl_Process_MAXIMIZED 0x0040 |
#define osl_Process_MINIMIZED 0x0020 |
#define osl_Process_NORMAL 0x0000 |
#define osl_Process_SEARCHPATH 0x0002 |
#define osl_Process_WAIT 0x0001 |
typedef sal_Int32 oslDescriptorFlag |
typedef void* oslProcess |
Process handle.
typedef sal_Int32 oslProcessData |
typedef sal_uInt32 oslProcessExitCode |
typedef sal_uInt32 oslProcessIdentifier |
typedef sal_Int32 oslProcessOption |
enum oslDescriptorType |
enum oslProcessError |
SAL_DLLPUBLIC oslProcessError osl_clearEnvironment | ( | rtl_uString * | strVar | ) |
Unsets the value of one enviroment variable.
strVar | [in] denotes the name of the variable to unset. |
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.
Executes the program image provided in strImageName in a new process.
ustrImageName | [in] The file URL of the executable to be started. Can be NULL in this case the file URL of the executable must be the first element in ustrArguments. |
ustrArguments | [in] An array of argument strings. Can be NULL if strImageName is not NULL. If strImageName is NULL it is expected that the first element contains the file URL of the executable to start. |
nArguments | [in] The number of arguments provided. If this number is 0 strArguments will be ignored. |
Options | [in] A combination of int-constants to describe the mode of execution. |
Security | [in] The user and his rights for which the process is started. May be NULL in which case the process will be started in the context of the current user. |
ustrDirectory | [in] The file URL of the working directory of the new proces. If the specified directory does not exist or is inaccessible the working directory of the newly created process is undefined. If this parameter is NULL or the caller provides an empty string the new process will have the same current working directory as the calling process. |
ustrEnvironments | [in] An array of strings describing environment variables that should be merged into the environment of the new process. Each string has to be in the form "variable=value". This parameter can be NULL in which case the new process gets the same environment as the parent process. |
nEnvironmentVars | [in] The number of environment variables to set. |
pProcess | [out] Pointer to a oslProcess variable, wich receives the handle of the newly created process. This parameter must not be NULL. |
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.
strImageName | [in] The file URL of the executable to be started. Can be NULL in this case the file URL of the executable must be the first element in ustrArguments. |
ustrArguments | [in] An array of argument strings. Can be NULL if strImageName is not NULL. If strImageName is NULL it is expected that the first element contains the file URL of the executable to start. |
nArguments | [in] The number of arguments provided. If this number is 0 strArguments will be ignored. |
Options | [in] A combination of int-constants to describe the mode of execution. |
Security | [in] The user and his rights for which the process is started. May be NULL in which case the process will be started in the context of the current user. |
ustrDirectory | [in] The file URL of the working directory of the new proces. If the specified directory does not exist or is inaccessible the working directory of the newly created process is undefined. If this parameter is NULL or the caller provides an empty string the new process will have the same current working directory as the calling process. |
ustrEnvironments | [in] An array of strings describing environment variables that should be merged into the environment of the new process. Each string has to be in the form "variable=value". This parameter can be NULL in which case the new process gets the same environment as the parent process. |
nEnvironmentVars | [in] The number of environment variables to set. |
pProcess | [out] Pointer to a oslProcess variable, wich receives the handle of the newly created process. This parameter must not be NULL. |
pChildInputWrite | [in] Pointer to a oslFileHandle variable that receives the handle which can be used to write to the child process standard input device. The returned handle is not random accessible. The handle has to be closed with osl_closeFile if no longer used. This parameter can be NULL. |
pChildOutputRead | [in] Pointer to a oslFileHandle variable that receives the handle which can be used to read from the child process standard output device. The returned handle is not random accessible. The Handle has to be closed with osl_closeFile if no longer used. This parameter can be NULL. |
pChildErrorRead | [in] Pointer to a oslFileHandle variable that receives the handle which can be used to read from the child process standard error device. The returned handle is not random accessible. The Handle has to be closed with osl_closeFile if no longer used. This parameter can be NULL. |
SAL_DLLPUBLIC void osl_freeProcessHandle | ( | oslProcess | Process | ) |
Free the specified proces-handle.
Process | [in] |
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.
nArg | [in] The number of the argument to return. |
strCommandArg | [out] The string receives the nArg-th command-line argument. |
SAL_DLLPUBLIC sal_uInt32 osl_getCommandArgCount | ( | void | ) |
SAL_DLLPUBLIC oslProcessError osl_getEnvironment | ( | rtl_uString * | strVar, |
rtl_uString ** | strValue | ||
) |
Get the value of one enviroment variable.
strVar | [in] denotes the name of the variable to get. |
strValue | [out] string that receives the value of environment variable. |
SAL_DLLPUBLIC oslProcessError osl_getExecutableFile | ( | rtl_uString ** | strFile | ) |
Get the filename of the executable.
strFile | [out] the string that receives the executable file path. |
SAL_DLLPUBLIC oslProcess osl_getProcess | ( | oslProcessIdentifier | Ident | ) |
Ident | [in] a process identifier |
SAL_DLLPUBLIC oslProcessError osl_getProcessInfo | ( | oslProcess | Process, |
oslProcessData | Fields, | ||
oslProcessInfo * | pInfo | ||
) |
Retrieves information about a Process.
[in] | Process | the process handle of the process |
[in] | Fields | the information which is to be retrieved this can be one or more of osl_Process_IDENTIFIER osl_Process_EXITCODE osl_Process_CPUTIMES osl_Process_HEAPUSAGE |
[out] | pInfo | a pointer to a vaid oslProcessInfo structure. the Size field has to be initialized with the size of the oslProcessInfo structure. on success the the Field member holds the (or'ed) retrieved valid information fields. |
SAL_DLLPUBLIC oslProcessError osl_getProcessLocale | ( | rtl_Locale ** | ppLocale | ) |
Get the locale the process is currently running in.
The unix implementation caches the value it returns, so if you have to change the locale your are running in, you will have to use osl_setProcessLocale therefor.
ppLocale | [out] a pointer that receives the currently selected locale structure |
SAL_DLLPUBLIC oslProcessError osl_getProcessWorkingDir | ( | rtl_uString ** | pustrWorkingDir | ) |
Get the working directory of the current process as a file URL.
The file URL is encoded as common for the OSL file API.
pustrWorkingDir | [out] string that receives the working directory file URL. |
SAL_DLLPUBLIC oslProcessError osl_joinProcess | ( | oslProcess | Process | ) |
Wait for completation of the specified childprocess.
Process | [in] |
SAL_DLLPUBLIC oslProcessError osl_joinProcessWithTimeout | ( | oslProcess | Process, |
const TimeValue * | pTimeout | ||
) |
Wait with a timeout for the completion of the specified child process.
Process | [in] A process identifier. |
pTimeout | [in] A timeout value or NULL for infinite waiting. The unit of resolution is second. |
SAL_DLLPUBLIC void osl_setCommandArgs | ( | int | argc, |
char ** | argv | ||
) |
Set the command-line arguments as passed to the main-function of this process.
Depricated: This function is only for internal use. Passing the args from main will only work for Unix, on Windows there's no effect, the full command line will automtically be taken. This is due to Windows 9x/ME limitation that don't allow UTF-16 wmain to provide a osl_setCommandArgsU( int argc, sal_Unicode **argv );
argc | [in] The number of elements in the argv array. |
argv | [in] The array of command-line arguments. |
SAL_DLLPUBLIC oslProcessError osl_setEnvironment | ( | rtl_uString * | strVar, |
rtl_uString * | strValue | ||
) |
Set the value of one enviroment variable.
strVar | [in] denotes the name of the variable to set. |
strValue | [in] string of the new value of environment variable. |
SAL_DLLPUBLIC oslProcessError osl_setProcessLocale | ( | rtl_Locale * | pLocale | ) |
Change the locale of the process.
pLocale | [in] a pointer to the locale to be set |
SAL_DLLPUBLIC oslProcessError osl_terminateProcess | ( | oslProcess | Process | ) |
Terminate a process.
Process | [in] the handle of the process to be terminated |