FReadFmt
Description
Read formatted data from a file stream. Delegates to the in-tree file formatted-read backend.
Parameters
| Name | Direction | Description |
|---|---|---|
stream |
in | Pointer to the File to read from. |
fmtstr |
in | Format string to be used for reading. This must exactly describe the expected input format in the stream. argument should be a modifiable l-value wrapped with &variable. |
Success
Attempts to match fmtstr with the stream of characters in stream and reads values into the provided arguments.
Failure
Failure occurs within the file formatted-read backend (logs error message and returns, may roll back read data, or abort in unexpected situations).
Usage example (Cross-references)
Usage examples (Cross-references)
- In
Io.h:727:
do { \
File UNPL(in) = FileStdin(); \
FReadFmt(&UNPL(in), __VA_ARGS__); \
} while (0)
Last updated on