UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FReturnedRefCountValue Struct Reference

#include <RefCounting.h>

Public Member Functions

 FReturnedRefCountValue (uint32 InRefCount)
 
 FReturnedRefCountValue (const FReturnedRefCountValue &Other)=default
 
 FReturnedRefCountValue (FReturnedRefCountValue &&Other)=default
 
FReturnedRefCountValueoperator= (const FReturnedRefCountValue &Other)=default
 
FReturnedRefCountValueoperator= (FReturnedRefCountValue &&Other)=default
 
 operator uint32 () const
 
void CheckAtLeast (uint32 N) const
 

Detailed Description

Simple wrapper class which holds a refcount; emits a deprecation warning when accessed.

It is unsafe to rely on the value of a refcount for any logic, and a non-deprecated getter function should never be added. In a multi-threaded context, the refcount could change after inspection. In a transactional context, the refcount may be higher than expected, as releases are deferred until completion of the transaction.

Constructor & Destructor Documentation

◆ FReturnedRefCountValue() [1/3]

FReturnedRefCountValue::FReturnedRefCountValue ( uint32  InRefCount)
inlineexplicit

◆ FReturnedRefCountValue() [2/3]

FReturnedRefCountValue::FReturnedRefCountValue ( const FReturnedRefCountValue Other)
default

◆ FReturnedRefCountValue() [3/3]

FReturnedRefCountValue::FReturnedRefCountValue ( FReturnedRefCountValue &&  Other)
default

Member Function Documentation

◆ CheckAtLeast()

void FReturnedRefCountValue::CheckAtLeast ( uint32  N) const
inline

◆ operator uint32()

FReturnedRefCountValue::operator uint32 ( ) const
inline

◆ operator=() [1/2]

FReturnedRefCountValue & FReturnedRefCountValue::operator= ( const FReturnedRefCountValue Other)
default

◆ operator=() [2/2]

FReturnedRefCountValue & FReturnedRefCountValue::operator= ( FReturnedRefCountValue &&  Other)
default

The documentation for this struct was generated from the following file: