DosWaitChild: Difference between revisions
Appearance
Created page with "==DosWaitChild== ===Syntax=== rc = DosWaitChild( ''ulAction'', ''ulWait'', ''pReturnCodes'', ''ppidOut'', ''pidIn'' ); ===Parameters=== ; ULONG ''ulAction'' (input) : Specifi..." |
mNo edit summary |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
DosWaitChild waits for an asynchronous child process to end and gets its process identifier, termination code and result code. It is also possible to check if the child process has already ended and get information about already ended child processes. | |||
==Syntax== | |||
DosWaitChild( ''ulAction'', ''ulWait'', ''pReturnCodes'', ''ppidOut'', ''pidIn'' ) | |||
==Parameters== | |||
;ulAction (ULONG): Specifies which process the current thread is waiting for to end. Values are: | |||
::0 - DCWA_PROCESS - The process indicated by pidIn | |||
::1 - DCWA_PROCESSTREE - The process indicated by pidIn and all of its child processes | |||
; | ;ulWait (ULONG):Specifies whether to return if no child process ends. Values are: | ||
: Specifies which process the current thread is waiting for to end. Values are: | ::0 - DCWW_WAIT - Wait if no child process ends or until no child processes are outstanding. | ||
::1 - DCWW_NOWAIT Do not wait for child processes to end | |||
;pReturnCode (PRESULTCODES): Pointer to a [[RESULTCODES]] structure holding exit information from the ending process. If no processes furnish a result code, the system provides the value -1. | |||
;ppidOut (PPID): ointer to the process ID of the ending process. | |||
;pidIn (PID):Process ID of the child process (and all its descendants) whose termination is being waited for. If 0 then any child process that was executed with a return code, or until there are no more child processes of any type to wait for. | |||
; | |||
: Specifies whether to return if no child process ends. Values are: | |||
; | |||
: Pointer to a | |||
; | |||
: | |||
; | |||
: Process ID of the child process (and all its descendants) whose termination is being waited for. If 0 then any child process that was executed with a return code, or until there are no more child processes of any type to wait for. | |||
===Returns=== | ===Returns=== | ||
;APIRET rc | |||
0 NO_ERROR | |||
13 ERROR_INVALID_DATA | |||
128 ERROR_WAIT_NO_CHILDREN | |||
129 ERROR_CHILD_NOT_COMPLETE | |||
128 | 184 ERROR_NO_CHILD_PROCESS | ||
129 | 303 ERROR_INVALID_PROCID | ||
184 | |||
303 | |||
===Sample Code=== | ===Sample Code=== | ||
<code> | |||
#define INCL_DOSPROCESS | #define INCL_DOSPROCESS | ||
#include <os2.h> | #include <os2.h> | ||
Line 78: | Line 35: | ||
/* Start a child process with DosExecPgm */ | /* Start a child process with DosExecPgm */ | ||
if(rc=DosWaitChild(DCWA_PROCESS, | if(rc=DosWaitChild(DCWA_PROCESS, /* Wait for a child process */ | ||
DCWW_WAIT, /* Wait for a process to end */ | DCWW_WAIT, /* Wait for a process to end */ | ||
&rcResult, /* Result code */ | &rcResult, /* Result code */ | ||
&pidChild, /* The process ID of the child process */ | &pidChild, /* The process ID of the child process */ | ||
/* that ended */ | /* that ended */ | ||
0)) /* Wait | 0)) /* Wait for any child process to end */ | ||
{ | { | ||
/* An error | /* An error occurred */ | ||
if(rc == ERROR_NO_CHILD_PROCESS) | if(rc == ERROR_NO_CHILD_PROCESS) | ||
{ | { | ||
Line 93: | Line 50: | ||
{ | { | ||
/* Any other error */ | /* Any other error */ | ||
} | } | ||
} | } | ||
Line 100: | Line 56: | ||
/* Success */ | /* Success */ | ||
} | } | ||
</code> | |||
==See Also== | |||
*[[DosExecPgm]] | |||
[[ | *[[DosKillProcess]] | ||
[[Category: | [[Category:Dos]] |
Latest revision as of 11:48, 12 October 2018
DosWaitChild waits for an asynchronous child process to end and gets its process identifier, termination code and result code. It is also possible to check if the child process has already ended and get information about already ended child processes.
Syntax
DosWaitChild( ulAction, ulWait, pReturnCodes, ppidOut, pidIn )
Parameters
- ulAction (ULONG)
- Specifies which process the current thread is waiting for to end. Values are:
- 0 - DCWA_PROCESS - The process indicated by pidIn
- 1 - DCWA_PROCESSTREE - The process indicated by pidIn and all of its child processes
- ulWait (ULONG)
- Specifies whether to return if no child process ends. Values are:
- 0 - DCWW_WAIT - Wait if no child process ends or until no child processes are outstanding.
- 1 - DCWW_NOWAIT Do not wait for child processes to end
- pReturnCode (PRESULTCODES)
- Pointer to a RESULTCODES structure holding exit information from the ending process. If no processes furnish a result code, the system provides the value -1.
- ppidOut (PPID)
- ointer to the process ID of the ending process.
- pidIn (PID)
- Process ID of the child process (and all its descendants) whose termination is being waited for. If 0 then any child process that was executed with a return code, or until there are no more child processes of any type to wait for.
Returns
- APIRET rc
0 NO_ERROR 13 ERROR_INVALID_DATA 128 ERROR_WAIT_NO_CHILDREN 129 ERROR_CHILD_NOT_COMPLETE 184 ERROR_NO_CHILD_PROCESS 303 ERROR_INVALID_PROCID
Sample Code
#define INCL_DOSPROCESS
#include <os2.h>
#include <stdio.h>
APIRET rc; /* return code from tha API's */
RESULTCODES rcResult; /* Result code for the child process */
PID pidChild; /* The process ID of the child process */
/* Start a child process with DosExecPgm */
if(rc=DosWaitChild(DCWA_PROCESS, /* Wait for a child process */
DCWW_WAIT, /* Wait for a process to end */
&rcResult, /* Result code */
&pidChild, /* The process ID of the child process */
/* that ended */
0)) /* Wait for any child process to end */
{
/* An error occurred */
if(rc == ERROR_NO_CHILD_PROCESS)
{
printf("No child processes left!\n");
}
else
{
/* Any other error */
}
}
else
{
/* Success */
}