Epok Engine

EPOK RUNTIME

epok::PocketStationService::read_directory

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 16 directory frames (block 0) in one batch.

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

Declaration

Declaration
PocketError read_directory(uint8_t (*out)[128], unsigned port = 0)

Reads the 16 directory frames (block 0) in one batch.

ParameterTypeMeaning
outuint8_t (*)[128]Not 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:
// uint8_t (*)[128] out
// unsigned int port

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

auto result = object.read_directory(out, port);

Trade-offs and warnings

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

Declared in runtime/pocketstation.hpp:385

Related members