This time, we will be making major changes. Please be aware that this will affect everyone currently using the API.
I am very sorry.
This fix is very important for future improvements.
We apologize for the inconvenience, but we hope to reduce the amount of work you have to do in the future.
This has been fixed for all APIs.
The change involves deleting all [Retval] APIs .
■Table of Contents
■What is Retval?
Retval is a function that allows you to check whether the Reaper API processing has passed correctly.
Until now, Retval was calculated using Boolean, and when there was a problem with the execution results, Retval was included in the output value to determine whether or not the operation had failed.
By branching out that decision as a separate function, we have been able to reduce the amount of writing required for each API, and by making it possible to use the beginning of the output value as is, we have been able to improve various areas, such as when applied to if statements, so we have made the decision to remove it.
■ Compatible version information
All plans are supported.
Retval removal support will be available from the following versions onwards.
BRONZE ver2.1.2
SILVER ver1.1.1
GOLD ver1.0.1
Example: REAPDOCK
We will explain what changes will occur when you use REAPDOCK's LUA.
Language Lua :AZSTOKE_HANDAUTOMER1
It's documented here.
The following API can obtain the number of selected media.
Previously, "retval" was used as the description for this, but this will no longer be necessary.
Therefore, the above REAPDOCK will be changed to the following:
retval , allCount = reaper.AZ_GetSelectedMediaTypeCount(0,"")
→
I will delete all these Retvals.
The permutation of the output values is changed.
By removing this, the first output value will no longer be retval.
This makes it easier to get the value you want.
■Script for error
Error codes are listed at the top of APIDOCK.
If you wish to check for errors in the future, please use this page.
■The future of APIDOCK and REAPDOCK
We will migrate each document to the latest version by the end of October 2024.
If you are unable to run the program even after updating to the latest version of Reapdock or other software you are using, you will need to delete this Retval, so please be sure to check this.
If you are experiencing any issues , please contact us and we will let you know how to fix the problem.
Please feel free to contact us.
Comments