AIX | HP-UX | Linux | OS/2 | OS/390 | OS/400 | PTX | SUN | Win NT |
X |
|
| X |
| X |
|
| X |
Purpose
Lists the contents of a Web registry.
Format
@DTWR_LISTREG(registry, registryTable)
Parameters
Table 202. DTWR_LISTREG Parameters
Data Type | Parameter | Use | Description |
---|---|---|---|
string | registry | IN | The name of the registry to list. |
table | registryTable | OUT | The name of the table variable in which the registry entries are placed. |
Return Codes
Table 203. DTWR_LISTREG 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. |
1004 | A parameter passed on a function call, required to be a Net.Data macro table variable, was of a different variable type. |
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. |
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. |
Usage Notes
DTWR_LISTREG returns information about the registry entries in an OUT table variable passed by the user. The table variable is defined in the user macro before being passed as a parameter to the FUNCTION block for the LISTREG registry operation.
If the user defined the table variable using the ALL option for the maximum number of rows for the table, this operation lists all available registry entries in the table, one for each table row. On the other hand if the user specified a value X for the maximum number of table rows, then if there are more then X entries in the specified registry only the first X entries are listed and an error code is sent back to indicate that only a partial listing could be done because not enough table rows were available to list additional entries. All registry entries are listed if the value X exceeds the number of available entries in the specified registry.
There are always 2 columns in the table. The Column headers for the table are set to REGISTRY_VARIABLE and REGISTRY_DATA.
Examples
Example 1:
%DEFINE RegistryTable = %TABLE(ALL) @DTWR_LISTREG("URLLIST", RegistryTable)