Epok Engine

PSYQO SDK

psyqo::MemoryCardFileSystem::readFile

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 the payload of a file.

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

Declaration

Declaration
void readFile(Port port, const char *name, void *buffer, uint32_t maxLen, uint32_t *outLen, eastl::function<void(Error)> &&callback)

Reads the payload of a file.

ParameterTypeMeaning
portPortNot documented; consult the linked header.
nameconst char *Not documented; consult the linked header.
buffervoid *Receives up to `maxLen` payload bytes.
maxLenuint32_tNot documented; consult the linked header.
outLenuint32_t *Receives the number of payload bytes available (capped at `maxLen`).
callbackeastl::function<void (Error)> &&Not documented; consult the linked header.

Returns: Nothing (void).

Example sketch

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

// Assume these named values have been initialized with valid data:
// Port port
// const char * name
// void * buffer
// uint32_t maxLen
// uint32_t * outLen
// eastl::function<void (Error)> && callback

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

object.readFile(port, name, buffer, maxLen, outLen, callback);

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:176

Related members