DD_NAME
Retrieve a list of definition names
WTSupported in traditional Synergy on Windows
|
WNSupported in Synergy .NET on Windows
|
USupported on UNIX
|
VSupported on OpenVMS
|
xcall DD_NAME(dcs, DDN_COUNT, c_id, count)
or
xcall DD_NAME(dcs, DDN_LIST, l_id, names_req, array, [start][, #names])
Arguments
dcs
The repository control structure.
DDN_COUNT
Returns the count for a given definition type.
c_id
One of the following functions:
Returns the count of structure definitions.
Returns the count of file definitions.
Returns the count of template definitions.
Returns the count of enumeration definitions.
Returns the count of global format definitions.
Returns the count of predefined date formats.
Returns the count of predefined time formats.
count
Returned with the item count. (d4)
DDN_LIST
Returns a list of definition names.
l_id
One of the following functions:
Returns structure definition names.
Returns file definition names.
Returns template definition names.
Returns enumeration definition names.
Returns global format definition names.
Returns predefined date format definition names.
Returns predefined time format definition names.
names_req
The number of names requested. (d4)
array
Returned with the array of names. ((*)a30)
start
(optional) Contains the name at which to start. (a30)
#names
(optional) Returned with the number of names. (d4)
Discussion
The DD_NAME subroutine enables you to find out how many definitions of a given definition type exist, and then ask for a list of their names. There are two ways to call DD_NAME:
- DDN_COUNT enables you to retrieve the count for a definition type.
- DDN_LIST enables you to retrieve a list of definition names.
DDN_COUNT
If you pass DDN_COUNT, the DD_NAME subroutine returns the number of definitions that exist for the specified type.
DDN_LIST
If you pass DDN_LIST, DD_NAME returns an array of definition names for the requested type. You can retrieve as many names as you want, and you can specify the name at which to start. These names are returned in alphabetical order, starting with either the first name found or the specified name. DD_NAME returns as many names as are found or as are requested, whichever is smaller. The actual number of names in the array can be returned in #names.
You must make sure that the buffer passed is large enough to hold the number of names that you are requesting.