UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IPC::FSynchronizedInterprocessMemory Class Reference

#include <IPC.h>

Public Member Functions

 ~FSynchronizedInterprocessMemory ()
 
bool Write (const FString &String, uint32 MaxMillisecondsToWait=0)
 
bool Read (FString &OutString, uint32 MaxMillisecondsToWait=0)
 

Static Public Member Functions

static FSynchronizedInterprocessMemoryCreate (const TCHAR *Name, SIZE_T Size)
 
static FSynchronizedInterprocessMemoryOpenExisting (const TCHAR *Name, SIZE_T Size)
 

Detailed Description

Example class for synchronized interprocess memory

Constructor & Destructor Documentation

◆ ~FSynchronizedInterprocessMemory()

IPC::FSynchronizedInterprocessMemory::~FSynchronizedInterprocessMemory ( )
inline

Destructor

Member Function Documentation

◆ Create()

static FSynchronizedInterprocessMemory * IPC::FSynchronizedInterprocessMemory::Create ( const TCHAR Name,
SIZE_T  Size 
)
inlinestatic

Creates a new synchronized interprocess memory object

◆ OpenExisting()

static FSynchronizedInterprocessMemory * IPC::FSynchronizedInterprocessMemory::OpenExisting ( const TCHAR Name,
SIZE_T  Size 
)
inlinestatic

Opens existing synchronized interprocess memory object

◆ Read()

bool IPC::FSynchronizedInterprocessMemory::Read ( FString &  OutString,
uint32  MaxMillisecondsToWait = 0 
)
inline

Reads a string from shared memory

Parameters
Stringstring to read into
MaxMillisecondsToWaitmax milliseconds to wait (if 0, wait forever)
Returns
true if read withing given time

◆ Write()

bool IPC::FSynchronizedInterprocessMemory::Write ( const FString &  String,
uint32  MaxMillisecondsToWait = 0 
)
inline

Writes string to shared memory

Parameters
Stringstring to write
MaxMillisecondsToWaitmax milliseconds to wait (if 0, wait forever)
Returns
true if was able to write

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