Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


IsHandleValid(in AtomicSafetyHandle)

Checks if an AtomicSafetyHandle is valid.
Read time 1 minuteLast updated 13 days ago

Definition

IsHandleValid(AtomicSafetyHandle)

public static bool IsHandleValid(in AtomicSafetyHandle handle)

Parameters

The AtomicSafetyHandle to check.

Returns

Type

Description

bool
true
if the AtomicSafetyHandle is valid,
false
otherwise.

Remarks

An
AtomicSafetyHandle
is invalid under the following conditions:
  • The version number it stores no longer matches the version number of the associated entry in the safety system.
  • AtomicSafetyHandle.Release is called on the
    AtomicSafetyHandle
    , or on another
    AtomicSafetyHandle
    that references the same memory region.
  • The secondary version number it stores no longer matches the secondary version number of the associated entry in the safety system. This situation happens when AtomicSafetyHandle.CheckWriteAndBumpSecondaryVersion or SetBumpSecondaryVersionOnSchedule are called on the
    AtomicSafetyHandle
    .
For more information about container version numbers, refer to Copying NativeContainer structures.