Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kProcess.h
Go to the documentation of this file.
1 
11 #ifndef K_API_PROCESS_H
12 #define K_API_PROCESS_H
13 
14 #include <kApi/kApiDef.h>
15 #include <kApi/Utils/kProcess.x.h>
16 
28 //typedef kObject kProcess; --forward-declared in kApiDef.x.h
29 
30 
47 kFx(kStatus) kProcess_Construct(kProcess* process, const kChar* path, kAlloc allocator);
48 
57 kFx(kStatus) kProcess_AddArgument(kProcess process, const kChar* argument);
58 
68 kFx(kStatus) kProcess_AddArguments(kProcess process, const kChar* arguments[], kSize argCount);
69 
77 kFx(kStatus) kProcess_ClearArguments(kProcess process);
78 
90 kFx(kStatus) kProcess_Start(kProcess process);
91 
99 kFx(kBool) kProcess_IsAlive(kProcess process);
100 
112 kFx(kStatus) kProcess_Terminate(kProcess process);
113 
122 kInlineFx(kStatus) kProcess_Wait(kProcess process, k64u timeout)
123 {
124  return kProcess_WaitImpl(process, timeout);
125 }
126 
139 kFx(k64s) kProcess_ExitCode(kProcess process);
140 
151 kFx(kStream) kProcess_StdIn(kProcess process);
152 
163 kFx(kStream) kProcess_StdOut(kProcess process);
164 
175 kFx(kStream) kProcess_StdErr(kProcess process);
176 
185 kFx(k32s) kProcess_Id();
186 
198 kFx(kStatus) kProcess_EnableStandardHandles(kProcess process, kBool enabled);
199 
206 kFx(kBool) kProcess_StandardHandlesEnabled(kProcess process);
207 
219 kFx(kStatus) kProcess_EnableShell(kProcess process, kBool enabled);
220 
221 #endif
kProcess::kProcess_ExitCode
k64s kProcess_ExitCode(kProcess process)
Gets the exit code of a process.
kProcess::kProcess_Terminate
kStatus kProcess_Terminate(kProcess process)
Initiates process termination.
k64u
Represents a 64-bit unsigned integer.
kProcess::kProcess_Construct
kStatus kProcess_Construct(kProcess *process, const kChar *path, kAlloc allocator)
Constructs a kProcess object.
kSize
Represents an unsigned integer that can store a pointer address.
kAlloc
Abstract base class for memory allocator types.
kProcess::kProcess_EnableStandardHandles
kStatus kProcess_EnableStandardHandles(kProcess process, kBool enabled)
Enable read or write from/to the standard handles (stdin/stdout/stderr).
kInlineFx
#define kInlineFx(TYPE)
Inline method declaration helper.
Definition: kApiDef.h:29
kChar
Represents a single unit (byte) in a UTF-8 character.
kProcess::kProcess_StdOut
kStream kProcess_StdOut(kProcess process)
Returns the stdout of the process as kStream.
kProcess::kProcess_Id
k32s kProcess_Id()
Returns the process id of the current process.
kProcess::kProcess_StdIn
kStream kProcess_StdIn(kProcess process)
Returns the stdin of the process as kStream.
kProcess::kProcess_StandardHandlesEnabled
kBool kProcess_StandardHandlesEnabled(kProcess process)
Reports whether standard handles are currently enabled.
kProcess::kProcess_IsAlive
kBool kProcess_IsAlive(kProcess process)
Determines if the process is still alive.
kApiDef.h
Core Zen type declarations.
kStream
Represents an I/O stream.
k32s
Represents a 32-bit signed integer.
k64s
Represents a 64-bit signed integer.
kProcess::kProcess_AddArguments
kStatus kProcess_AddArguments(kProcess process, const kChar *arguments[], kSize argCount)
Adds an array of arguments.
kProcess
Represents a process.
kProcess::kProcess_StdErr
kStream kProcess_StdErr(kProcess process)
Returns the stderr of the process as kStream.
kProcess::kProcess_EnableShell
kStatus kProcess_EnableShell(kProcess process, kBool enabled)
Enable shell (.bat/.cmd) support.
kProcess::kProcess_Start
kStatus kProcess_Start(kProcess process)
Starts the new process.
kStatus
Represents an error code.
kProcess::kProcess_Wait
kStatus kProcess_Wait(kProcess process, k64u timeout)
Waits for child process completion.
Definition: kProcess.h:122
kProcess::kProcess_AddArgument
kStatus kProcess_AddArgument(kProcess process, const kChar *argument)
Adds an argument.
kProcess::kProcess_ClearArguments
kStatus kProcess_ClearArguments(kProcess process)
Deletes all arguments.
kBool
Represents a boolean value.