mxeventum.h File Reference

#include "DbgMacros.h"
#include "MxEvent.h"

Include dependency graph for mxeventum.h:

Go to the source code of this file.

Classes
struct	MdEvent

Functions
	__drv_when (Timeout !=NULL, _Must_inspect_result_) __inline NTSTATUS MxEvent

Function Documentation

__drv_when()

__drv_when	(	Timeout !	= NULL,
		_Must_inspect_result_
	)

Definition at line 145 of file mxeventum.h.

{
    ASSERT_DBGFLAG_INITIALIZED;
 
    DWORD retVal;
 
    UNREFERENCED_PARAMETER(WaitReason);
    UNREFERENCED_PARAMETER(WaitMode);
 
    LONGLONG relativeTimeOut = 0;
    LONGLONG timeoutInMs = 0;
    DWORD dwTimeout = 0;
 
    if (NULL != Timeout)
    {
        //
        // Make sure that timeout is 0 or -ve (which implies relative timeout)
        //
        if (Timeout->QuadPart > 0)
        {
            Mx::MxAssertMsg(
                "Absolute wait not supported in user mode",
                FALSE
                );
 
            return STATUS_INVALID_PARAMETER;
        }
 
        //
        // Remove the -ve sign
        //
        if (Timeout->QuadPart < 0)
        {
            relativeTimeOut = -1 * Timeout->QuadPart;
        }
 
        //
        // Convert from 100ns units to milliseconds
        //
        timeoutInMs = (relativeTimeOut / (10 * 1000));
 
        if (timeoutInMs > ULONG_MAX)
        {
            Mx::MxAssertMsg("Timeout too large", FALSE);
 
            return STATUS_INVALID_PARAMETER;
        }
        else
        {
            dwTimeout = (DWORD) timeoutInMs;
        }
    }
 
    retVal = WaitForSingleObjectEx(
                    m_Event.Event,
                    (NULL == Timeout) ? INFINITE : dwTimeout,
                    Alertable
                    );
 
    switch(retVal)
    {
        case WAIT_ABANDONED:
            return STATUS_ABANDONED;
        case WAIT_OBJECT_0:
            return STATUS_SUCCESS;
        case WAIT_TIMEOUT:
            return STATUS_TIMEOUT;
        case WAIT_FAILED:
        {
            DWORD err = GetLastError();
            return WinErrorToNtStatus(err);
        }
        default:
        {
            //
            // We shoudn't get here
            //
            Mx::MxAssert(FALSE);
            return STATUS_UNSUCCESSFUL;
        }
    }
}