FPThreadEvent::Wait

Waits the specified amount of time for the event to be triggered.

Windows
MacOS
Linux

Override Hierarchy

FEvent::Wait()

FPThreadEvent::Wait()

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/HAL/PThreadEvent.h

Include

#include "HAL/PThreadEvent.h"

Source

/Engine/Source/Runtime/Core/Private/GenericPlatform/GenericPlatformProcess.cpp

Syntax

virtual bool Wait
(
    uint32 WaitTime,
    const bool bIgnoreThreadIdleStats
)

Remarks

Waits the specified amount of time for the event to be triggered.

A wait time of MAX_uint32 is treated as infinite wait.

Returns

true if the event was triggered, false if the wait timed out.

Parameters

Parameter

Description

WaitTime

The time to wait (in milliseconds).

bIgnoreThreadIdleStats

If true, ignores ThreadIdleStats
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss