TranslationLookupClose
- Last UpdatedOct 29, 2026
- 1 minute read
TranslationLookupClose is a built-in function that closes a lookup map previously loaded into memory by the TranslationLookupLoad function.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
TranslationLookupClose |
Translation |
Synchronous |
No |
Supported |
Supported |
Not supported |
Not supported |
Supported (see Notes below) |
Syntax
TranslationLookupClose(numTranslationLookupID)
numTranslationLookupID
The ID number of the lookup map that you want to close, as it was returned by the TranslationLookupLoad function. Valid values range from 0 to 255.
Return value
This function returns one of the following possible values:
|
Value |
Description |
|---|---|
|
0 |
Lookup map successfully closed. |
|
-1 |
Function executed from the Viewer module, or other internal error. |
|
-2 |
Invalid parameter(s). |
|
-3 |
Other error. |
Notes
Closing a lookup map frees the system resources used by that map. You should always close a lookup map when you are done with it.
This function is supported on Mobile Access, but it must be called in a project screen as it is being viewed in the Mobile Access web interface. For more information, see TranslationLookupLoad.
Examples
Close the lookup map specified by the ID number stored in the tag MyLookupID:
TranslationLookupClose(MyLookupID)