IBM Books

Reference

DTWR_LISTSUB


AIX HP-UX Linux OS/2 OS/390 OS/400 SCO SUN Win NT








X

Purpose

Lists immediate subkey entries in a Web registry.

Format

@DTWR_LISTSUB(registry, registryTable)

Parameters

Table 200. DTWR_LISTSUB 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 201. DTWR_LISTSUB 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 The number of parameters passed on a function call either exceeded the maximum number allowed, or was less than the minimum number required by the function.
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

  1. DTWR_LISTSUB returns information about the registry entries in an OUT table parameter passed by the user. The table variable is defined in the macro before being passed as a parameter to the LISTSUB registry operation.

    If the user has 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 are available to list additional entries. All registry entries are listed if the value X exceeds the number of available entries in the specified registry. The number of columns in the table is always one.

    The column header for the table is set to "REGISTRY_SUBKEY".

  2. This function is only valid on operating system that are compatible Windows 95 System Registries.

Examples

Example 1:

%DEFINE RegistryTable = %TABLE(ALL)
 
@DTWR_LISTSUB("URLLIST", RegistryTable)


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]