Intravision/reactos
1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2024-06-28 00:41:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

[NTOSKRNL] Update Doxygen descriptions for NtRaiseHardError, ExRaiseHardError, ExpRaiseHardError and NtSetDefaultHardErrorPort.

Browse source
This commit is contained in:
Hermès Bélusca-Maïto 2018-04-01 15:06:45 +02:00
parent f0729b30bb
commit 1fadfea053
No known key found for this signature in database
GPG key ID: 3B2539C65E7B93D0
1 changed files with 19 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
ntoskrnl/ex/harderr.c
View file

@ -85,30 +85,15 @@ ExpSystemErrorHandler(IN NTSTATUS ErrorStatus,
/*++ /*++
* @name ExpRaiseHardError * @name ExpRaiseHardError
* @implemented
* *
* For now it's a stub * See ExRaiseHardError and NtRaiseHardError, same parameters.
* *
* @param ErrorStatus * This function performs the central work for both ExRaiseHardError
* FILLME * and NtRaiseHardError. ExRaiseHardError is the service for kernel-mode
* * that copies the parameters to user-mode, and NtRaiseHardError is the
* @param NumberOfParameters * service for both kernel-mode and user-mode that performs parameters
* FILLME * validation and capture if necessary.
*
* @param UnicodeStringParameterMask
* FILLME
*
* @param Parameters
* FILLME
*
* @param ValidResponseOptions
* FILLME
*
* @param Response
* FILLME
*
* @return None
*
* @remarks None
* *
*--*/ *--*/
NTSTATUS NTSTATUS
@ -342,7 +327,7 @@ ExSystemExceptionFilter(VOID)
* @name ExRaiseHardError * @name ExRaiseHardError
* @implemented * @implemented
* *
* See NtRaiseHardError * See NtRaiseHardError and ExpRaiseHardError.
* *
* @param ErrorStatus * @param ErrorStatus
* Error Code * Error Code
@ -362,9 +347,7 @@ ExSystemExceptionFilter(VOID)
* @param Response * @param Response
* Pointer to HARDERROR_RESPONSE enumeration * Pointer to HARDERROR_RESPONSE enumeration
* *
* @return None * @return Status
*
* @remarks None
* *
*--*/ *--*/
NTSTATUS NTSTATUS
@ -489,9 +472,9 @@ ExRaiseHardError(IN NTSTATUS ErrorStatus,
* @name NtRaiseHardError * @name NtRaiseHardError
* @implemented * @implemented
* *
* This function sends HARDERROR_MSG LPC message to listener * This function sends HARDERROR_MSG LPC message to a hard-error listener,
* (typically CSRSS.EXE). See NtSetDefaultHardErrorPort for more information * typically CSRSS.EXE. See NtSetDefaultHardErrorPort for more information.
* See: http://undocumented.ntinternals.net/UserMode/Undocumented%20Functions/Error/NtRaiseHardError.html * See also: http://undocumented.ntinternals.net/UserMode/Undocumented%20Functions/Error/NtRaiseHardError.html
* *
* @param ErrorStatus * @param ErrorStatus
* Error Code * Error Code
@ -513,8 +496,8 @@ ExRaiseHardError(IN NTSTATUS ErrorStatus,
* *
* @return Status * @return Status
* *
* @remarks NtRaiseHardError is easy way to display message in GUI * @remarks NtRaiseHardError constitutes an easy way to display messages
* without loading Win32 API libraries * in GUI without loading any Win32 API libraries.
* *
*--*/ *--*/
NTSTATUS NTSTATUS
@ -696,11 +679,11 @@ NtRaiseHardError(IN NTSTATUS ErrorStatus,
* @name NtSetDefaultHardErrorPort * @name NtSetDefaultHardErrorPort
* @implemented * @implemented
* *
* NtSetDefaultHardErrorPort is typically called only once. After call, * NtSetDefaultHardErrorPort is typically called only once. After the call,
* kernel set BOOLEAN flag named ExReadyForErrors to TRUE, and all other * the kernel sets a BOOLEAN flag named ExReadyForErrors to TRUE, and all other
* tries to change default port are broken with STATUS_UNSUCCESSFUL error code * attempts to change the default port fail with STATUS_UNSUCCESSFUL error code.
* See: http://www.windowsitlibrary.com/Content/356/08/2.html * See: http://undocumented.ntinternals.net/UserMode/Undocumented%20Functions/Error/NtSetDefaultHardErrorPort.html
* http://undocumented.ntinternals.net/UserMode/Undocumented%20Functions/Error/NtSetDefaultHardErrorPort.html * https://web.archive.org/web/20070716133753/http://www.windowsitlibrary.com/Content/356/08/2.html
* *
* @param PortHandle * @param PortHandle
* Handle to named port object * Handle to named port object