This method is used to get the metadata for one configuration from a number of configurations.

Signature

GetConfigurationById ([in]ConfigurationIdDataTypeinternalId[in]Int32timeout[out]HandleconfigurationHandle[out]ConfigurationDataTypeconfiguration[out]Int32error);

Table 14 – GetConfigurationById Method Arguments

Argument

Description

internalId

Identification of the configuration used by the vision system. This argument must not be empty.

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.

configurationHandle

The client can use the handle returned by the server to call the ReleaseConfigurationHandle method to indicate to the server that it has finished processing the configuration data, allowing the server to optimize its resource management.

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

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

configuration

Requested configuration.

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 15 – GetConfigurationById Method AddressSpace Definition

Attribute

Value

BrowseName

GetConfigurationById

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasProperty

Variable

InputArguments

Argument[]

PropertyType

Mandatory

HasProperty

Variable

OutputArguments

Argument[]

PropertyType

Mandatory