View source for WinTerminateApp

== WinTerminateApp ==
; WinTerminateApp(appHndl) : Terminates a program started with [[OS2_API:WinStartApp|WinStartApp]].

=== Parameters ===
; appHndl - [[OS2_API:DataType:HAPP|HAPP]] - input : The application handle as returned by [[OS2_API:WinStartApp|WinStartApp]].

=== Constants ===

=== Returns ===
Returns [[OS2_API:DataType:BOOL|BOOL]]:
* [[OS2_API:Constant:TRUE|TRUE]]
* [[OS2_API:Constant:FALSE|FALSE]]

Possible error codes from [[OS2_API:WinGetLastError|WinGetLastError]]:
* [[OS2_API:PMI:error#PMERR_INVALID_HAPP|PMERR_INVALID_HAPP]]
* [[OS2_API:PMI:error#PMERR_CANNOT_STOP|PMERR_CANNOT_STOP]]

=== Module ===

=== Define (C/C++) ===
INCL_WINWINDOWMGR or INCL_WIN or INCL_PM

=== Export name/Ordinal ===

=== Calling conversion ===
[[Cdecl32]]

=== Example Code ===
 [[OS2 API:DataType:HAPP|HAPP]]    appHndl;
 [[OS2_API:DataType:BOOL|BOOL]]    rc;
 ...
 rc = WinTerminateApp(appHndl);
 ...

=== Related Functions ===
[[OS2 API:WinStartApp|WinStartApp]]

=== Notes ===
This function works only if [[OS2_API:Constant:SAF#SAF_STARTCHILDAPP|SAF_STARTCHILDAPP]] is specified at program start.  The notify window handle specified in [[OS2_API:WinStartApp|WinStartApp]] will receive the [[OS2_API:Constant:WM#WM_APPTERMINATENOTIFY|WM_APPTERMINATENOTIFY]] message.
This function must be called from the same process that called [[OS2_API:WinStartApp|WinStartApp]].
This function requires the existence of a message queue on the calling thread.

=== OS Version Introduced ===