Epok Engine

EPOK RUNTIME

epok::PocketStationService::read_memory

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

Kernel memory access (RAM, I/O, flash), up to 128 bytes.

Belongs to
epok::PocketStationService
Header
pocketstation.hpp
Overloads
1

Declaration

Declaration
PocketError read_memory(uint32_t address, void* out, uint8_t size, unsigned port = 0)

Kernel memory access (RAM, I/O, flash), up to 128 bytes.

ParameterTypeMeaning
addressuint32_tNot documented; consult the linked header.
outvoid *Not documented; consult the linked header.
sizeuint8_tNot documented; consult the linked header.
portunsigned intNot documented; consult the linked header.

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

Example sketch

C++ example
#include "pocketstation.hpp"

// Assume these named values have been initialized with valid data:
// uint32_t address
// void * out
// uint8_t size
// unsigned int port

epok::PocketStationService& object = /* obtain a valid instance */;

auto result = object.read_memory(address, out, size, port);

Trade-offs and warnings

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

Declared in runtime/pocketstation.hpp:358

Related members