Epok Engine

PSYQO SDK

psyqo::MemoryCardFileSystem::readFileBlocking

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

Reads file blocking as part of asynchronous Memory Card access and files.

Belongs to
psyqo::MemoryCardFileSystem
Header
memory-card-filesystem.hh
Overloads
1

Declaration

Declaration
Error readFileBlocking(GPU &gpu, Port port, const char *name, void *buffer, uint32_t maxLen, uint32_t *outLen)

Reads file blocking as part of asynchronous Memory Card access and files.

ParameterTypeMeaning
gpuGPU &Not documented; consult the linked header.
portPortNot documented; consult the linked header.
nameconst char *Not documented; consult the linked header.
buffervoid *Not documented; consult the linked header.
maxLenuint32_tNot documented; consult the linked header.
outLenuint32_t *Not documented; consult the linked header.

Returns: Error. Consult the linked header for its meaning.

Example sketch

C++ example
#include "psyqo/memory-card-filesystem.hh"

// Assume these named values have been initialized with valid data:
// GPU & gpu
// Port port
// const char * name
// void * buffer
// uint32_t maxLen
// uint32_t * outLen

psyqo::MemoryCardFileSystem& object = /* obtain a valid instance */;

auto result = object.readFileBlocking(gpu, port, name, buffer, maxLen, outLen);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/memory-card-filesystem.hh:231

Related members