Written January 2024
xcall ATEREG, opcode, status, valuename, valuedata
xcall ATEREG, opcode, status {, "", config}
ATEREG.SBX applies only to ATE connections, allowing an application to query and/or update the ATE configuration for the current session, provided the client has the necessary privileges to access its Windows Registry. ATE configuration details are stored in the Registry on the ATE client.
Parameters
opcode (Num) [in]
Operation to perform:
Opcode |
Syntax |
Function |
|---|---|---|
0 |
First |
Get Value. |
1 |
First |
Update Value. |
2 |
Second |
Get Scope (All vs Current User). |
3 |
Second |
Conditional Copy Scope; from All to Current User, only if Current User version doesn't exist. |
4 |
Second |
Unconditional Copy Scope; from All to Current User, replacing an existing Current User version. |
5 |
First |
Change a single-value entry in the ATE client miame.ini. |
status (signed Num) [out]
Return status:
Status |
Meaning |
|---|---|
0+ |
Ok. |
-1 |
ATE or GUI environment required. |
-2 |
Host file doesn't exist. |
-3 |
File transferred but failed to verify afterwards. |
-4 |
FTP transfer failure. |
-95 |
Malformed response from ATE [101]. |
-96 |
Valuename not defined for opcode 0 [101]). |
-97 |
Unsupported opcode. |
-98 |
Server A-Shell version not high enough for binary transfer. |
-99 |
ATE version not high enough. |
<-100 |
ASB error offset by 100. |
<-1000 |
Windows errors related to registry. |
For opcode 0 and 1, status >= 0 indicates success, else failure.
For opcode 2, status 1 indicates the configuration scope is current user only; 2 indicates all users.
For opcode 3, status 1 indicates that the current user configuration already exists (copy skipped)
For opcode 3 and 4, status >1 indicates success (number of items in the configuration copies).
For opcode 5, status -1 indicates a value that cannot be changed this way (e.g. DEVICE); 0 indicates that valuename was not previously set, 1 indicates it was previously set (now updated).
valuename (String) [in]
Name of value to query or update, e.g. "CfgPassword". Use the ATE Configuration dialog Export button to export a configuration to a text file in order to see the available value names.
valuedata (String or Num) [in/out]
Value retrieved or to be updated.
config (String) [in]
Configuration name
Comments
The subroutine needs to run on the client side in order to be able to easily access the client Registry and/or miame.ini file, but is typically called from the application running on the server. To bridge that gap, the routine automatically syncs itself from the server to the client; the server then remotely calls it on the client, which relays the result back to the server.
The source code for this routine is available here: ATEREG.BP in SOSLIB:[907,33].
