TranslationLookupClose
The function TranslationLookupClose closes a lookup map that was previously loaded into memory by the function TranslationLookupLoad.
| Function | Group | Execution | Windows | Embedded | Thin Client | Mobile Access |
|---|---|---|---|---|---|---|
| TranslationLookupClose | Translation | Synchronous | Supported | Supported | Not supported | Not supported |
Syntax
TranslationLookupClose(numTranslationLookupID)
- numTranslationLookupID
- The ID number of the lookup map that you want to close, as it was returned by the function TranslationLookupLoad. Valid values range from 0 to 255.
Returned 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.
Examples
Close the lookup map specified by the ID number stored in the tag MyLookupID:
TranslationLookupClose(MyLookupID)