AIX | HP-UX | Linux | OS/2 | OS/390 | OS/400 | PTX | SUN | Win NT |
X |
|
| X |
| X |
|
| X |
Purpose
Retrieves a registry string value from a Web registry.
Format
@DTWR_RTVENTRY(registry, registryVariable, registryData, index)
@DTWR_RTVENTRY(registry, registryVariable, registryData)
@DTWR_rRTVENTRY(registry, registryVariable, index)
@DTWR_rRTVENTRY(registry, registryVariable)
Parameters
Table 208. DTWR_RTVENTRY Parameters
Data Type | Parameter | Use | Description |
---|---|---|---|
string | registry | IN | The name of the registry with entries to retrieve. |
string | registryVariable | IN | The value of the registryVariable string portion of the registry entry whose registryData string is retrieved. |
string | registryData | OUT | Returns the value of the registryData string portion of the registry entry that matches the registryVariable. |
string | index | IN | The value of the index portion of the registryVariable string in an indexed entry whose registryData string is returned. This is an optional parameter. If specified, the registryData string of the indexed entry is returned. |
Return Codes
Table 209. DTWR_RTVENTRY Return Codes
Return Code | Explanation |
---|---|
-1001 | The server could not process a Net.Data request to allocate memory. |
1001 | An input parameter contained a NULL value. |
1002 | An input parameter contained a string value which consisted of the null-terminating character. |
1003 | An incorrect number of parameters were passed on a function call. |
1005 | A parameter passed on a function call, required to be a string variable, was of a different variable type. |
1006 | A literal string was passed on a function call for a parameter which was required to be an output parameter. |
1007 | A parameter contains a value which is not valid. |
3004 | A Web registry built-in function could not remove or retrieve an entry from the specified registry because the specified entry does not exist. |
3005 | A Web registry built-in function could not use the specified registry because it cannot be found. |
3007 | A Web registry built-in function could not complete the specified operation because the requestor does not have the proper authority to the specified registry. |
Examples
Example 1:
%DEFINE RegistryData = "" @DTWR_RTVENTRY("Myregistry", "Jones", RegistryData)
Example 2:
@DTWR_RTVENTRY("URLLIST", "SMITH", RegistryData, "WORK_URL")
Example 3:
@DTWR_rRTVENTRY("Myregistry", "Jones")
Example 4:
@DTWR_rRTVENTRY("URLLIST", "SMITH", "WORK_URL")