Epok Engine

PSYQO SDK

psyqo::MemoryCard::readSector

Method · 2 overloads

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 sector as part of asynchronous Memory Card access and files.

Belongs to
psyqo::MemoryCard
Header
memory-card.hh
Overloads
2

Declaration 1 of 2

Declaration
ReadSectorAwaiter readSector(Port port, uint16_t sector, void *buffer)

Reads sector as part of asynchronous Memory Card access and files.

ParameterTypeMeaning
portPortNot documented; consult the linked header.
sectoruint16_tNot documented; consult the linked header.
buffervoid *Not documented; consult the linked header.

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

Example sketch

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

// Assume these named values have been initialized with valid data:
// Port port
// uint16_t sector
// void * buffer

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

auto result = object.readSector(port, sector, buffer);

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.hh:209

Declaration 2 of 2

Declaration
void readSector(Port port, uint16_t sector, void *buffer, eastl::function<void(Error)> &&callback)

--- Callback variants -------------------------------------------------

ParameterTypeMeaning
portPortNot documented; consult the linked header.
sectoruint16_tNot documented; consult the linked header.
buffervoid *Not documented; consult the linked header.
callbackeastl::function<void (Error)> &&Not documented; consult the linked header.

Returns: Nothing (void).

Example sketch

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

// Assume these named values have been initialized with valid data:
// Port port
// uint16_t sector
// void * buffer
// eastl::function<void (Error)> && callback

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

object.readSector(port, sector, buffer, 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.hh:159

Related members