Updated uc_close comment to clarify usage (#805)

This commit is contained in:
bulaza
2017-04-24 11:55:18 -04:00
committed by Nguyen Anh Quynh
parent 513075e061
commit f6908f03a9

View File

@ -344,11 +344,12 @@ UNICORN_EXPORT
uc_err uc_open(uc_arch arch, uc_mode mode, uc_engine **uc); uc_err uc_open(uc_arch arch, uc_mode mode, uc_engine **uc);
/* /*
Close UC instance: MUST do to release the handle when it is not used anymore. Close a Unicorn engine instance.
NOTE: this must be called only when there is no longer usage of Unicorn. NOTE: this must be called only when there is no longer any
The reason is the this API releases some cached memory, thus access to any usage of @uc. This API releases some of @uc's cached memory, thus
Unicorn API after uc_close() might crash your application. any use of the Unicorn API with @uc after it has been closed may
After this, @uc is invalid, and nolonger usable. crash your application. After this, @uc is invalid, and is no
longer usable.
@uc: pointer to a handle returned by uc_open() @uc: pointer to a handle returned by uc_open()