diff --git a/GB_load_isx.md b/GB_load_isx.md index 08162c2..38b855c 100644 --- a/GB_load_isx.md +++ b/GB_load_isx.md @@ -6,8 +6,19 @@ In `gb.h` ## Description -TBD +Loads ROM data and symbols from an ISX file into an emulator instance. Returns 0 on success, a positive `errno` value on a POSIX failure, and `-1` on other failures. + +In case of a failure, an error message will also be output to the [[log|GB_set_log_callback]]. Warning messages may be output to the [[log|GB_set_log_callback]] upon success. ## Thread Safety `GB_load_isx` must not be called if the instance is being run in another thread, but may be called from the current one (via a callback). + +## Notes + +`GB_load_isx` will not remove existing symbols from the emulator instance. You may want to call [[GB_debugger_clear_symbols]] before calling this function if the emulator instance already has symbols for a previously loaded ROM. + +## See Also + +* [[GB_load_rom]] +* [[GB_load_gbs]]