TagsDBGetLoadStatus
- Last UpdatedOct 29, 2026
- 2 minute read
TagsDBGetLoadStatus is a built-in function that checks whether a specified tag has been loaded into memory on a project thin client.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
TagsDBGetLoadStatus |
Tags Database |
Synchronous |
Yes |
Not supported |
Not supported |
Not supported |
Supported |
Not supported |
Syntax
TagsDBGetLoadStatus(strFullTagName)
TagsDBGetLoadStatus ( strFullTagName )
strFullTagName
The name of the project tag to be checked. If it is an array and/or class, you must also specify the array position and/or class member, because only one position and/or member can be checked for each function call.
Note: If this parameter is enclosed in quotes, the string literal will be used. Otherwise, the value of the tag/expression will be used.
Returned value
This function will return one of the following possible values:
|
Value |
Description |
|---|---|
|
2 |
Loaded. |
|
1 |
Load pending. |
|
0 |
Not loaded and no load pending. |
|
-1 |
This function can be called only on Thin Clients. |
|
-2 |
Invalid tag name; the specified project tag does not exist in the tags database. |
|
-3 |
Local tag specified. Only tags with Server scope can be specified for this function. |
Notes
This function is typically called after the TagsDBPreload and TagsDBPreloadWait functions, to check whether a project tag selected for preloading has actually been loaded.
Examples
The following example shows how the TagsDBPreload, TagsDBPreloadWait, TagsDBGetPreloadCount, and TagsDBGetLoadStatus functions can all be used in the Screen_OnOpen sub-routine of the Screen Script:
Sub Screen_OnOpen()
Dim counter, preloadCount, preloadDone, loadStatus
// Select tags for preloading.
preloadCount = $TagsDBPreload("MyTagA")
preloadCount = $TagsDBPreload("MyTagB")
preloadCount = $TagsDBPreload("MyTagC")
preloadCount = $TagsDBPreload("MyArray[1]")
preloadCount = $TagsDBPreload("MyArray[2]")
preloadCount = $TagsDBPreload("MyArray[3]")
// Wait up to five seconds to load tags.
counter = 0
preloadDone = 0
Do
preloadDone = $TagsDBPreloadWait(1000)
preloadCount = $TagsDBPreloadCount()
counter = counter + 1
Loop Until (preloadDone <> 0) Or (counter = 5)
// Save preload count message to string tag, for later use.
$PreloadCountMsg = preloadCount & " tag(s) waiting to be loaded."
// Save load status message to string tag, for later use.
loadStatus = $TagsDBGetLoadStatus("MyTagA")
If (loadStatus = 2) Then
$LoadStatusMsg = "MyTagA is loaded."
ElseIf (loadStatus = 1) Then
$LoadStatusMsg = "MyTagA is waiting to be loaded."
Else
$LoadStatusMsg = "Error while loading MyTagA."
End If
End Sub