This method is used to get a list of all configurations. It concerns itself only with the metadata of the configuration, the actual content is transferred by a ConfigurationTransferType object.

Signature

GetConfigurationList ([in]UInt32maxResults[in]UInt32startIndex[in]Int32timeout[out]BooleanisComplete[out]UInt32resultCount[out]HandleconfigurationHandle[out]ConfigurationDataType[]configurationList[out]Int32error);

Table 16 – GetConfigurationList Method Arguments

Argument

Description

maxResults

Maximum number of configurations to return in one call; by passing 0, the client indicates that it does not put a limit on the number of configurations.

startIndex

Shall be 0 on the first call, multiples of maxResults on subsequent calls to retrieve portions of the entire list, if necessary.

timeout

With this argument the client can give a hint to the server how long it will need access to the configuration data.

A value > 0 indicates an estimated maximum time for processing the data in milliseconds.

A value = 0 indicates that the client will not need anything besides the data returned by the method call.

A value < 0 indicates that the client cannot give an estimate.

The client cannot rely on the data being available during the indicated time period. The argument is merely a hint allowing the server to optimize its resource management.

isComplete

Indicates whether there are more configurations in the entire list than retrieved according to startIndex and resultCount.

resultCount

Gives the number of valid results in configurationList.

configurationHandle

The server shall return to each client requesting configuration data a system-wide unique handle identifying the configuration set / client combination. The handle spans continuation calls, so on every call by the same client where startIndex is not 0, the same handle shall be returned.

This handle canbe used by the client in a call to the ReleaseConfigurationHandle method, thereby indicating to the server that it has finished processing the configuration set, allowing the server to optimize its resource management.

The client cannot rely on the data being available until the ReleaseConfigurationHandle method is called.

If the server does no support ReleaseConfigurationHandle, this value shall be 0.

configurationList

List of configurations.

error

0 – OK

Values > 0 are reserved for errors defined by this and future standards.

Values < 0 shall be used for application-specific errors.

Table 17 – GetConfigurationList Method AddressSpace Definition

Attribute

Value

BrowseName

GetConfigurationList

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasProperty

Variable

InputArguments

Argument[]

PropertyType

Mandatory

HasProperty

Variable

OutputArguments

Argument[]

PropertyType

Mandatory

The following cases must be considered with the respect to the number of available configurations: