(v13) Language translation operations
This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core
The PFI language translation operations enable plugins to exploit the language translation features of the RIP.
Although the APIs are made available to the plugin when it initializes the PFI, the RIP will not have loaded the plugin's messages file at that point. This file is not loaded until sometime after
D_SECURITY
has been called.
Attempting to use plugin‐specific translations too early is liable to cause the text to remain un‐translated. You are advised to only use these APIs after the RIP has called a particular selector for the first time. That is:
- For output plugins, after
D_GET_FLAGS
(if the plugin supports it) orD_OPEN
is called for the first time. - For input plugins, after the first
D_IP_OBJECT_TICKLE
orD_IP_CHANNEL_CREATE
.
Note: PSDEV and Core module plugins are not expected to use these APIs.
Note: These functions are available in the RIP from plugin interface version 18.10. However, a few selected RIPs made these functions available whilst still reporting their plugin‐interface version as
18.8. Plugins attempting to use the new PFI functions in such RIPs must be prepared for the possibility of PFIInitialise
returning PFI_INIT_ERR_SOME_FUNCTIONS_UNKNOWN
. You must not assume that a plugin‐interface version of 18.8 implies their availability.